@medly/create-component
v0.7.3
Published
An application for generating react component
Readme
⚛️ Create React component
An application for generating simple react component.
Getting started
| Package Manager | Command |
| --------------- | ------------------------------ |
| NPM | npm init @medly/component |
| Yarn | yarn create @medly/component |
| PNPM | pnpx @medly/create-component |
Then follow the prompts or you can run command yarn create @medly/component <project-name> [options] with below options.
Options
| Flags | Description | Choices | Default |
| ----------------------------------------- | ------------------------------ | ---------------------- | -------- |
| -V, --version | output the version number | | |
| -o, --org <org> | name of the organization | | |
| -r, --registry <registry> | registry to publish the module | npm, github | npm |
| -p, --package-manager <package-manager> | package manager | npm, yarn, pnpm | yarn |
| -a, --access <access> | access level of the component | public, restricted | public |
| -i, --interactive | show interactive questionnaire | | |
| -h, --help | display help for command | | |
Features
It sets up below things:
storybookfor documentation.babeltotranspilethe code.rollupto bundle the code.jestto writeunit tests.prettierto automaticallyformatthe code.eslintto catch the error.@medly-componentswith theme.commitizen&commitlintto optimize your commit message.github workflowto automaticallypublish the packageon PR merge`.github workflowto automaticallypublish the documentationon github pages on PR merge`.semantic-releaseto bump the version and update theCHANGELOG.
