contactlab / eslint-config-contactlab Goto Github PK

Migration guide can be found here

Note:

• global-require -> node/global-require

Nodejs v14 reached end-of-life on 2023-04-30 (rif.), so the support for this specific version can be dropped.

Migration guide can be found here.

Closes #329

Node v12 is gone "end-of-life" so we can stop supporting it.

Meanwhile we can add Node v18 (next LTS) to the node-version matrix in the GitHub Actions pipeline

typescript-eslint package needs TypeScript in order to run: because eslint-config-contactlab aims to be used also in non-TypeScript projects the available configuration has to be splitted in contactlab and contactlab/typescript and TypeScript itself should be set as peerDependency

A new major version (v6) of typescript-eslint is now available.

The team reworked the configuration files names (the "recommended" ones) adding a slight distinction between "functional" and "stylistic" rules.

Thus, we should:

• use the -type-checked version of recommended rules;
• add also the "stylistic" rules.

Be aware: this change will catch and notify many new errors in the code base for sure.
In order to mitigate this situation the no-unsafe- rules severity should be set to warn

Every time I create a TypeScript enum, Eslint says it had already been defined.

export enum MyEnum { // <-- got "already declared in the upper scope” error
  myValueOne = 'myValue',
  myValueTwo = 'myValueTwo', 
}

Searching typescript-eslint GitHub issues shows several people asking the same thing.

The possible solution for the Typescript set of rules can be, accordingly to the typescript-eslint documentation, disable the no-shadow basic rule and enable @typescript-eslint/no-shadow.

   ...
   "rules": {
      "no-shadow": "off",
      "@typescript-eslint/no-shadow": ["error"]
   },
   ...

The official eslint-plugin-import seems to have published a new version with the pathGroupsExcludedImportTypes option for the import/order submodule, so we can use it instead of our forked version

Repo here

The configuration should be a combination of recommended and:

• fp-ts/no-module-imports off
• fp-ts/no-redundant-flow error
• fp-ts/prefer-traverse error
• fp-ts/prefer-chain error
• fp-ts/prefer-bimap error

Use greenkeeper-lockfile to make Greenkeeper work with project lockfiles.

The no-unused-vars rule (and its Typescript counter part) has an ignoreRestSiblings flag which avoids to mark sibling properties or "rest" properties as "unused".

We should consider to enable it by default

Drop support for node v4:

• set Node min version in package.json engine to 6.2.0;
• set npm min version in package.json engine to 3.8.9;
• remove nodejs version 4 from .travis.yml
• use supported ES6 feature

@/** import should be handle as "external" (after them).

Wrong:

import * as React from 'react';
import * as Option from 'fp-ts/Option';
import {Component} from './index';
import * as Env from '@/Env/types';

Right:

import * as Option from 'fp-ts/Option';
import * as React from 'react';
import * as Env from '@/Env/types';
import {Component} from './index';

Since version 5.17.0 @typescript-eslint supports the destructuredArrayIgnorePattern option of no-unused-vars rule.

So, we can add an "ignore pattern" for elements of destructured arrrays which start with _ (just like we did for functions parameters) in order to make legit things like:

const [_, someValue] = useSomeCustomHook();

if (someValue) {
  // ...
}