pob

pob

Pile of bones, library generator with git/babel/typescript/typedoc/readme/jest

How to install

npm install -g pob
mkdir some-lib
cd some-lib
pob

Perfect !

You can now use yarn run watch !

How this works

Babel

Write code in the src directory, it's then transpiled with babel and rollup to dist. Use the task yarn run build or yarn run watch to transpile the code.

There are several environments: node, browser. For each of these environments, there is also a dev version that add flow runtime checks.

Coding Rules

Eslint is used to ensure a common coding style. I mostly follow the Airbnb coding style. You can check the code by running the task yarn run lint. With an editor, install the plugins to validate the code as you type !

Documentation

typedoc allows to document the code and generate the api. jest is used to generate the coverage.

Documentation can be generated by github actions and pushed to github-pages.

Tests

Tests are in the directory src with jest. Use the task yarn test to run the tests with jest.

Available tasks with yarn run

Code, Transpile, Lint

• build: clean the directory, build src to dist with rollup
• watch: clean then build and watch with rollup
• lint: execute eslint
• test: run tests with jest

Generate documentation

Documentation (api + test coverage) is deployed to gh-pages via a github action.

Publish a new release

• yarn run release

In the process, this will pre-generate a changelog based on the commits, then open nano so you can adapt it if you want.