feat(PPDSC-2162): codemods setup package

[mutebg]

PPDSC-2162

What

Created a new folder for codemod, with its own package.json / scripts and make file
Created a CLI tool and added initial source code and simple transformer
Added all necessary configs to run tests, linting and prittier on the codemod package.
Update Circle CI config with new jobs and workflows

in order to test:

cd lib/codemods
npm link

go to a site folder and execute:

newskit-codemod update-token "./theme/**/*.+(ts|tsx|json)" 

you should have 3 files with renamed tokens

Keep in mind that for the development CLI took is newskit-codemod but once that's published to NPM it can be used as npx @newskit/codemod ....

I have done:

• Written unit tests against changes
• Written functional tests against the component and/or NewsKit site
• Updated relevant documentation

I have tested manually:

• The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
• The screen reader reads and flows through the elements as expected.
• There are no new errors in the browser console coming from this PR.
• When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
• The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

[newskit-engineering]

You can preview these changes on:
Documentation Site: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2162-codemods-setup-package
Storybook: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2162-codemods-setup-package/storybook

[Vanals]

Should the merge checker be added as required later 🤔 ? or now if possible. I was curious to see if creates issue have a required job in an optional workflow

[Vanals]

https://nidigitalsolutions.jira.com/wiki/spaces/NPP/pages/1334083669/Engineering+release+process Should points 3 4 and 5 be influenced if releasing codemod too? Point 4 likely?
I think would be good to ask feedbacks also from other devs around how we are changing the release process notes. And if is clear in the new release documentation

[Vanals]

A part from those LGTM! We will just need to test the release :D

[mutebg]

https://nidigitalsolutions.jira.com/wiki/spaces/NPP/pages/1334083669/Engineering+release+process

[mutebg]

https://nidigitalsolutions.jira.com/wiki/spaces/NPP/pages/1334083669/Engineering+release+process Should points 3 4 and 5 be influenced if releasing codemod too? Point 4 likely? I think would be good to ask feedbacks also from other devs around how we are changing the release process notes. And if is clear in the new release documentation

IMO it should not influence 3 and 5; About 4 maybe, depends if we want to have separate release notes for the codemod, but IMO is not needed.

[Vanals]

https://nidigitalsolutions.jira.com/wiki/spaces/NPP/pages/1334083669/Engineering+release+process Should points 3 4 and 5 be influenced if releasing codemod too? Point 4 likely? I think would be good to ask feedbacks also from other devs around how we are changing the release process notes. And if is clear in the new release documentation

IMO it should not influence 3 and 5; About 4 maybe, depends if we want to have separate release notes for the codemod, but IMO is not needed.

As you click the button

You will be creating a new release. tag + notes. So you eventually need to rename the notes, fill them in. Or delete them in a point 4.1?

dismiss