NPM Package
Dev environment
Recommended VS Code extensions
We recommend you install the following vs-code extensions to streamline the code quality and linting process.
| Name | Purpose |
|---|---|
| Prettier - Code formatter | Enforces a consistent style by parsing your code and re-printing it. To ensure that this extension is used over other extensions you may have installed, be sure to set it as the default formatter in your VS Code settings. This setting can be set for all languages or by a specific language. This will also allow for auto-linting on file save. A JavaScript comment of `// prettier-ignore |
| ESLint | Integrates ESLint into VS Code. If you are new to ESLint check the documentation. |
| stylelint | A Visual Studio Code extension to lint CSS/SCSS/Less with stylelint |
Important NPM commands
Command (prefix with npm run) |
Effect |
|---|---|
build |
Bundles library with rollup.js |
storybook |
Starts Storybook UI component explorer |
test |
Run jest test suite |
test:watch |
Run tests in hot-reloading watch mode |
lint |
Formats code to conform to prettier and stylelint format |
lint:check |
Checks for eslint, prettier, and stylelint formatting errors/warnings. |