nested-archetype
v1.0.0
Published
Shared configuration for JS projects at Nested
Downloads
3
Keywords
Readme
Nested Archetype
This archetype includes common tools used to build JS (not necessarily React) applications.
To start a new project using this archetype:
- Create a project with
git
and run throughnpm init
. - Run
yarn add builder nested-archetype
. - Run
yarn add -D nested-archetype-dev
. - Create a
.babelrc
file with{ "extends": "./node_modules/nested-archetype-dev/.babelrc" }
- Create a
.builderrc
file with--- archetypes: - nested-archetype
- Create a
.eslintrc.js
file withmodule.exports = { extends: './node_modules/nested-archetype-dev/.eslintrc.js', };
Notes
If you haven't done this before, you will need to augment your PATH
variable to be able to use the local version of builder following these instructions. If you add this to your .bash_profile
This package was built using builder
.
You can override all of the commands in your local package.
Available commands
All of the commands need to be preceded by builder run
. Pro tip: add an alias b
for builder run
command.
check
- runs the linter and tests.lint
- runs the linter.test
- runs all of the tests concurrently. The amount of tests running at the same time defaults to the number of the cores available on your machine.test:single
- runs all of the tests consecutively (one by one).test:watch
- watches all tests.
Extending Jest configuration
You can extend Jest configuration by creating a jest.config.js
file and adding a preset option.
module.exports = {
preset: 'nested-archetype-dev',
...your configuration
};