ljosberinn / eslint-config-galex

hopefully the last eslint config you'll ever need - customizable & modern best practices for JS, TS, Node, React, Remix, Next, Jest, testing-library & storybook

const readMePlease = {
  greetings: "stranger 👋",
  iAm: "Gerrit Alex",
  usually: "building things",
  in: "TypeScript, Full Stack",
  findMeOn: [{ twitter: "@gerrit_alex" }, { discord: "Chevron#6539" }],
};

eslint-config-galex's Issues

[react] use @babel/eslint-parser

https://github.com/babel/babel/tree/main/eslint/babel-eslint-parser

Parsing error: Unexpected token <

I'm using these eslint rules in a monorepo across two packages (studio and web). On the studio package it works absolutely fine, but on the web package it doesn't seem to be working at all and I get the above error.

The web package is using NextJS so perhaps I'm missing something. I've tried all manor of things to get it working like adding parsing options, babel configs, etc, but nothing seems to work.

I was wondering if I was missing something? I made the repo public below...

https://github.com/Modular-Everything/UEFA

Edit: I'm just noticing that the linting is working, but only in certain files. Editing sanity.js I get the linting errors, but the error mentioned in the title comes from editing index.js

[react] set `parserOptions.jsxPragma` to `null` if React17+without TS

CRA depends on eslint-plugin-testing-library@^3.9.2

The latest release of eslint-config-galex bumps eslint-plugin-testing-library to version 3.10.0, which is incompatible with react-scripts v4.0. As a result, I'm getting the following error:

Definition for rule 'testing-library/no-await-sync-events' was not found testing-library/no-await-sync-events

I'm using NPM so I can't yet override module resolutions.

feat: add incremental adoption flag

• everything thats warn is off
• everthing thats error is warn

createConfig({
  incrementalAdoption: true
})

disable slow rules

import/no-useless-path-segments ~ 25%
import/no-cycle ~ 14%
import/no-extraneous-dependencies ~ 13%
import/no-self-import ~ 11%

consider disabling the following aswell:
@typescript-eslint/no-confusing-void-expression ~ 4%
@typescript-eslint/no-floating-promises ~ 2%

disable @typescript-eslint/unbound-method

reports plenty of false positives with custom hooks

new-cap rule should be disabled by default if TS decorators are enabled

new-cap rule should be disabled by default if TS decorators are enabled

Trouble using with Create React App

I have a React app bootstrapped with Create React App. I added this eslint config as per the instructions.
Upon running running eslint on the src directory, I got a lot of errors on files that come by default from CRA (eg.: serviceWorker.ts).

How should this be handled? I tried adding react-app to the extensions in the eslint config, but it introduced additional problems and in the end it did not help.

add storybook override

see https://github.com/silx-kit/h5web/blob/master/.eslintrc.js#L87

Activate prefer-array-find & no-object-as-default-parameter

https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/no-object-as-default-parameter.md
https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/prefer-array-find.md

evaluate eslint-plugin-eslint-comments

https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules

disable no-void

conflicts with no-floating-promises or whatever its called and voiding those should be allowed

bug: avoid adding similar overrides multiple times

right now, adding a react override will lead to this order:

• react override
• ts override
• others
• ...custom

this can lead to issues if you want to configure react rules in a TS react project, as the order is still important - the final react override will take precedence over the default TS override, which results in an error because of a missing parser for @typescript-eslint/eslint-plugin

if each createXYOverride would be uniquely identifiyable internally we could filter overrides before adding customOverrides and maintain the same order

support ignorePatterns

kinda missing it in createConfig and any createXYOverride

allow injecting module globals into create functions too

e.g.

const env = {
  jest: true,
};

const extendsConfig = ['plugin:jest-formatting/strict'];
const files = ['**/*.?(test|spec).?(ts|js)?(x)'];
const parserOptions = {
  ecmaVersion: 2020,
};

const settings = {
  jest: {
    version: 'detect',
  },
};

/**
 * @param {{
 *  hasJestDom: boolean;
 *  hasJest: boolean;
 *  hasTestingLibrary: boolean;
 *  react: {
 *    hasReact: boolean;
 *  };
 *  typescript: {
 *    hasTypeScript: boolean;
 *  };
 *  customRules?: Record<string, string | [string, string | object];
 * }} options
 */
const createJestOverride = ({
  hasJestDom,
  hasJest,
  hasTestingLibrary,
  react,
  typescript,
  // these bad boys here
  customExtends,
  customEnv,
  customSettings,
  // ^^^^^^^
  customRules = {},
}) => {
  // ...
  return {
    env: customEnv ?? env,
  }
}

perf: set off to 0; filter 0

[jest] disable rules

  ...(hasReact ? { 'react/button-has-type': 'off' } : null),
  ...(hasReact ? { 'jsx-a11y/control-has-associated-label': 'off' } : null),
  'require-unicode-regexp': 'off',
  'no-param-reassign': 'off',

`eslint-plugin-regexp`

Just came across this plugin: https://github.com/ota-meshi/eslint-plugin-regexp -- might be a good one to add to the list!

`eslint-plugin-eslint-comments`

https://github.com/mysticatea/eslint-plugin-eslint-comments

