@becode/eslint-config

ESLint default configuration for BeCode projects

Usage no npm install needed!

<script type="module">
  import becodeEslintConfig from 'https://cdn.skypack.dev/@becode/eslint-config';
</script>

README

BeCode: ESLint Config

⚙️ ESLint default configuration for BeCode projects

About

Many of us like to use ESLint for our projects.

This module contains the common ESLint rules configuration for BeCode project, in a simpler, without-pain configuration.

Usage

Automatic method

You can also use the following command in your project:

npx @becode/eslint-config

That will create the eslint config file and install the needed dependencies. Simple and easy.

(optional) Create pre-commit git hook

You can also setup a git pre-commit hook to ensure that ESlint and Prettier are run before each commit, discarding commit if there's an error.

Simply use the --with-hook flag:

npx @becode/eslint-config --with-hook

(optional) Create lint npm script

You can also setup a lint npm script to lint and prettify your files.

🖐 **NOTE:**the script assumes your files are in a folder called src. Correct the path in your package.json if needed.

Simply use the --with-script flag:

npx @becode/eslint-config --with-script

Manual method

To use our rules, you simply need to configure your .eslintrc.js to look like this:

module.exports = {
    extends: "@becode"
};

cf. the official ESLint documentation page about shareable configs.

February 2019, leny for BeCode.