Light

agiledigital-labs / eslint-config-agile-digital Goto Github PK

View Code? Open in Web Editor NEW

3.0 8.0 2.0 459 KB

Agile Digital's standard ESLint config

License: MIT License

JavaScript 50.91% TypeScript 49.09%

eslint-config-agile-digital's Introduction

eslint-config-agile-digital

Agile Digital's standard ESLint config

Installation

yarn add --dev @agiledigital/eslint-config \
  eslint-config-typed-fp \
  @typescript-eslint/eslint-plugin \
  @typescript-eslint/parser \
  eslint \
  eslint-plugin-functional \
  eslint-plugin-total-functions \
  eslint-plugin-jest \
  eslint-plugin-prettier \
  eslint-plugin-sonarjs \
  eslint-plugin-import \
  eslint-plugin-simple-import-sort \
  eslint-plugin-filename-rules \
  eslint-plugin-jsdoc \
  eslint-plugin-tsdoc \
  eslint-plugin-no-secrets \
  eslint-plugin-prefer-arrow-functions \
  eslint-plugin-react \
  eslint-plugin-react-hooks \
  eslint-plugin-jsx-a11y \
  eslint-plugin-react-refresh \
  typescript

Usage

Turn on TypeScript's strict mode and noUncheckedIndexedAccess option.
Set up ESLint + TypeScript.
Update your .eslintrc.js:

module.exports = {
+  parser: "@typescript-eslint/parser",
  parserOptions: {
+    project: "./tsconfig.json",
+    ecmaVersion: 2018,
+    sourceType: "module"
+    tsconfigRootDir: __dirname,
  },
  extends: [
+  "@agiledigital",
+  "@agiledigital/eslint-config/react", // In addition to the above if this is a React project 
  ...
  ],
  rules: {
    ...
  }
};

eslint-config-agile-digital's People

Contributors

Stargazers

Watchers

Forkers

ruoqianwu adamlthomas

eslint-config-agile-digital's Issues

Override ReadonlyArray to `Immutable` instead of `ReadonlyDeep`

Per https://github.com/eslint-functional/eslint-plugin-functional/blob/main/docs/rules/settings/immutability.md#example-of-configuring-immutability-overrides

// .eslintrc.json
{
  // ...
  "settings": {
    "immutability": {
      "overrides": [
        {
          "name": "ReadonlyArray",
          "to": "Immutable",
          "from": "ReadonlyDeep"
        }
      ]
    }
  },
  "rules": {
    // ...
  }
}

Import rules from `eslint-plugin-fp-ts-strict` and `eslint-plugin-fp-ts`

The rulesets eslint-plugin-fp-ts-strict and eslint-plugin-fp-ts seem like a great fit for this config, or eslint-config-typed-fp. A separate issue has been created there, too.

Create a standard config for stylelint

https://stylelint.io/

Forbid console.log (in favour of info, warn, error)

Use https://eslint.org/docs/rules/no-console

Configure import rules for TypeScript

https://github.com/import-js/eslint-plugin-import#typescript

publish and dogfood self

Disable certain rules for tests

e.g.

  "overrides": [
    {
      "files": ["*.test.ts"],
      "rules": {
        "functional/functional-parameters": "off",
        "functional/no-return-void": "off",
        "functional/no-throw-statement": "off",
        "functional/no-expression-statement": "off",
        "total-functions/no-unsafe-mutable-readonly-assignment": "off",
        "sonarjs/no-duplicate-string": "off"
      }
    }
  ]

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Update dependency eslint-plugin-tsdoc to ^0.3.0
Update dependency eslint-plugin-no-secrets to v1
Update dependency eslint-plugin-sonarjs to v1
🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions

.github/workflows/node.js.yml

actions/checkout v4@3df4ab11eba7bda6032a0b82a6bb43b11571feac

actions/setup-node v3

npm

package.json

@agiledigital/eslint-config ^4.1.0

