Repository navigation
feat(gamut)!: promote deep imports to the root, renaming Menu and SelectDropdown elements - #41
Merged
Merged
Conversation
…eset Adds @skillsoft/gamut-codemods: the CLI (clean-tree guard, --dry, --only, --no-report, --force), the runner for ast, splice, and file migrations, the shared helpers (module-string finder, leftovers report, version-range checks, flat ESLint config detection), the preset registry, and the fixture harness. The scope-swap preset has its package map but no migrations yet, so a run only reports the lines that still name an old package. Each breaking change lands its migration in its own PR. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…swap scope-rename swaps @Codecademy/gamut* and eslint-plugin-gamut for their @SkillSoft names in every module position and in comments. package-json, mdx-imports, and yarnrc cover dependencies, MDX ESM blocks, and .yarnrc.yml lists. @codecademy/gamut-kit has no replacement, so package-json and mf-shared expand it into the packages it bundled. In Module Federation config that makes Gamut a real singleton, which the checklist calls out. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ectDropdown elements Exports formFieldStyles, formFieldPaddingStyles, conditionalStyles, ButtonBaseProps, HTMLToReactNode, MenuToolTipWrapper, and Menu's list elements from the root. The list elements and SelectDropdown's option component are renamed (MenuList*, MenuListButton, IconOptionComponent) so they don't collide with the public List component and IconOption type. The deep-imports codemod rewrites known /dist/ paths to the root, keeps local names across renames, merges into existing imports, and warns on paths with no public replacement. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 20, 2026
CodeQL read `migration.match(file)` in cli.ts as String.prototype.match on a command-line argument and flagged js/regex-injection. Nothing builds a regex from the path; the method just had the same name. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…migrations Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The package-json warning already names each range that's newer than the fork point, so the extra next step only repeated it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
dreamwasp
marked this pull request as ready for review
October 20, 2026 15:48
LinKCoding
approved these changes
Oct 26, 2026
LinKCoding
left a comment
LinKCoding
left a comment
Contributor
There was a problem hiding this comment.
running scope-swap prints:
All done.
Results:
0 errors
0 unmodified
1 skipped
1 ok
Time elapsed: 0.759seconds
— package.json and .eslintrc —
0 file(s) changed
— leftovers (0) —
— next steps —
1. Run your formatter and lint autofix (prettier --write, then eslint --fix). Split imports come out in recast style, `@skillsoft` sorts differently from `@codecademy` for import-order rules like simple-import-sort, and the shorter scope lets some wrapped imports fit on one line.
2. Reinstall (yarn), then type-check and run your tests.
3. Work through the warnings above and the leftovers list.
and checked SelectDD's icon and Menu stories and they load and working just as intended
| import { ListItem } from '@codecademy/gamut/dist/Menu/elements'; | ||
| import type { BoxProps } from '@codecademy/gamut'; | ||
| import type { PopoverContainerProps } from '@codecademy/gamut/dist/PopoverContainer/types'; | ||
| import { Box as Again } from '@codecademy/gamut/dist/Box/props'; |
Contributor
There was a problem hiding this comment.
just curious, why are we testing this?
my main gripe is that this repo is re-importing Box, where it seems like there should be a warning about that.
I guess if this is already done in practice, in order for the codemod to not break the code, then this is the path of least resistance. However, it still seems like a warning would be nice here (although I doubt it'd be hit, or I so really hope it doesn't get hit lol)
Keep this branch's deep-imports migration and manifest rows alongside main's Video work (moved-exports, markdown-video-overrides, tsconfig-dom) and the codemods tests and changesets. Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>
@skillsoft/eslint-plugin-gamut
@skillsoft/gamut
@skillsoft/gamut-agent-tools
@skillsoft/gamut-codemods
@skillsoft/gamut-icons
@skillsoft/gamut-illustrations
@skillsoft/gamut-patterns
@skillsoft/gamut-styles
@skillsoft/gamut-tests
@skillsoft/variance
commit: |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Breaking change:
/dist/deep imports that have a public replacement are promoted to the package root. Menu's list elements and SelectDropdown's option component are renamed along the way, so they don't collide with the publicListcomponent andIconOptiontype.Stack (split from #28, merge in order):
mainmain@skillsoft/gamutdist/Menu/elements,dist/Form/SelectDropdown/elements)@skillsoft/gamut)List,ListPropsMenuList,MenuListPropsListItem,ListItemPropsMenuListItem,MenuListItemPropsListLink,ListLinkPropsMenuListLink,MenuListLinkPropsListButtonMenuListButtonIconOption(the component)IconOptionComponentMenuToolTipWrapper,formFieldStyles,formFieldPaddingStyles,conditionalStyles, and theHTMLToReactNodeandButtonBasePropstypes. The rest ofForm/stylesstays internal.Codemod
deep-importsrewrites known/dist/paths to the root and merges them into an existing import from the same package.import { List } from '.../dist/Menu/elements'becomesimport { MenuList as List } from '@skillsoft/gamut'.Form/styles)ButtonBase, which has no public replacementrequire()manifest.test.tsfails if a row could send a name to a target that doesn't export it.PR Checklist
Testing Instructions
yarn nx test gamut-codemods. Expect 73 tests to pass, includingmanifest.test.tsagainst the built dist.yarn nx test gamut. The export snapshot is updated, and Menu and SelectDropdown tests pass with the renames.yarn nx run gamut:verify.Build and run on a throwaway repo:
Expect
import { Box, MenuList as List } from '@skillsoft/gamut';, and a[deep-imports]warning thatButtonBaseis not public.Storybook: Menu and SelectDropdown stories look and behave as before.
PR Links and Envs
🤖 Generated with Claude Code