Skip to content

Commit 95dd78d

Browse files
committed
Add new command to README
1 parent e59844a commit 95dd78d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@ npm run tsc
9292

9393
Runs `tsc --noEmit`, which will compile the TypeScript code without emitting files. This acts as a TS error check in your CLI. This is useful to catch TS errors that you might miss during development. For more information, see the [TypeScript Compiler (tsc) documentation](https://www.typescriptlang.org/docs/handbook/compiler-options.html).
9494

95+
### Scaffold new component
96+
97+
```bash
98+
npm run component
99+
```
100+
Runs the `lib/component.js` script, which will scaffold a new React or Emotion component,
101+
with the option to include a Storybook story file as well.
102+
95103
## Husky
96104

97105
This project uses [Husky](https://typicode.github.io/husky/#/) to check code on git commits. By default, it is setup to use the `npm test` script which runs `lint` and `tsc` (TypeScript) checks against the codebase. This check occurs on `git commit` attempts. This helps developers catch errors _before_ pushing branches and creating PRs, quickening the overall dev worklow.

0 commit comments

Comments
 (0)