bito-code-review[bot] commented on code in PR #24444: URL: https://github.com/apache/superset/pull/24444#discussion_r2921125040
########## superset-frontend/packages/superset-ui-core/src/number-format/factories/createLengthFormatter.ts: ########## @@ -0,0 +1,47 @@ +/* + * 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 default function createLengthFormatter(config: { + description?: string; + id?: string; + label?: string; + convertType?: string; +}) { + const { description, id, label, convertType } = config; + + return new NumberFormatter({ + description, + formatFunc: value => { + if (convertType === 'm => km') { + return `${(value / 1000).toFixed(2).toString()}KM`; + } + if (convertType === 'cm => km') { + return `${(value / 100_000).toFixed(2).toString()}KM`; + } + if (convertType === 'cm => m') { + return `${(value / 100).toFixed(2).toString()}M`; + } + return value.toString(); + }, + id: id ?? 'length_format', + label: label ?? `Length formatter`, + }); +} Review Comment: <div> <div id="suggestion"> <div id="issue"><b>Type hint and unit fixes needed</b></div> <div id="fix"> The function lacks an explicit return type annotation, which violates the requirement for all functions to have type hints. Additionally, .toString() is redundant on toFixed results since they are already strings, and unit abbreviations should follow SI standards with lowercase 'km' and 'm' instead of 'KM' and 'M'. </div> <details> <summary> <b>Code suggestion</b> </summary> <blockquote>Check the AI-generated fix before applying</blockquote> <div id="code"> ``` - export default function createLengthFormatter(config: { - description?: string; - id?: string; - label?: string; - convertType?: string; - }) { - const { description, id, label, convertType } = config; - - return new NumberFormatter({ - description, - formatFunc: value => { - if (convertType === 'm => km') { - return `${(value / 1000).toFixed(2).toString()}KM`; - } - if (convertType === 'cm => km') { - return `${(value / 100_000).toFixed(2).toString()}KM`; - } - if (convertType === 'cm => m') { - return `${(value / 100).toFixed(2).toString()}M`; - } - return value.toString(); - }, - id: id ?? 'length_format', - label: label ?? `Length formatter`, - }); - } + export default function createLengthFormatter(config: { + description?: string; + id?: string; + label?: string; + convertType?: string; + }): NumberFormatter { + const { description, id, label, convertType } = config; + + return new NumberFormatter({ + description, + formatFunc: value => { + 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`, - }); + }, + id: id ?? 'length_format', + label: label ?? `Length formatter`, + }); + } ``` </div> </details> </div> <small><i>Code Review Run #98ad68</i></small> </div> --- Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>) - [ ] Yes, avoid them -- 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]
