npm package: @shesha/module-boilerplate
Description: Boilerplate for writing React Libraries bundled with Rollup.js to commonJs and ES6 Modules and React Storybook
Author: Boxfusion Team
Latest version: 0.0.8

## Shesha Module Boilerplate

[![shesha-module-boilerplate-0.x.x](https://github.com/Boxfusion/shesha-module-boilerplate/actions/workflows/shesha-module-boilerplate-0.x.x.yml/badge.svg)](https://github.com/Boxfusion/shesha-module-boilerplate/actions/workflows/shesha-module-boilerplate-0.x.x.yml)

# Getting started

#### Familiar with Git?

```
git clone https://github.com/Boxfusion/shesha-module-boilerplate.git
cd shesha-module-boilerplate
npm install
```

```
npm install
```

## Developing

To start the developing run :

```
npm run Storybook
```

This will build a version of your library, run the watcher and also run the Storybook.
To open the Storybook manually open your Browser and navigate to [http://localhost:6060](http://localhost:6060).
Start developing your components in `src/components` folder and update the `src/index.js` file accordingly.
Always provide an `YourComponent.stories.tsx` file, so your component will show up in the Storybook.
You can refer to example `Button` component, but i think you'll get the idea.

### Proposals (Babel)

For smoother development some Babel plugin are included

- [class-properties](https://github.com/babel/babel/tree/master/packages/babel-plugin-proposal-class-properties)
- [object-rest-spread](https://github.com/babel/babel/tree/master/packages/babel-plugin-proposal-object-rest-spread)
- [optional-chaining](https://github.com/babel/babel/tree/master/packages/babel-plugin-proposal-optional-chaining)

## Styling your components

`SCSS` and `CSS` are supported out of the box just import your styles into your component like you normaly would do.
For the use of `CSS Modules` refere to [rollup-plugin-postcss](https://github.com/egoist/rollup-plugin-postcss)

## Testing

Testing is done with [Jest](https://facebook.github.io/jest/), [Enzyme](http://airbnb.io/enzyme/) and [Jasmine Matchers](https://github.com/JamieMason/Jasmine-Matchers)
You can refer to `Button.test.js` as an example.

```
npm run test
```

or (for getting coverage)

```
npm run test:coverage
```

## Linting

Linting is set up through [ESLint](https://eslint.org/) and configured with [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb)
You can modify linting rules by overriding them in the `.eslintrc.json` file.

```
npm run lint
```

or (for for automatic fixing if possible)

```
npm run lint:fix
```

## Publishing your library to NPM

To release your library to NPM or your private Registry, make sure you have an active account at [NPM](https://www.npmjs.com/), your `.npmrc` file is correctly setup and the repository url in `package.json` file is set to your repository url, then:

```
npm publish
```

## Storybook

For custom layouts, styling and more information about the Styleguide please refer to [React Storybook](https://storybook.js.org/docs/react/get-started/introduction) documentation.

## Scripts

- `yarn start` : Only serves the Styleguide.
- `yarn build` : Builds your library (build can be faound in `dist` folder).
- `yarn styleguide:build` : Builds the static Styleguide in case you want to deploy it.
- `yarn test` : Runs the tests.
- `yarn test:coverage`: Runs the test and shows the coverage.
- `yarn lint` : Runs the linter, typescipt typecheck and stylelint.
- `yarn lint:fix` : Runs the linter, typescipt typecheck and stylelint and fixes automatic fixable issues.
- `yarn eslint`: Runs only the javascipt linter.
- `yarn eslint:fix`: Runs only the javascipt linter and fixes automatic fixable issues.
- `yarn stylelint`: Runs only the sytle linter.
- `yarn stylelint:fix`: Runs only the sytle linter and fixes automatic fixable issues.
- `yarn check-types`: Runs typescript type checker.
- `yarn release` : Publishes your Library on NPM or your private Registry (depending on your config in your `.npmrc` file).
- `yarn deploy`: Deploys the Styleguide to GitHub Pages.

## Resources

### Bundler

- [Rollup.js](https://rollupjs.org/guide/en)

### Code Formatter

- [Prettier](https://prettier.io/)

### Commit lint & Conventional commit

- [commitlint](https://commitlint.js.org/) & [Conventional Commits](https://www.conventionalcommits.org/)

### Styleguide

- [React Storybook](https://storybook.js.org/docs/react/get-started/introduction)

### Styleguide

- [React Styleguidist](https://react-styleguidist.js.org/)

### Testing

- [Enzyme](http://airbnb.io/enzyme/)
- [Jest](https://facebook.github.io/jest/)

### Linting

- [ESLint](https://eslint.org/)
- [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb)
- [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
- [stylelint-prettier](https://github.com/prettier/stylelint-prettier)
- [stylelint-scss](https://github.com/kristerkari/stylelint-scss)

### Compiler

- [Babel 7](https://babeljs.io/)
- [Typescript](https://www.typescriptlang.org/)