@types/react ^18.2.46

@typescript-eslint/eslint-plugin ^6.17.0

@typescript-eslint/parser ^6.17.0

eslint ^8.56.0

eslint-config-prettier ^9.1.0

eslint-config-typed-fp ^5.4.0

eslint-plugin-filename-rules ^1.3.1

eslint-plugin-functional ^6.0.0

eslint-plugin-import ^2.29.1

eslint-plugin-jest ^27.6.1

eslint-plugin-jsdoc ^46.8.2

eslint-plugin-jsx-a11y ^6.8.0

eslint-plugin-no-secrets ^0.8.9

eslint-plugin-prefer-arrow-functions ^3.1.4

eslint-plugin-prettier ^5.1.2

eslint-plugin-react ^7.33.2

eslint-plugin-react-hooks ^4.6.0

eslint-plugin-react-refresh ^0.4.3

eslint-plugin-simple-import-sort ^10.0.0

eslint-plugin-sonarjs ^0.23.0

eslint-plugin-total-functions ^7.1.0

eslint-plugin-tsdoc ^0.2.17

jest ^29.7.0

prettier ^3.1.1

prettier-plugin-packagejson ^2.4.6

react ^18.2.0

ts-jest ^29.1.1

type-coverage ^2.27.1

typescript ^5.3.3

@typescript-eslint/eslint-plugin >=6.7.0

@typescript-eslint/parser >=6.7.0

eslint ^8.0.0

eslint-config-prettier >=9.0.0

eslint-config-typed-fp >=5.3.0

eslint-plugin-filename-rules >=1.3.1

eslint-plugin-functional >=6.0.0

eslint-plugin-import >=2.28.0

eslint-plugin-jest >=27.4.0

eslint-plugin-jsdoc >=46.5.1

eslint-plugin-jsx-a11y >=6.7.0

eslint-plugin-no-secrets >=0.8.9

eslint-plugin-prefer-arrow-functions >=3.1.4

eslint-plugin-prettier >=5.0.0

eslint-plugin-react >=7.33.0

eslint-plugin-react-hooks >=4.6.0

eslint-plugin-react-refresh >=0.3.4

eslint-plugin-simple-import-sort >=10.0.0

eslint-plugin-sonarjs >=0.21.0

eslint-plugin-total-functions >=7.1.0

eslint-plugin-tsdoc >=0.2.17

typescript ^5.0.0

node >=16.10.0

nvm

.nvmrc

node 18

Check this box to trigger a request for Renovate to run again on this repository

add imports and other eslint plugins

eslint-plugin-import (note: https://github.com/import-js/eslint-plugin-import#typescript)
import/no-deprecated
import/no-cycle
eslint-plugin-jsdoc - Consider at least enforcing doc comments for exported values with the publicOnly option
https://github.com/nickdeis/eslint-plugin-no-secrets ?
https://eslint.org/docs/latest/rules/sort-imports ?
https://github.com/aotaduy/eslint-plugin-spellcheck

Update react config to whitelist idomatic react patterns

Example: functional/no-expression-statement is too noisy in the face of hooks. That rule does have an ignorePattern option that could be used to whitelist useFoo statements under the assumption that they're hooks. https://github.com/eslint-functional/eslint-plugin-functional/blob/main/docs/rules/no-expression-statements.md#ignorepattern

Rules to detect inaccessible html constructs

It would be nice to have some rules that detect inaccessible html constructs, in a way that eslint-plugin-jsx-a11y is unwilling to.

Disable prefer-immutable-types

It's currently bugged:

ESLint: 8.56.0

Error: ErrorType encountered.
Occurred while linting [...]
Rule: "functional/prefer-immutable-types"

Separate (?) config for react

Use getDefaultOverrides

https://github.com/agiledigital-labs/eslint-config-agile-digital/blob/main/index.ts#L85-L93

Remove eslint-plugin-spellcheck

tests

badges

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.