Yproximite / eslint-config-base

ESLint base configuration for our projects

eslint-config-base

ESLint base configuration for our projects.

Features

• Configure ESLint environments to browser and es6
• Configure ESLint to parse JavaScript code as ES6 code
• Configure indentation to 2 spaces

Installation

This package is hosted on GitHub Packages, so you must tell to npm/yarn where to download it. Please read Authenticating to GitHub Packages.

You can run npm login --registry=https://npm.pkg.github.com --scope=@yproximite or create a .npmrc file with the following content:

@yproximite:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=<access token>

Then run:

$ yarn add --dev @yproximite/eslint-config-base eslint^7.0.0 babel-eslint@^10.0.0

Usage

Edit your ESLint configuration file with:

{
  "extends": ["@yproximite/base"]
}

Development workflow

You need to install some dependencies first:

$ yarn

Contribution

• Make a pull request, its title should follows Angular commit message convention
• You should Squash and Merge your pull request

Publishing a new release

This is automatically done by GitHub Actions and semantic-release when you merge a pull request.