@landmineaknpm/soluta-adipisci-nobis NPM

eslint-define-config

Provide a defineConfig function for .eslintrc.js, and a defineFlatConfig function for eslint.config.js files.

Installation

# add eslint and eslint-define-config to project’s dev dependencies
npm add --save-dev eslint eslint-define-config
# or
yarn add --dev eslint eslint-define-config
# or
pnpm add --save-dev eslint eslint-define-config

Usage

By default only eslint's rules are supported. To activate auto-suggestions for Rules of specific plugins, you need to install the respective types for that plugin.
Plugins can either support their own types, or they could be supported by the community in the @eslint-types repository.

A list of community supported plugins can be found here.

.eslintrc.js

// @ts-check
const { defineConfig } = require('eslint-define-config');

/// <reference types="@eslint-types/typescript-eslint" />

module.exports = defineConfig({
  root: true,
  rules: {
    // rules...
  },
});

Flat Config

eslint.config.js

// @ts-check
const { defineFlatConfig } = require('eslint-define-config');

/// <reference types="@eslint-types/typescript-eslint" />

module.exports = defineFlatConfig([
  'eslint:recommended',
  {
    plugins: {
      // plugins...
    },
    rules: {
      // rules...
    },
  },
]);

Why?

Improve your eslint configuration experience with:

auto-suggestions
type checking (Use // @ts-check at the first line in your .eslintrc.js or eslint.config.js)
documentation
deprecation warnings

Video

Click on the thumbnail to play the video

Want to support your own plugin?

:warning: This feature is very new and requires the support of the respective plugin owners

Add a declare module to your plugin package like this:

declare module 'eslint-define-config' {
  export interface CustomRuleOptions {
    /**
     * Require consistently using either `T[]` or `Array<T>` for arrays.
     *
     * @see [array-type](https://typescript-eslint.io/rules/array-type)
     */
    '@typescript-eslint/array-type': [
      {
        default?: 'array' | 'generic' | 'array-simple';
        readonly?: 'array' | 'generic' | 'array-simple';
      },
    ];

    // ... more Rules
  }
}

There are other interfaces that can be extended.

CustomExtends
CustomParserOptions
CustomParsers
CustomPlugins
CustomSettings

Credits

Proposal Idea
Vite and Evan You for the idea
@antfu and his tweet

env __proto__classes findup settings Iterator private data guid Underscore ESnext pose javascript validator contains css less assign console ES2019 structuredClone shrinkwrap writable format visual xss node regexp assertion tty syntax rangeerror side spinners process fast-deep-clone classname callbind character superagent less css parser es2018 callback xhr Array typed obj patch generics rfc4122 property make utilities starter prop fantasy-land Object yup stringify ECMAScript 6 css variable number weakset dir Set getintrinsic sameValueZero logging WeakSet less runtime util.inspect key style indicator bdd wordwrap chromium TypeScript ArrayBuffer from width ts censor xterm isConcatSpreadable up RegExp#flags buffers deep-clone watchFile bundler equality properties optimist random hardlinks findLast idle api Object.fromEntries RFC-6455 regular copy walk signals ArrayBuffer#slice parent ES2015 real-time pnpm9 tester dataView redux full phone asserts serializer BigUint64Array command bluebird cli core mobile sanitization traverse workspace:*last coercible hash transpiler pure require lesscss RxJS wget mocha redux-toolkit fast-deep-copy web match flags Microsoft Array.prototype.filter column chrome korean function http call-bind es7 iterate setPrototypeOf find-up ES8 getOwnPropertyDescriptor moment ES2020 fast-copy 6to5 negative Function.prototype.name colors less.js merge fsevents serialization spring cors babel-core graphql ponyfill vest JSON 3d link cjk tostringtag es rapid functions wordbreak mru es-shim API limit es5 streams2 compile less remove utility 256 schema map concat irq emit limited exit progress iteration command-line shell task connect groupBy Promise transpile stateless byteLength spinner minimal zero symlink bootstrap less StyleSheet glob hooks unicode drop sanitize tdd bind object serialize argument getter ECMAScript 2018 operating-system installer bundling string regex JSON-Schema RegExp.prototype.flags scheme lockfile characters io-ts polyfill Int32Array URLSearchParams description commander filter path less compiler setImmediate regular expressions .env promise figlet utils ajax request telephone es2017 crypt value callbound iterator toStringTag data typanion const jsonschema redact folder https nodejs stdlib styled-components escape ava array es-shims entries query estree validation ansi eslint-plugin readablestream encryption Uint16Array every emoji preprocessor banner awesomesauce user-streams yaml trimRight dependency manager util stable art handlers jsonpath jwt rm -rf typedarray ReactiveExtensions express values internal slot weakmap worker framer Object.entries prefix enumerable events gradients css3 qs String.prototype.matchAll typesafe react-hooks ReactiveX less mixins group flatMap watching watch positive scheme-validation variables in css invariant toArray multi-package name ECMAScript 2015 url point-free gradients css es8 ES5 define modules picomatch module linewrap full-width make dir fs ajv Reflect.getPrototypeOf dataview functional getopt await symbol consume mime Map warning whatwg names ECMAScript 2022 forEach codes Uint8ClampedArray waapi bound read fast fast-clone ES7 tc39 toolkit dependencies trimLeft defineProperty debugger windows prototype concurrency optimizer ECMAScript 2017 Array.prototype.findLastIndex take parents WeakMap package manager prune write hookform wait slice browserlist datastructure tslib rm -fr pyyaml import protocol-buffers tacit popmotion mixins Object.assign Observables internal validate styling bcrypt code points call-bound eslintconfig variables _.extend safe Object.defineProperty lazy computed-types sigterm time terminal efficient Stream browser URL trimStart language karma YAML readable listeners ECMAScript 2023 ECMAScript 2016 jasmine file system Array.prototype.findLast logger es2015 i18n slot once lru nope joi shim json-schema ECMAScript 5 touch deepcopy rmdir includes autoprefixer arktype dom-testing-library jQuery Observable eslint watcher queueMicrotask call helpers -0 stringifier immer getPrototypeOf HyBi configurable typeerror regular expression formatting wrap lint async columns extension throttle fetch shebang extend deepclone a11y trim electron exec CSSStyleDeclaration Object.values negative zero descriptor ender check Float64Array WebSocket matches ECMAScript 2020 busy babel testing

@ryniaubenpm/esse-repellat-excepturi @zibuthe7j11/deserunt-quasi-impedit @zibuthe7j11/vel-impedit-modi

1.0.0

16 days ago