@miovision/eslint-config

ESLint shareable config for the Miovision JavaScript style guide

Installation

yarn add eslint @miovision/eslint-config --dev

Usage

After the @miovision/eslint-config package is installed, you can use it by specifying @miovision/eslint-config in the extends section of your ESLint configuration.

extends:
    - '@miovision/eslint-config'
rules:
    # additional, per-project rules...

Releasing

This project runs a continuous deployment pipeline. The release version is automatically incremeneted based on commit history with commitlint and semantic-release.

To release commit with a commit message that adheres to the [@commitlint/config-convential][9] format and push. The CI will do the rest.

Want to know more take a look at The way to fully automated releases in open source projects.

Manual Process

NOTE This process is documented strictly for documentation purposes, the automated release pipeline should be used for all cases.

# Verify the relase will have the expected behviour with a dry run
npm run release -- --dry-run

# Perform a release
npm run release

CI/CD

Build jobs can be verified locally prior to committing with the use of the CircleCI CLI tools:

# Install dependencies
curl -fLSs https://circle.ci/cli | bash

# Configure the CLI; note you will need to setup a personal access token in CircleCI
circleci setup

# Validate your config
circleci config validate

# preprocess the config and execute locally
circleci config process .circleci/config.yml  > .circleci/process.yml
circleci local execute -c .circleci/process.yml --job build-test

CircleCI Configuration

The CircleCI project MUST have the following variables defined:

| key | description | | --------- | -------------------------------------------------------------------------- | | GH_TOKEN | Token to allow the CI server to publish CHANGELOGS and tags back to GitHub | | NPM_TOKEN | Token to allow publishing of packages to the NPM registry |

License

The content of this project is under the MIT license.