@justeat/generator-component
v2.15.0
Published
Generator Component – A generator for Fozzie components
Downloads
69
Maintainers
Readme
generator-component
A generator for Fozzie components.
Usage
Installation
First, install yeoman
if you haven't already done so:
$ npm install --global yo
And then install the component generator:
$ npm install --global @justeat/generator-component
Running the generator
To run the generator, use this command from any directory within the fozzie-components
repo:
yo @justeat/component
An interactive prompt should now be displayed asking for a Component name, description and a number of options for you to define the component that you are creating.
Once you have completed all the prompts, your scaffolded component will be generated 🎉
Contributing
In order to contribute to the generator-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-component
folder in the mono-repo.
Once you have done this, running yo @justeat/component
will run your local copy of the generator (rather than the version installed globally via NPM).
Note
!!! There is a manual step temporary required: Please, add your component to .circleci/config.yml
under save_cache_dist_directories
manually after the component is generated.