eslint-config-arcticicestudio-base v0.6.0

Getting Started

The documentation provides chapters to learn about the requirements, the installation and how to use the package. You can learn how to build the project and run the tests in the development chapters.

To enable support for the React and JSX A11Y plugin rules refer to the main shareable rule configuration package eslint-config-arcticicestudio.

Quick Start

Installation

Add the package as development dependency to your project:

npm install --save-dev eslint-config-arcticicestudio-base

Next to all base ESLint rules, the default export also contains rules related to ECMAScript 6+ including the import and export features. Therefore this package depends on the eslint and eslint-plugin-import packages defined as peer dependencies.

Run npm install from within the project root to bootstrap the project and install the development- and runtime dependencies. The peer dependencies can now be easily installed using npm 5+ with npm-npx:

npx install-peerdeps --dev eslint-config-arcticicestudio-base

Please read the documentation on how to install the peer dependencies if using npm < 5.

Usage

This ESLint shareable config can be used by extending the ESLint configuration file of your project.

Add arcticicestudio-base to your extends array in your .eslintrc.js file:

module.exports = {
  "extends": ["arcticicestudio-base"]
};

Contributing

Read the contributing guide to learn about the development process and how to propose enhancement suggestions and report bugs, how to submit pull requests and the project's styleguides, branch organization and versioning model.

The guide also includes information about minimal, complete, and verifiable examples and other ways to contribute to the project like improving existing issues and giving feedback on issues and pull requests.