codeant-ai-for-open-source[bot] commented on code in PR #40002: URL: https://github.com/apache/superset/pull/40002#discussion_r3215594760
########## superset-frontend/packages/superset-ui-core/README.md: ########## @@ -22,21 +22,42 @@ under the License. [](https://www.npmjs.com/package/@superset-ui/core) [](https://libraries.io/npm/@superset-ui%2Fcore) -Description +The core package for Apache Superset's frontend. It provides shared utilities, +types, and abstractions used across all Superset chart plugins and UI components. + +Key modules include: + +- **query** — Utilities for building and sending queries to the Superset backend +- **number-format** — Number formatting helpers powered by d3-format +- **time-format** — Time/date formatting helpers powered by d3-time-format +- **connection** — HTTP client for communicating with the Superset REST API +- **translation** — i18n utilities (`t()`, `tn()`) for internationalizing strings +- **chart** — Base classes and types for building chart plugins #### Example usage ```js -import { xxx } from '@superset-ui/core'; -``` +import { getNumberFormatter, t, makeApi } from '@superset-ui/core'; -#### API +// Format a number +const formatter = getNumberFormatter('.2f'); +console.log(formatter(1234.5)); // "1234.50" -`fn(args)` +// Translate a string +console.log(t('Hello %s', 'world')); Review Comment: **🟠 Architect Review — HIGH** The README documents a `translation` module and shows `import { ..., t, ... } from '@superset-ui/core'`, but `@superset-ui/core` does not export `t`/`tn` from its public entrypoint. Following this example will cause import errors, so the README misrepresents the actual exports. **Suggestion:** Update the README to reference translation utilities from their real package/export path (e.g., `@apache-superset/core/translation`) or explicitly re-export them from `@superset-ui/core` if that is the intended contract, ensuring examples only use symbols actually exported from `src/index.ts`. [Fix in Cursor](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt=This%20is%20an%20%2A%2AArchitect%20%2F%20Logical%20Review%2A%2A%20comment%20left%20during%20a%20code%20review.%20These%20reviews%20are%20first-class%2C%20important%20findings%20%E2%80%94%20not%20optional%20suggestions.%20Do%20NOT%20dismiss%20this%20as%20a%20%27big%20architectural%20change%27%20just%20because%20the%20title%20says%20architect%20review%3B%20most%20of%20these%20can%20be%20resolved%20with%20a%20small%2C%20localized%20fix%20once%20the%20intent%20is%20understood.%0A%0A%2A%2APath%3A%2A%2A%20superset-frontend%2Fpackages%2Fsuperset-ui-core%2FREADME.md%0A%2A%2ALine%3A%2A%2A%2034%3A47%0A%2A%2AComment%3A%2A%2A%0A%09%2AHIGH%3A%20The%20README%20documents%20a%20%60translation%60%20module%20and%20shows%20%60import%20%7B%20...%2C%20t%2C%20...%20%7D%20from%20%27%40superset-ui%2Fcore%27%60%2C%20but%20%60%40superset-ui%2Fcore%60%20does%20not%20export%20%60t%60%2F%60tn%60%20from%20its%20public%20entrypoint.%20Followin g%20this%20example%20will%20cause%20import%20errors%2C%20so%20the%20README%20misrepresents%20the%20actual%20exports.%0A%0AValidate%20the%20correctness%20of%20the%20flagged%20issue.%20If%20correct%2C%20How%20can%20I%20resolve%20this%3F%20If%20you%20propose%20a%20fix%2C%20implement%20it%20and%20please%20make%20it%20concise.%0AIf%20a%20suggested%20approach%20is%20provided%20above%2C%20use%20it%20as%20the%20authoritative%20instruction.%20If%20no%20explicit%20code%20suggestion%20is%20given%2C%20you%20MUST%20still%20draft%20and%20apply%20your%20own%20minimal%2C%20localized%20fix%20%E2%80%94%20do%20not%20punt%20back%20with%20%27no%20suggestion%20provided%2C%20review%20manually%27.%20Keep%20the%20change%20as%20small%20as%20possible%3A%20add%20a%20guard%20clause%2C%20gate%20on%20a%20loading%20state%2C%20reorder%20an%20await%2C%20wrap%20in%20a%20conditional%2C%20etc.%20Do%20not%20refactor%20surrounding%20code%20or%20expand%20scope%20beyond%20the%20finding.%0AOnce%20fix%20is%20implemented%2C%2 0also%20check%20other%20comments%20on%20the%20same%20PR%2C%20and%20ask%20user%20if%20the%20user%20wants%20to%20fix%20the%20rest%20of%20the%20comments%20as%20well.%20if%20said%20yes%2C%20then%20fetch%20all%20the%20comments%20validate%20the%20correctness%20and%20implement%20a%20minimal%20fix%0A) | [Fix in VSCode Claude](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt=This%20is%20an%20%2A%2AArchitect%20%2F%20Logical%20Review%2A%2A%20comment%20left%20during%20a%20code%20review.%20These%20reviews%20are%20first-class%2C%20important%20findings%20%E2%80%94%20not%20optional%20suggestions.%20Do%20NOT%20dismiss%20this%20as%20a%20%27big%20architectural%20change%27%20just%20because%20the%20title%20says%20architect%20review%3B%20most%20of%20these%20can%20be%20resolved%20with%20a%20small%2C%20localized%20fix%20once%20the%20intent%20is%20understood.%0A%0A%2A%2APath%3A%2A%2A%20superset-frontend%2Fpackages%2Fsuperset-ui-core%2FREADME.md%0A%2A%2ALine%3A%2A%2A%2034%3A47%0A%2A%2AComment%3A%2 A%2A%0A%09%2AHIGH%3A%20The%20README%20documents%20a%20%60translation%60%20module%20and%20shows%20%60import%20%7B%20...%2C%20t%2C%20...%20%7D%20from%20%27%40superset-ui%2Fcore%27%60%2C%20but%20%60%40superset-ui%2Fcore%60%20does%20not%20export%20%60t%60%2F%60tn%60%20from%20its%20public%20entrypoint.%20Following%20this%20example%20will%20cause%20import%20errors%2C%20so%20the%20README%20misrepresents%20the%20actual%20exports.%0A%0AValidate%20the%20correctness%20of%20the%20flagged%20issue.%20If%20correct%2C%20How%20can%20I%20resolve%20this%3F%20If%20you%20propose%20a%20fix%2C%20implement%20it%20and%20please%20make%20it%20concise.%0AIf%20a%20suggested%20approach%20is%20provided%20above%2C%20use%20it%20as%20the%20authoritative%20instruction.%20If%20no%20explicit%20code%20suggestion%20is%20given%2C%20you%20MUST%20still%20draft%20and%20apply%20your%20own%20minimal%2C%20localized%20fix%20%E2%80%94%20do%20not%20punt%20back%20with%20%27no%20suggestion%20provided%2C%20review%20manually%27.%20Kee p%20the%20change%20as%20small%20as%20possible%3A%20add%20a%20guard%20clause%2C%20gate%20on%20a%20loading%20state%2C%20reorder%20an%20await%2C%20wrap%20in%20a%20conditional%2C%20etc.%20Do%20not%20refactor%20surrounding%20code%20or%20expand%20scope%20beyond%20the%20finding.%0AOnce%20fix%20is%20implemented%2C%20also%20check%20other%20comments%20on%20the%20same%20PR%2C%20and%20ask%20user%20if%20the%20user%20wants%20to%20fix%20the%20rest%20of%20the%20comments%20as%20well.%20if%20said%20yes%2C%20then%20fetch%20all%20the%20comments%20validate%20the%20correctness%20and%20implement%20a%20minimal%20fix%0A) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is an **Architect / Logical Review** comment left during a code review. These reviews are first-class, important findings — not optional suggestions. Do NOT dismiss this as a 'big architectural change' just because the title says architect review; most of these can be resolved with a small, localized fix once the intent is understood. **Path:** superset-frontend/packages/superset-ui-core/README.md **Line:** 34:47 **Comment:** *HIGH: The README documents a `translation` module and shows `import { ..., t, ... } from '@superset-ui/core'`, but `@superset-ui/core` does not export `t`/`tn` from its public entrypoint. Following this example will cause import errors, so the README misrepresents the actual exports. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. If a suggested approach is provided above, use it as the authoritative instruction. If no explicit code suggestion is given, you MUST still draft and apply your own minimal, localized fix — do not punt back with 'no suggestion provided, review manually'. Keep the change as small as possible: add a guard clause, gate on a loading state, reorder an await, wrap in a conditional, etc. Do not refactor surrounding code or expand scope beyond the finding. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> -- 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]