update unicorn/prefer-number-properties

https://github.com/ljosberinn/eslint-config-galex/blob/master/src/rulesets/unicorn.js#L390

should probably be

  'unicorn/prefer-number-properties': ['warn', { checkInfinity: false }],

and there should be a test for it

env.node is false in react

should default to: project.react.hasReact || true since react may want to access process.env

`mergeSortOverrides` does not check whether `files` property of custom overrides is identical to internals

... leading to merging e.g.

const generatedGqlOverride = createTSOverride({
  ...deps,
  rules: {
    "@typescript-eslint/explicit-module-boundary-types": "off",
    "import/no-namespace": "off",
  },
  files: ["generated/*.tsx"],
});

into the general tsOverride which deactivates these rules globally

Support `>=` syntax in dependency versions

fulfillsVersionRequirement('>=17', { major: 17 }) returns false instead of true.

support Next v11 eslint-config-next

see #362

• support rule changes
• maybe add next.config.js
• maybe add info about peer deps

Eval eslint plugin storybook

https://github.com/storybookjs/eslint-plugin-storybook

Use recommended options for "jsx-a11y/no-noninteractive-element-to-interactive-role"

At the moment, the rule is set to error without any options. The idea is to allow things like <ul role="menu" />, which is valid ARIA markup, as explained here: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-element-to-interactive-role.md#rule-details .

Migrate to TS

kinda wanna ship types and definitely dont want to sync jsdoc comments across the codebase

next version (not necessarily major)

• move to typescript. will be tough and there are some typing issues technically present. at the very least use // @ts-check everywhere
• a standalone UI to create a config? 🤔 esp. relevant for those that are unfamiliar with the eslint config schema and how overrides work
• add CLI capability to statically generate a config (including recommended postinstall step e.g.)

allow numbers in @typescript-eslint/restrict-template-expressions

allowNumbers: true

explore @kyleshevlin/prefer-custom-hooks

https://github.com/kyleshevlin/eslint-plugin

re-evaluate perf of import/no-cycle

keep import-js/eslint-plugin-import#2061 in mind

@typescript-eslint/no-unnecessary-condition requires strictNullChecks

0:1 warning This rule requires the strictNullChecks compiler option to be turned on to function correctly @typescript-eslint/no-unnecessary-condition

try solving by passing down the tsconfig through getDependencies

enable reportUnusedDisableDirectives

see https://eslint.org/docs/user-guide/command-line-interface#options

[Bug]: move `createJestConfigOverride` to top level overrides

right now its inactive since its scoped as override for jestOverride.files pattern which doesnt apply to the jestConfigOverride.files in the first place

improve nextjs override

see https://github.com/ljosberinn/personal-react-boilerplate/blob/master/.eslintrc.js#L17

Add `/` marker to spaced-comment config

In CRA, there's a file called react-app-env.d.ts with a triple-slash comment:

I believe spaced-comment can be configured as such to remove the warning:

"spaced-comment": ["error", "always", { "markers": ["/"] }]

conditionally activate unicorn/prefer-top-level-await

only active if:

• typescript found
• `['system', 'esnext'].includes(tsConfig.compilerOptions.module) && tsConfig.compilerOptions.target => es2017

set sonarjs/no-ignored-return to error

add @next/eslint-plugin-next

https://github.com/vercel/next.js/tree/canary/packages/eslint-plugin-next

Configuration for rule "@typescript-eslint/ban-ts-comment" is invalid

Hey, I'm getting the following error when launching eslint through the command line:

$ npx eslint src --fix
.eslintrc.js#overrides[1]:
        Configuration for rule "@typescript-eslint/ban-ts-comment" is invalid:
        Value "allow-with-description" should be boolean.

This seems to stop the linting completely. I thought manually overriding the rule should help, but it doesn't:

module.exports = {
  extends: 'galex',
  rules: {
    '@typescript-eslint/ban-ts-comment': 0,
  },
};

consider rushstack/eslint-patch

https://github.com/microsoft/rushstack/blob/master/stack/eslint-patch/README.md

Enable more eslint-plugin-react rules

https://github.com/yannickcr/eslint-plugin-react/tree/master/docs/rules

Incompatible with create-react-app due to outdated dependencies

• requires manual ESLint installation
• import/no-cycle may not have a configuration

[react] @babel/eslint-parser expects presence of babel.config.js

solve by:

if project is CRA:

• adding babel presets of CRA

if project is Next:

• next/babel if next is present

otherwise:

• try to detect babel.config.js / .babelrc / babel.config.json
• if missing, warn

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

evaluate `ts.parseJsonConfigFileContent` over current impl

@typescript-eslint/non-nullable-type-assertion-style conflicts with other rule

The code below in my codebase triggers a warning suggesting I use ! instead of as Entity. The warning comes from this rule: @typescript-eslint/non-nullable-type-assertion-style.

if (childCache.has(path)) {
  return childCache.get(path) as Entity;
}

However, when I make the change, I get an error because of rule @typescript-eslint/no-non-null-assertion. I personally prefer the casting to be explicit -- ! can easily be missed -- so I would recommend disabling @typescript-eslint/non-nullable-type-assertion-style.

create example folders