@cretadoc/eslint-config v1.1.0

@cretadoc/eslint-config

It provides ESlint configuration for Cretadoc packages.

Introduction

This package extends the eslint:recommended preset. So, the rules already activated by the preset are not listed unless options differ or we need to deactivate them for some reason.

The others rules are listed in alphabetical order without regards to the section where they appear on the "Rules reference" page.

Some rules have options. These options are explicitly defined even when they match the default ones to prevent unexpected changes in eslint:recommended.

Install

npm install --save-dev eslint eslint-plugin-import @cretadoc/eslint-config

yarn add -D eslint eslint-plugin-import @cretadoc/eslint-config

pnpm add -D eslint eslint-plugin-import @cretadoc/eslint-config

Usage

Create an .eslintrc file with:

{
  "root": true,
  "extends": "@cretadoc/eslint-config"
}

Or add the config to your package.json:

{
  "name": "your-package",
  "eslintConfig": {
    "root": true,
    "extends": "@cretadoc/eslint-config"
  }
}

With Typescript

You should install some specific packages in addition:

pnpm add -D @typescript-eslint/parser @typescript-eslint/eslint-plugin typescript

By default, ESlint is configured to find the nearest tsconfig.json file in your project. You can override this behavior and tells ESlint which config should be used by adding the following lines to your ESlint config:

{
  "parserOptions": {
    "project": true,
    "tsconfigRootDir": __dirname
  }
}

With React

This package also provides a shareable configuration for React projects. You should install some specific packages in addition:

pnpm add -D eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks

Create an .eslintrc file with:

{
  "root": true,
  "extends": "@cretadoc/eslint-config/react"
}

Or add the config to your package.json:

{
  "name": "your-package",
  "eslintConfig": {
    "root": true,
    "extends": "@cretadoc/eslint-config/react"
  }
}

If you are using Storybook, you should also install eslint-plugin-storybook. However, this plugin does not support MDX files.

License

This package is released under the MIT license.

The documentation (Markdown files) is released under a Creative Commons license.