JSPM

  • Created
  • Published
  • Downloads 177
  • Score
    100M100P100Q74244F
  • License MIT

A super strict eslint config for linting js/ts/package.json.

Package Exports

  • @fenge/eslint-config

Readme

@fenge/eslint-config

PRs Welcome

A strict eslint config preset containing a comprehensive set of rules for linting js / ts / package.json files. Based on standard.js without any stylistic opinions.

Feature

  • Lint js / mjs / cjs / jsx / ts / mts / cts / tsx / package.json files only.
  • Strict. More than 300+ rules.
  • Highly customizable by omitting unwanted.
  • Type safe. TypeScript friendly.
  • Pure JavaScript project friendly.
  • React friendly.
  • NestJS friendly.
  • Based on standard.js, introduced more stricter rules.
  • Have no stylistic opinions. Prettier friendly.
  • Respect .gitignore.
  • ESLint Flat config, compose easily!
  • Modern. ESM first.
  • One-line of config.

Usage

Install it in the root of js / ts project.

npm install -D eslint @fenge/eslint-config

Config eslint.config.js (for ESM).

export { default } from "@fenge/eslint-config";

If you are in CommonJS, config eslint.config.js bellow:

module.exports = import("@fenge/eslint-config");

Config package.json

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Note: TypeScript project is required a tsconfig.json file in the root.

Advanced Usage

Config Builder

You can use Builder class to customize for selecting or omitting some rules.

import { Builder } from "@fenge/eslint-config";

export default new Builder()
  .enablePackagejson({
    pick: ["packagejson/top-types"], // only these rules will work for package.json files
  })
  .enableJavascript({
    omit: ["no-var"], // these rules will not work for js files
  })
  .enableTypescript({
    // apply additional rules or override the built-in rules for ts files
    append: {
      "@typescript-eslint/no-explicit-any": "error",
      "@typescript-eslint/consistent-type-assertions": [
        "error",
        { assertionStyle: "never" },
      ],
      "@typescript-eslint/no-non-null-assertion": "error",
    },
  })
  .toConfig();

License

MIT