swap-project-example

Installation

Global

$ yarn gobal add swap-project-example

or

$ npm install --global swap-project-example

Local

$ yarn add [-D] swap-project-example

or

$ npm install --save[-dev] swap-project-example

Usage

Global

$ swap-project-example

Local

import swapProjectExample from 'swap-project-example'
swapProjectExample()

Example

Usage screenshot

API

@TODO: document the API here

Contributing

Codebase

The codebase is written using the ESNext Specification (ECMAScript Stage 0), following the StandardJS Code Style

We use:

• Yarn to handle npm dependencies,
• ESNext CLI to transform ESx code to ESNext,
• Babel CLI to transpile ESNext code to node/browser compatible javascript,
• And Standard CLI + ESLint to lint or format ESNext codebase.

Contribution guide

See the contribution guide in a separated document.

Development

Global dependencies

Get the latest node engine (example with nvm):

$ nvm install lts/carbon

Install yarn from npm (for development only):

$ npm install --global yarn

All the rest of the development dependencies are local.

Clone and install

Clone the repo and install dependencies:

$ git clone [email protected]:rbecheras/swap-project-example.git
$ cd swap-project-example
$ yarn install

Running test

Finally, run the test pipeline:

$ yarn pipeline:test

Available yarn scripts

| Task Command | Task description | |---|---| | yarn clear | Delete the ./build/ and ./dist repositories | | yarn lint | Lint source files | | yarn lint:esnext | Lint ESNext source files | | yarn build | Build the whole distribution | | yarn build:assets | Build all the assets | | yarn build:assets:img | Build the images assets | | yarn build:lib | Build only the lib | | yarn build:tests | Build only the tests | | yarn build:docs | [TODO] Build only the docs | | yarn test | Run the tests in ./dist/tests/ | | yarn tests | An alias for yarn test | | yarn travis | Run the travis script | | yarn docs | [TODO] Serve the docs | | yarn pipeline | Run the complete pipeline | | yarn pipeline:test | Run the required jobs to run the tests, then run the tests | | yarn pipeline:build | Run the required jobs to build the dist, then build the dist | | yarn pipeline:docs | [TODO] Run the required jobs to serve the docs, then serve the docs | | yarn pipeline:build:tests | Run the required jobs to build the docs, then build the docs | | yarn pipeline:build:lib | Run the required jobs to build the docs, then build the docs | | yarn pipeline:build:docs | [TODO] Run the required jobs to build the docs, then build the docs | | yarn release | An alias to yarn release:patch | | yarn release:prerelease | Release and publish a new semver version (x.y.z-rc+1)| | yarn release:patch | Release and publish a new patch semver version (x.y.z+1)| | yarn release:minor | Release and publish a new minor semver version (x.y+1.z=0)| | yarn release:major | Release and publish a new major semver version (x+1.y=0.z=0)|

Develop in BDD mode

B.D.D. means Behavior-Driven-Development

The project is ready to code in BDD mode. Just run the bdd yarn command:

$ yarn bdd

The project will be lint, built, the BDD unit tests will be run, and the process will watch for any file changes to loop over the previous tasks (lint, build, test, watch).

Releasing a new version

The task yarn pipeline:build generate a ./dist folder in the repository's root directory but this folder is not part of the git repository (there is an entry in the .gitignore file). However the dist folder is included in the package.json#files field.

Thus to release a new, lets say, "patch" version, just run:

$ yarn release:patch

The whole build pipeline is run locally (lint, transpile, test) and then a new git tag and a new npm tag are pushed up.

License

Copyright © Rémi Becheras

See LICENSE