feat: add `eds-migrate` script for running codemods on major version upgrades #1951

jeremiah-clothier · 2024-05-17T23:00:29Z

Summary

Note

Implementation isn't done, trying to get feedback since there's enough code to look at and have a discussion. Want to make sure we're heading in the right direction and building something that's useful in the long run

This PR adds a new command eds-migrate. EDS Migrate is a collection of codemods written with ts-morph. It is intended to help developers migrate breaking changes & deprecations.

Test Plan:

Automated tests for individual transforms
Manually tested my changes, by creating a release and invoking the command on a project

Jira Tickets:

codecov · 2024-05-17T23:00:41Z

Codecov Report

Attention: Patch coverage is 98.29060% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 96.79%. Comparing base (72daa0b) to head (fd11783).
Report is 7 commits behind head on v15-components-2.0.

Files	Patch %	Lines
src/bin/migrate/transforms/edit-jsx-prop.ts	97.10%	2 Missing ⚠️

Additional details and impacted files

@@                  Coverage Diff                   @@
##           v15-components-2.0    #1951      +/-   ##
======================================================
+ Coverage               96.73%   96.79%   +0.05%     
======================================================
  Files                     137      140       +3     
  Lines                    3435     3552     +117     
  Branches                  927      964      +37     
======================================================
+ Hits                     3323     3438     +115     
- Misses                    109      111       +2     
  Partials                    3        3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jeremiah-clothier · 2024-05-17T23:10:07Z

src/migrate/index.js

+  const project = new Project({
+    tsConfigFilePath: path.join(tsconfigPath),
+  });


I really like this feature of ts-morph when compared to jscodeshift, it can use a tsconfig file and then call project.getSourceFiles() to get all the files in that project. From memory when we migrated to typescript and used jscodeshift we had to pass file paths explicitly to jscodeshift

src/migrate/README.md

jeremiah-clothier · 2024-05-17T23:13:00Z

src/migrate/migrations/14-to-15alpha.js

No tests at the migration level right now, tests are at the /transform level. Would probably be worthwhile once the migration codemod is solidified more in terms of "what the transforms are"

jeremiah-clothier · 2024-05-17T23:17:09Z

src/migrate/README.md

Todo: docs for writing codemods and helpful links or resources, navigating an AST is kinda confusing but there are tools that make it less so

https://astexplorer.net/

booc0mtaco

Great start! excited to have these as a part of the repo finally.

I can see an argument for having the scripts in TS over JS, so it's worth keeping that as an option. Feel free to publish an alpha version containing these migrations and such once you get to a place to confirm function

src/migrate/migrations/14-to-15alpha.js

bin/eds-migrate.js

src/migrate/transforms/rename-jsx-import.test.js

src/migrate/README.md

src/migrate/transforms/rename-jsx-import.test.js

ahuth · 2024-05-21T10:36:20Z

src/migrate/transforms/rename-jsx-import.test.js

