⚛️ 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:
-
storybook
for documentation. -
babel
totranspile
the code. -
rollup
to bundle the code. -
jest
to writeunit tests
. -
prettier
to automaticallyformat
the code. -
eslint
to catch the error. -
@medly-components
with theme. -
commitizen
&commitlint
to optimize your commit message. -
github workflow
to automaticallypublish the package
on PR merge`. -
github workflow
to automaticallypublish the documentation
on github pages on PR merge`. -
semantic-release
to bump the version and update theCHANGELOG
.