Skip to content

solarflare045/intolerable-style-guide

Repository files navigation

intolerable-style-guide npm version

If your linter isn't constantly yelling at you, it isn't strict enough.

Conventional Commits

Installation

You can install eslint-config-intolerable-style-guide using npm via

npm install -D eslint-config-intolerable-style-guide eslint@9

Configuration

You can configure ESLint to use the Intolerable Style Guide by adding the following eslint.config.mjs to your project:

import { defineConfig } from 'eslint/config';
import { ISG } from 'eslint-config-intolerable-style-guide';

export default defineConfig([
  {
    ignores: ['eslint.config.mjs'],
  },

  ISG,

  {
    languageOptions: {
      parserOptions: {
        project: './tsconfig.json',
      },
    },
  },
]);

It is also recommended to manually add a linting script to your package.json, which should look like this:

"scripts": {
  ...
  "lint": "eslint ."
}

This will allow you to run:

npm run lint

You could also consider running lint-staged to add some githooks to check the code before commit.

"lint-staged": {
  "*.ts": "eslint"
}

Querks

None. It is perfect.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5