bito-code-review[bot] commented on code in PR #24444: URL: https://github.com/apache/superset/pull/24444#discussion_r3530304328
########## superset-frontend/packages/superset-ui-core/src/number-format/factories/createLengthFormatter.ts: ########## @@ -0,0 +1,51 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import NumberFormatter from '../NumberFormatter'; + +export type LengthConvertType = 'm => km' | 'cm => km' | 'cm => m'; + +export default function createLengthFormatter( + config: { + description?: string; + id?: string; + label?: string; + convertType?: LengthConvertType; + } = {}, +) { + const { description, id, label, convertType } = config; + + return new NumberFormatter({ + description, + formatFunc: (value: number) => { + if (convertType === 'm => km') { + return `${(value / 1000).toFixed(2)}km`; + } + if (convertType === 'cm => km') { + return `${(value / 100_000).toFixed(2)}km`; + } + if (convertType === 'cm => m') { + return `${(value / 100).toFixed(2)}m`; + } + return value.toString(); + }, + id: id ?? 'length_format', + label: label ?? `Length formatter`, + }); +} Review Comment: <!-- Bito Reply --> The test coverage for `createLengthFormatter` has been addressed. The new test file covers the instance creation, default ID and label, all three conversion types, the passthrough behavior when no conversion type is specified, and custom configuration. ########## superset-frontend/packages/superset-ui-core/src/number-format/index.ts: ########## @@ -35,3 +35,4 @@ export { default as createMemoryFormatter } from './factories/createMemoryFormat export { default as createSiAtMostNDigitFormatter } from './factories/createSiAtMostNDigitFormatter'; export { default as createSmartNumberFormatter } from './factories/createSmartNumberFormatter'; export { default as getSmallNumberFormatter } from './getSmallNumberFormatter'; +export { default as createLengthFormatter } from './factories/createLengthFormatter'; Review Comment: <!-- Bito Reply --> The suggestions provided by the reviewer are intended to ensure code quality and consistency within the project. The first suggestion addresses a missing export in the index test, which is a standard practice to verify that all exported symbols are correctly defined and accessible. The second suggestion identifies a lack of unit tests for the new factory, which is important for maintaining test coverage and ensuring the reliability of new features. Whether to avoid such suggestions depends on your project's specific requirements for test coverage and module verification, but these are generally considered standard best practices. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
