@justeattakeaway/generator-pie-component
v0.24.0
Published
A generator for PIE Web Components
Downloads
379
Readme
generator-pie-component
generator-pie-component
is a generator for Pie Web Components.
Usage
- Installation
- Generate the component
- Add the component to storybook
- Set up Percy visual regression testing
- Set up the project label for GitHub
Installation
Build the generator package locally (it is recommended you force the build)
$ yarn build --filter=generator-pie-component --force
Generating a new component
To run the generator, use this command from the root directory within the monorepo:
$ npx yo @justeattakeaway/pie-component
An interactive prompt should now be displayed asking for a component name.
Once you have completed all the prompts, your scaffolded component will be generated! 🎉
Setting up Visual Regression Testing:
- Create a Percy project for the component on the Percy website.
- From the "Project settings" page, copy the project token value.
- You need to add the new token value as a repository secret in GitHub. It must be named
PERCY_TOKEN_PIE_COMPONENT_NAME
. Visual tests will not work/run if this is not set up correctly.
Local development
Install the dependencies. Note that this, and the following commands below, should be run from the root of the monorepo:
yarn
To build the generator-pie-component
package, run the following command:
yarn build --filter=generator-pie-component
You can also build the component in watch
mode if desired with the following command:
yarn watch --filter=generator-pie-component
Contributing
In order to contribute to the generator-pie-component
, it's advised to link your local build of the generator to Yeoman.
To do this, run yarn link
from the root of the generator-pie-component
folder in the mono-repo.
Once you have done this, running npx yo @justeattakeaway/pie-component
will run your local copy of the generator (rather than the version installed globally via NPM/Yarn).