+    const host = new InMemoryFileSystemHost();
+    const project = new Project({
+      compilerOptions: undefined,
+      fileSystem: host,


It's nice that ts-morph provides an in-memory file system for running tests!

booc0mtaco

Soft approval (once the build passes). We can merge and iterate as we go.

Let's confirm that it's possible to trigger the scripts in a local checkout (so we don't have to do .alpha releases for each test.

jeremiah-clothier · 2024-05-24T17:16:52Z

Soft approval (once the build passes). We can merge and iterate as we go.

Let's confirm that it's possible to trigger the scripts in a local checkout (so we don't have to do .alpha releases for each test.

Confirmed I can just run the file locally by

Running build:bin in EDS directory
Provide file in terminal in an app's directory /Users/jclothier/Documents/programming/edu-design-system/bin/eds-migrate.js

I wasn't able to figure out referencing a local file in apps/group-up/package.json but will try more and document it if I figure it out. The method above isn't ideal for testing in apps because you'd also want new component changes so you'd want to not just reference the script but ideally a local version of the package

cc @booc0mtaco

…upgrades (#1951) Adding a new script which can be executed using `npx eds-migrate --help` to help automatically migrate components with new major version releases.

## [15.0.0](v14.0.0...v15.0.0) (2024-06-20) ### ⚠ BREAKING CHANGES * **TextareaField:** introduce 2.0 component (#1911) * **Card:** introduce 2.0 component (#1908) * **Modal:** introduce 2.0 component (#1907) * **Toast:** introduce 2.0 component (#1906) * **Tooltip:** introduce 2.0 component (#1905) * **BannerNotification:** introduce 2.0 component (#1904) * **InlineNotification:** introduce 2.0 component (#1903) * **Accordion:** introduce 2.0 component (#1901) * **Select:** introduce 2.0 component (#1899) * **config:** use literal values in style-dictionary config (#1900) * **InputField:** introduce 2.0 component (#1898) * **Checkbox:** introduce 2.0 component (#1897) * **Radio:** introduce 2.0 component (#1895) * **Menu:** introduce 2.0 component (#1894) * **TabGroup:** introduce 2.0 component (#1892) * **NumberIcon:** introduce 2.0 component (#1891) * **Link:** introduce v2.0 component (#1890) * **Button:** introduce v2.0 component (#1889) * **tokens:** remove units from design system tokens (#1912) * **Icon:** introduce 2.0 component (#1925) * adjust responsive and spacing tokens/config (#1933) * **AppNotification:** introduce 2.0 component (#1945) * **ToastNotification:** rename from Toast to ToastNotification (#1944) * **typography:** update typography tokens and fonts (#1942) * **FieldLabel:** introduce 2.0 component (#1953) * **LoadingIndicator:** introduce 2.0 component (#1963) * update tier 1 and 2 typography tokens (#1969) * move from isWarning and isError to status prop (#1973) * pre-cleanup changes to prepare for v15 (#1992) ### Features * **Accordion:** introduce 2.0 component ([#1901](#1901)) ([cf2086b](cf2086b)) * add new v2.0 component tokens ([#1888](#1888)) ([3607a5d](3607a5d)) * **BannerNotification:** introduce 2.0 component ([#1904](#1904)) ([cda9e4b](cda9e4b)) * **Button:** introduce v2.0 component ([#1889](#1889)) ([a6b446f](a6b446f)) * **Card:** introduce 2.0 component ([#1908](#1908)) ([cd21b49](cd21b49)) * **Checkbox:** introduce 2.0 component ([#1897](#1897)) ([f3fc767](f3fc767)) * **config:** use literal values in style-dictionary config ([#1900](#1900)) ([e470f4b](e470f4b)) * **InlineNotification:** introduce 2.0 component ([#1903](#1903)) ([7bff52d](7bff52d)) * **InputField:** introduce 2.0 component ([#1898](#1898)) ([a3d3984](a3d3984)) * **Link:** introduce v2.0 component ([#1890](#1890)) ([bdce10a](bdce10a)) * **Menu:** introduce 2.0 component ([#1894](#1894)) ([3f540f9](3f540f9)) * **Modal:** introduce 2.0 component ([#1907](#1907)) ([d14c963](d14c963)) * **NumberIcon:** introduce 2.0 component ([#1891](#1891)) ([cc7e140](cc7e140)) * **Radio:** introduce 2.0 component ([#1895](#1895)) ([8ef797f](8ef797f)) * **Select:** introduce 2.0 component ([#1899](#1899)) ([1164b90](1164b90)) * **TabGroup:** introduce 2.0 component ([#1892](#1892)) ([e952d33](e952d33)) * **TextareaField:** introduce 2.0 component ([#1911](#1911)) ([a68a255](a68a255)) * **Toast:** introduce 2.0 component ([#1906](#1906)) ([8bce819](8bce819)) * **Tooltip:** introduce 2.0 component ([#1905](#1905)) ([ded98b2](ded98b2)) * add support for extended nav and action components ([#1918](#1918)) ([f4a541e](f4a541e)) * **tokens:** remove units from design system tokens ([#1912](#1912)) ([ab666cf](ab666cf)) * **Icon:** introduce 2.0 component ([#1925](#1925)) ([3e40638](3e40638)) * adjust responsive and spacing tokens/config ([#1933](#1933)) ([b19e453](b19e453)) * **AppNotification:** introduce 2.0 component ([#1945](#1945)) ([489e8d9](489e8d9)) * **ToastNotification:** rename from Toast to ToastNotification ([#1944](#1944)) ([07284c2](07284c2)) * **typography:** update typography tokens and fonts ([#1942](#1942)) ([3140996](3140996)) * **Link:** allow nodes to be used in link body ([#1950](#1950)) ([01970a2](01970a2)) * allow react nodes on subtitle ([#1954](#1954)) ([fc6bb78](fc6bb78)) * **FieldLabel:** introduce 2.0 component ([#1953](#1953)) ([6198b9e](6198b9e)) * add eds-migrate command ([b45061e](b45061e)) * **tokens:** add border-utility-inteactive-secondary tokens ([#1959](#1959)) ([72daa0b](72daa0b)) * add `eds-migrate` script for running codemods on major version upgrades ([#1951](#1951)) ([109a0e5](109a0e5)) * **LoadingIndicator:** introduce 2.0 component ([#1963](#1963)) ([26faab7](26faab7)) * **LoadingIndicator:** update stroke width in Button ([#1964](#1964)) ([bac3594](bac3594)) * **Menu:** set new default for menu trigger ([#1965](#1965)) ([24815c2](24815c2)) * **Select:** support horizontal labels ([#1962](#1962)) ([675ad5f](675ad5f)) * **TabGroup:** add inverse variant treatment ([#1960](#1960)) ([402e433](402e433)) * **tokens:** add border-utility-inteactive-secondary tokens ([#1959](#1959)) ([72daa0b](72daa0b)) * **Button:** update interactive styles for tertiary buttons ([#1970](#1970)) ([288da8c](288da8c)) * update tier 1 and 2 typography tokens ([#1969](#1969)) ([9dea463](9dea463)) * **Link:** add inverse variant (with variant prop) ([#1972](#1972)) ([bdbf9df](bdbf9df)) * move from isWarning and isError to status prop ([#1973](#1973)) ([56066ae](56066ae)) * **Icon:** add new and updated icons ([#1981](#1981)) ([fc7f842](fc7f842)) * **Link:** add inverse text visited color token and apply ([#1982](#1982)) ([98dec99](98dec99)) * **ToastNotification:** add dismissType with automated dismissing ([#1980](#1980)) ([8545f14](8545f14)) * **Tooltip:** add inverse variant ([#1984](#1984)) ([d6ccc8d](d6ccc8d)) * **Typography:** add typography-overline-lg ([#1993](#1993)) ([36eb3c9](36eb3c9)) * pre-cleanup changes to prepare for v15 ([#1992](#1992)) ([dbce0d2](dbce0d2)) ### Bug Fixes * disambiguate old token colors ([#1913](#1913)) ([758eb2d](758eb2d)) * **Button:** allow as prop on button ([#1994](#1994)) ([37d1f5b](37d1f5b)) * **FieldNote:** fix icon alignment and size issues ([367717e](367717e)) * **Button:** align disabled treatment to latest design ([#1931](#1931)) ([01a9d71](01a9d71)) * sync color tokens with design ([#1929](#1929)) ([146df70](146df70)) * **Button:** address QA design feedback ([#1940](#1940)) ([1e431b4](1e431b4)) * **ButtonGroup:** address QA design updates ([#1943](#1943)) ([1595a18](1595a18)) * **InlineNotification:** address QA updates ([#1937](#1937)) ([d96ab79](d96ab79)) * **TabGroup:** address QA comments and designs ([#1938](#1938)) ([48e92d4](48e92d4)) * **TextareaField:** address QA updates ([#1936](#1936)) ([3aa5c94](3aa5c94)) * update token and theming ([#1946](#1946)) ([5546205](5546205)) * **Accordion:** address QA updates from design ([#1948](#1948)) ([56fa437](56fa437)) * **AppNotification:** apply usage feedback ([#1949](#1949)) ([06cc194](06cc194)) * **NumberIcon:** address QA design notes ([#1947](#1947)) ([007d757](007d757)) * **Card:** address QA design and eng feedback ([#1958](#1958)) ([14c73fe](14c73fe)) * **Modal:** address QA updates ([#1957](#1957)) ([0d5a414](0d5a414)) * handle more cases ([a7e5830](a7e5830)) * **FieldNote:** adjust layout for icon and text lockup ([5788fe5](5788fe5)) * **Button:** add in missing inverse disabled treatments ([#1976](#1976)) ([8389f35](8389f35)) * **Button:** mark disable usage as invalid ([#1977](#1977)) ([99a70d3](99a70d3)) * **Button:** use text-utility-default state tokens ([#1979](#1979)) ([e754588](e754588)) * **Link:** address problems with link color inheritance ([#1975](#1975)) ([78d173e](78d173e)) * **Link:** align icons in flexed standalone container ([#1978](#1978)) ([3a6a20d](3a6a20d)) * **Button:** align button icons and text with layouts ([#1988](#1988)) ([33fbd51](33fbd51)) * remove circular dependency for radio/checkbox ([dffed3c](dffed3c)) * use aria-disabled when disabled prop is applied ([#1987](#1987)) ([1fe3b0f](1fe3b0f)) * handle required disabled field hints ([#1990](#1990)) ([11c0883](11c0883)) * **Select:** allow attachment of headlessUI props to label ([#1991](#1991)) ([c3ce70f](c3ce70f))

jeremiah-clothier commented May 17, 2024

View reviewed changes

src/migrate/README.md Outdated Show resolved Hide resolved

jeremiah-clothier commented May 17, 2024

View reviewed changes

jeremiah-clothier requested review from ahuth and booc0mtaco May 17, 2024 23:13

jeremiah-clothier commented May 17, 2024

View reviewed changes

booc0mtaco reviewed May 20, 2024

View reviewed changes

src/migrate/migrations/14-to-15alpha.js Outdated Show resolved Hide resolved

bin/eds-migrate.js Outdated Show resolved Hide resolved

src/migrate/transforms/rename-jsx-import.test.js Outdated Show resolved Hide resolved

src/migrate/README.md Outdated Show resolved Hide resolved

ahuth reviewed May 21, 2024

View reviewed changes

src/migrate/transforms/rename-jsx-import.test.js Outdated Show resolved Hide resolved

ahuth reviewed May 21, 2024

View reviewed changes

feat: add eds-migrate command

b45061e

jeremiah-clothier force-pushed the jclothier/eds-migrate branch from 2ee7718 to b45061e Compare May 23, 2024 18:43

jeremiah-clothier added 3 commits May 23, 2024 11:48

chore(release): 15.0.0-alpha.11

147edc3

fix: handle more cases

a7e5830

chore(release): 15.0.0-alpha.12

7ac15d0

booc0mtaco reviewed May 23, 2024

View reviewed changes

feat: it's working pretty well

fd11783

jeremiah-clothier changed the title ~~[WIP]: add eds-migrate script for running codemods on major version upgrades~~ feat: add eds-migrate script for running codemods on major version upgrades May 24, 2024

jeremiah-clothier marked this pull request as ready for review May 24, 2024 17:11

jeremiah-clothier requested a review from a team as a code owner May 24, 2024 17:11

jeremiah-clothier merged commit 725d432 into v15-components-2.0 May 24, 2024
8 of 9 checks passed

jeremiah-clothier deleted the jclothier/eds-migrate branch May 24, 2024 17:18

jeremiah-clothier mentioned this pull request May 28, 2024

Use jscodeshift for adaptation of major versions #1883

Closed

booc0mtaco mentioned this pull request Jun 20, 2024

Release v15.0.0 #1996

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `eds-migrate` script for running codemods on major version upgrades #1951

feat: add `eds-migrate` script for running codemods on major version upgrades #1951

jeremiah-clothier commented May 17, 2024 •

edited

Loading

codecov bot commented May 17, 2024 •

edited

Loading

jeremiah-clothier May 17, 2024 •

edited

Loading

jeremiah-clothier May 17, 2024

jeremiah-clothier May 17, 2024

ahuth May 21, 2024

booc0mtaco left a comment

ahuth May 21, 2024

booc0mtaco left a comment

jeremiah-clothier commented May 24, 2024

feat: add eds-migrate script for running codemods on major version upgrades #1951

feat: add eds-migrate script for running codemods on major version upgrades #1951

Conversation

jeremiah-clothier commented May 17, 2024 • edited Loading

Summary

Test Plan:

codecov bot commented May 17, 2024 • edited Loading

Codecov Report

jeremiah-clothier May 17, 2024 • edited Loading

Choose a reason for hiding this comment

jeremiah-clothier May 17, 2024

Choose a reason for hiding this comment

jeremiah-clothier May 17, 2024

Choose a reason for hiding this comment

ahuth May 21, 2024

Choose a reason for hiding this comment

booc0mtaco left a comment

Choose a reason for hiding this comment

ahuth May 21, 2024

Choose a reason for hiding this comment

booc0mtaco left a comment

Choose a reason for hiding this comment

jeremiah-clothier commented May 24, 2024

feat: add `eds-migrate` script for running codemods on major version upgrades #1951

feat: add `eds-migrate` script for running codemods on major version upgrades #1951

jeremiah-clothier commented May 17, 2024 •

edited

Loading

codecov bot commented May 17, 2024 •

edited

Loading

jeremiah-clothier May 17, 2024 •

edited

Loading