Module: eslint-config/src
Variables
eslintConfig
• Const eslintConfig: Object
Standard ESLint config for the Sapphire Community
example
{
"extends": "@sapphire"
}
Type declaration
| Name | Type |
|---|---|
env | { browser: boolean = true; commonjs: boolean = true; es2017: boolean = true; es2020: boolean = true; es6: boolean = true; jest: boolean = true; node: boolean = true } |
env.browser | boolean |
env.commonjs | boolean |
env.es2017 | boolean |
env.es2020 | boolean |
env.es6 | boolean |
env.jest | boolean |
env.node | boolean |
extends | string[] |
parser | string |
parserOptions | { ecmaVersion: number = 2020; extraFileExtensions: string[] ; project: string = './tsconfig.eslint.json'; sourceType: string = 'module'; warnOnUnsupportedTypeScriptVersion: boolean = false } |
parserOptions.ecmaVersion | number |
parserOptions.extraFileExtensions | string[] |
parserOptions.project | string |
parserOptions.sourceType | string |
parserOptions.warnOnUnsupportedTypeScriptVersion | boolean |
root | boolean |
rules | { @typescript-eslint/adjacent-overload-signatures: string = 'error'; @typescript-eslint/array-type: string = 'off'; @typescript-eslint/await-thenable: string = 'off'; @typescript-eslint/ban-ts-comment: (string | { minimumDescriptionLength: number = 3; ts-check: boolean = true; ts-expect-error: string = 'allow-with-description'; ts-ignore: string = 'allow-with-description'; ts-nocheck: boolean = true })[] ; @typescript-eslint/class-literal-property-style: string = 'error'; @typescript-eslint/consistent-type-definitions: string = 'error'; @typescript-eslint/default-param-last: string = 'error'; @typescript-eslint/dot-notation: (string | { allowKeywords: boolean = true; allowPattern: string = '(^[A-Z])|(^[a-z]+(_[a-z]+)+$)'; allowPrivateClassPropertyAccess: boolean = true })[] ; @typescript-eslint/explicit-function-return-type: string = 'off'; @typescript-eslint/explicit-member-accessibility: string = 'error'; @typescript-eslint/explicit-module-boundary-types: string = 'off'; @typescript-eslint/init-declarations: string = 'off'; @typescript-eslint/member-ordering: (string | { default: string[] })[] ; @typescript-eslint/no-base-to-string: string = 'error'; @typescript-eslint/no-dupe-class-members: string = 'error'; @typescript-eslint/no-duplicate-imports: (string | { includeExports: boolean = false })[] ; @typescript-eslint/no-empty-interface: string = 'off'; @typescript-eslint/no-explicit-any: string = 'off'; @typescript-eslint/no-extra-non-null-assertion: string = 'error'; @typescript-eslint/no-extraneous-class: string = 'error'; @typescript-eslint/no-floating-promises: string = 'error'; @typescript-eslint/no-for-in-array: string = 'error'; @typescript-eslint/no-implied-eval: string = 'error'; @typescript-eslint/no-invalid-this: string = 'error'; @typescript-eslint/no-invalid-void-type: string = 'error'; @typescript-eslint/no-misused-new: string = 'error'; @typescript-eslint/no-namespace: string = 'off'; @typescript-eslint/no-non-null-asserted-optional-chain: string = 'error'; @typescript-eslint/no-non-null-assertion: string = 'off'; @typescript-eslint/no-throw-literal: string = 'error'; @typescript-eslint/no-unnecessary-boolean-literal-compare: string = 'error'; @typescript-eslint/no-unnecessary-qualifier: string = 'error'; @typescript-eslint/no-unsafe-assignment: string = 'off'; @typescript-eslint/no-unsafe-call: string = 'off'; @typescript-eslint/no-unsafe-member-access: string = 'off'; @typescript-eslint/no-unsafe-return: string = 'off'; @typescript-eslint/no-unused-vars: string = 'off'; @typescript-eslint/no-use-before-define: string = 'off'; @typescript-eslint/no-useless-constructor: string = 'error'; @typescript-eslint/no-var-requires: string = 'error'; @typescript-eslint/prefer-as-const: string = 'error'; @typescript-eslint/prefer-for-of: string = 'error'; @typescript-eslint/prefer-includes: string = 'error'; @typescript-eslint/prefer-reduce-type-parameter: string = 'error'; @typescript-eslint/prefer-string-starts-ends-with: string = 'error'; @typescript-eslint/promise-function-async: string = 'off'; @typescript-eslint/require-await: string = 'error'; @typescript-eslint/restrict-plus-operands: string = 'off'; @typescript-eslint/switch-exhaustiveness-check: string = 'warn'; @typescript-eslint/unbound-method: string = 'error'; @typescript-eslint/unified-signatures: string = 'error'; accessor-pairs: string = 'off'; array-callback-return: string = 'error'; block-scoped-var: string = 'error'; callback-return: string = 'off'; capitalized-comments: string = 'off'; class-methods-use-this: string = 'off'; complexity: string = 'off'; consistent-return: string = 'off'; consistent-this: string[] ; constructor-super: string = 'off'; default-case: string = 'off'; dot-notation: string = 'off'; eqeqeq: string[] ; for-direction: string = 'off'; func-name-matching: string[] ; func-names: string[] ; func-style: string = 'off'; global-require: string = 'off'; guard-for-in: string = 'warn'; handle-callback-err: string = 'off'; id-blacklist: string = 'off'; id-length: string = 'off'; id-match: string = 'off'; init-declarations: string = 'off'; line-comment-position: string = 'off'; lines-between-class-members: (string | { exceptAfterSingleLine: boolean = true })[] ; max-depth: string = 'off'; max-lines: string = 'off'; max-nested-callbacks: string = 'off'; max-params: string = 'off'; max-statements: string = 'off'; max-statements-per-line: (string | { max: number = 1 })[] ; multiline-comment-style: string = 'off'; new-cap: string = 'off'; no-alert: string = 'error'; no-array-constructor: string = 'off'; no-await-in-loop: string = 'off'; no-bitwise: string = 'off'; no-buffer-constructor: string = 'error'; no-caller: string = 'error'; no-case-declarations: string = 'error'; no-catch-shadow: string = 'error'; no-class-assign: string = 'warn'; no-compare-neg-zero: string = 'error'; no-cond-assign: string = 'warn'; no-console: string = 'off'; no-const-assign: string = 'error'; no-constant-condition: string = 'off'; no-control-regex: string = 'off'; no-debugger: string = 'error'; no-delete-var: string = 'error'; no-div-regex: string = 'off'; no-dupe-args: string = 'error'; no-dupe-class-members: string = 'off'; no-dupe-keys: string = 'error'; no-duplicate-case: string = 'error'; no-duplicate-imports: string = 'off'; no-else-return: string = 'warn'; no-empty: string = 'off'; no-empty-character-class: string = 'error'; no-empty-function: string = 'off'; no-empty-pattern: string = 'off'; no-eq-null: string = 'warn'; no-eval: string = 'warn'; no-ex-assign: string = 'off'; no-extend-native: string = 'warn'; no-extra-bind: string = 'off'; no-extra-boolean-cast: string = 'off'; no-extra-label: string = 'warn'; no-fallthrough: string = 'off'; no-func-assign: string = 'off'; no-global-assign: string = 'off'; no-implicit-coercion: string = 'error'; no-implicit-globals: string = 'off'; no-implied-eval: string = 'off'; no-import-assign: string = 'warn'; no-inline-comments: string = 'off'; no-inner-declarations: string = 'off'; no-invalid-regexp: string = 'warn'; no-invalid-this: string = 'off'; no-irregular-whitespace: (string | { skipComments: boolean = true; skipRegExps: boolean = true; skipStrings: boolean = true; skipTemplates: boolean = true })[] ; no-iterator: string = 'off'; no-label-var: string = 'error'; no-labels: string = 'off'; no-lone-blocks: string = 'off'; no-lonely-if: string = 'error'; no-loop-func: string = 'off'; no-magic-numbers: string = 'off'; no-mixed-requires: string = 'error'; no-multi-assign: string = 'warn'; no-multi-str: string = 'error'; no-negated-condition: string = 'warn'; no-nested-ternary: string = 'off'; no-new: string = 'off'; no-new-func: string = 'warn'; no-new-object: string = 'error'; no-new-require: string = 'error'; no-new-symbol: string = 'warn'; no-new-wrappers: string = 'warn'; no-obj-calls: string = 'warn'; no-octal: string = 'error'; no-octal-escape: string = 'error'; no-param-reassign: string = 'off'; no-path-concat: string = 'warn'; no-plusplus: string = 'off'; no-process-env: string = 'off'; no-process-exit: string = 'off'; no-proto: string = 'off'; no-prototype-builtins: string = 'off'; no-redeclare: string = 'off'; no-regex-spaces: string = 'warn'; no-restricted-globals: string = 'off'; no-restricted-imports: string = 'off'; no-restricted-modules: string = 'off'; no-restricted-properties: string = 'off'; no-restricted-syntax: string = 'off'; no-return-assign: string = 'off'; no-return-await: string = 'warn'; no-script-url: string = 'off'; no-self-assign: string = 'error'; no-self-compare: string = 'warn'; no-setter-return: string = 'warn'; no-shadow: string = 'off'; no-shadow-restricted-names: string = 'error'; no-sparse-arrays: string = 'warn'; no-sync: string = 'off'; no-template-curly-in-string: string = 'error'; no-ternary: string = 'off'; no-this-before-super: string = 'error'; no-throw-literal: string = 'off'; no-undef: string = 'off'; no-undef-init: string = 'off'; no-undefined: string = 'off'; no-underscore-dangle: string = 'off'; no-unmodified-loop-condition: string = 'off'; no-unneeded-ternary: string = 'off'; no-unreachable: string = 'warn'; no-unsafe-finally: string = 'warn'; no-unsafe-negation: string = 'error'; no-unused-expressions: string = 'off'; no-unused-labels: string = 'error'; no-unused-vars: string = 'off'; no-use-before-define: string = 'off'; no-useless-call: string = 'off'; no-useless-computed-key: string = 'error'; no-useless-concat: string = 'warn'; no-useless-constructor: string = 'off'; no-useless-escape: string = 'off'; no-useless-rename: string = 'error'; no-useless-return: string = 'warn'; no-var: string = 'error'; no-void: string = 'off'; no-warning-comments: string = 'off'; no-with: string = 'error'; object-shorthand: string[] ; one-var: string[] ; operator-assignment: string[] ; padding-line-between-statements: string = 'off'; prefer-const: (string | { destructuring: string = 'all' })[] ; prefer-destructuring: (string | { AssignmentExpression: { array: boolean = true; object: boolean = false } ; VariableDeclarator: { array: boolean = false; object: boolean = true } })[] ; prefer-numeric-literals: string = 'off'; prefer-promise-reject-errors: string = 'error'; prefer-rest-params: string = 'warn'; prefer-spread: string = 'error'; prefer-template: string = 'warn'; radix: string = 'error'; require-await: string = 'off'; require-jsdoc: string = 'off'; require-yield: string = 'warn'; sort-imports: string = 'off'; sort-keys: string = 'off'; sort-vars: string = 'off'; spaced-comment: string[] ; strict: string[] ; symbol-description: string = 'warn'; use-isnan: string = 'error'; valid-jsdoc: string = 'off'; valid-typeof: string = 'error'; vars-on-top: string = 'off'; yoda: string = 'error' } |
rules.@typescript-eslint/adjacent-overload-signatures | string |
rules.@typescript-eslint/array-type | string |
rules.@typescript-eslint/await-thenable | string |
rules.@typescript-eslint/ban-ts-comment | (string | { minimumDescriptionLength: number = 3; ts-check: boolean = true; ts-expect-error: string = 'allow-with-description'; ts-ignore: string = 'allow-with-description'; ts-nocheck: boolean = true })[] |
rules.@typescript-eslint/class-literal-property-style | string |
rules.@typescript-eslint/consistent-type-definitions | string |
rules.@typescript-eslint/default-param-last | string |
rules.@typescript-eslint/dot-notation | (string | { allowKeywords: boolean = true; allowPattern: string = '(^[A-Z])|(^[a-z]+(_[a-z]+)+$)'; allowPrivateClassPropertyAccess: boolean = true })[] |
rules.@typescript-eslint/explicit-function-return-type | string |
rules.@typescript-eslint/explicit-member-accessibility | string |
rules.@typescript-eslint/explicit-module-boundary-types | string |
rules.@typescript-eslint/init-declarations | string |
rules.@typescript-eslint/member-ordering | (string | { default: string[] })[] |
rules.@typescript-eslint/no-base-to-string | string |
rules.@typescript-eslint/no-dupe-class-members | string |
rules.@typescript-eslint/no-duplicate-imports | (string | { includeExports: boolean = false })[] |
rules.@typescript-eslint/no-empty-interface | string |
rules.@typescript-eslint/no-explicit-any | string |
rules.@typescript-eslint/no-extra-non-null-assertion | string |
rules.@typescript-eslint/no-extraneous-class | string |
rules.@typescript-eslint/no-floating-promises | string |
rules.@typescript-eslint/no-for-in-array | string |
rules.@typescript-eslint/no-implied-eval | string |
rules.@typescript-eslint/no-invalid-this | string |
rules.@typescript-eslint/no-invalid-void-type | string |
rules.@typescript-eslint/no-misused-new | string |
rules.@typescript-eslint/no-namespace | string |
rules.@typescript-eslint/no-non-null-asserted-optional-chain | string |
rules.@typescript-eslint/no-non-null-assertion | string |
rules.@typescript-eslint/no-throw-literal | string |
rules.@typescript-eslint/no-unnecessary-boolean-literal-compare | string |
rules.@typescript-eslint/no-unnecessary-qualifier | string |
rules.@typescript-eslint/no-unsafe-assignment | string |
rules.@typescript-eslint/no-unsafe-call | string |
rules.@typescript-eslint/no-unsafe-member-access | string |
rules.@typescript-eslint/no-unsafe-return | string |
rules.@typescript-eslint/no-unused-vars | string |
rules.@typescript-eslint/no-use-before-define | string |
rules.@typescript-eslint/no-useless-constructor | string |
rules.@typescript-eslint/no-var-requires | string |
rules.@typescript-eslint/prefer-as-const | string |
rules.@typescript-eslint/prefer-for-of | string |
rules.@typescript-eslint/prefer-includes | string |
rules.@typescript-eslint/prefer-reduce-type-parameter | string |
rules.@typescript-eslint/prefer-string-starts-ends-with | string |
rules.@typescript-eslint/promise-function-async | string |
rules.@typescript-eslint/require-await | string |
rules.@typescript-eslint/restrict-plus-operands | string |
rules.@typescript-eslint/switch-exhaustiveness-check | string |
rules.@typescript-eslint/unbound-method | string |
rules.@typescript-eslint/unified-signatures | string |
rules.accessor-pairs | string |
rules.array-callback-return | string |
rules.block-scoped-var | string |
rules.callback-return | string |
rules.capitalized-comments | string |
rules.class-methods-use-this | string |
rules.complexity | string |
rules.consistent-return | string |
rules.consistent-this | string[] |
rules.constructor-super | string |
rules.default-case | string |
rules.dot-notation | string |
rules.eqeqeq | string[] |
rules.for-direction | string |
rules.func-name-matching | string[] |
rules.func-names | string[] |
rules.func-style | string |
rules.global-require | string |
rules.guard-for-in | string |
rules.handle-callback-err | string |
rules.id-blacklist | string |
rules.id-length | string |
rules.id-match | string |
rules.init-declarations | string |
rules.line-comment-position | string |
rules.lines-between-class-members | (string | { exceptAfterSingleLine: boolean = true })[] |
rules.max-depth | string |
rules.max-lines | string |
rules.max-nested-callbacks | string |
rules.max-params | string |
rules.max-statements | string |
rules.max-statements-per-line | (string | { max: number = 1 })[] |
rules.multiline-comment-style | string |
rules.new-cap | string |
rules.no-alert | string |
rules.no-array-constructor | string |
rules.no-await-in-loop | string |
rules.no-bitwise | string |
rules.no-buffer-constructor | string |
rules.no-caller | string |
rules.no-case-declarations | string |
rules.no-catch-shadow | string |
rules.no-class-assign | string |
rules.no-compare-neg-zero | string |
rules.no-cond-assign | string |
rules.no-console | string |
rules.no-const-assign | string |
rules.no-constant-condition | string |
rules.no-control-regex | string |
rules.no-debugger | string |
rules.no-delete-var | string |
rules.no-div-regex | string |
rules.no-dupe-args | string |
rules.no-dupe-class-members | string |
rules.no-dupe-keys | string |
rules.no-duplicate-case | string |
rules.no-duplicate-imports | string |
rules.no-else-return | string |
rules.no-empty | string |
rules.no-empty-character-class | string |
rules.no-empty-function | string |
rules.no-empty-pattern | string |
rules.no-eq-null | string |
rules.no-eval | string |
rules.no-ex-assign | string |
rules.no-extend-native | string |
rules.no-extra-bind | string |
rules.no-extra-boolean-cast | string |
rules.no-extra-label | string |
rules.no-fallthrough | string |
rules.no-func-assign | string |
rules.no-global-assign | string |
rules.no-implicit-coercion | string |
rules.no-implicit-globals | string |
rules.no-implied-eval | string |
rules.no-import-assign | string |
rules.no-inline-comments | string |
rules.no-inner-declarations | string |
rules.no-invalid-regexp | string |
rules.no-invalid-this | string |
rules.no-irregular-whitespace | (string | { skipComments: boolean = true; skipRegExps: boolean = true; skipStrings: boolean = true; skipTemplates: boolean = true })[] |
rules.no-iterator | string |
rules.no-label-var | string |
rules.no-labels | string |
rules.no-lone-blocks | string |
rules.no-lonely-if | string |
rules.no-loop-func | string |
rules.no-magic-numbers | string |
rules.no-mixed-requires | string |
rules.no-multi-assign | string |
rules.no-multi-str | string |
rules.no-negated-condition | string |
rules.no-nested-ternary | string |
rules.no-new | string |
rules.no-new-func | string |
rules.no-new-object | string |
rules.no-new-require | string |
rules.no-new-symbol | string |
rules.no-new-wrappers | string |
rules.no-obj-calls | string |
rules.no-octal | string |
rules.no-octal-escape | string |
rules.no-param-reassign | string |
rules.no-path-concat | string |
rules.no-plusplus | string |
rules.no-process-env | string |
rules.no-process-exit | string |
rules.no-proto | string |
rules.no-prototype-builtins | string |
rules.no-redeclare | string |
rules.no-regex-spaces | string |
rules.no-restricted-globals | string |
rules.no-restricted-imports | string |
rules.no-restricted-modules | string |
rules.no-restricted-properties | string |
rules.no-restricted-syntax | string |
rules.no-return-assign | string |
rules.no-return-await | string |
rules.no-script-url | string |
rules.no-self-assign | string |
rules.no-self-compare | string |
rules.no-setter-return | string |
rules.no-shadow | string |
rules.no-shadow-restricted-names | string |
rules.no-sparse-arrays | string |
rules.no-sync | string |
rules.no-template-curly-in-string | string |
rules.no-ternary | string |
rules.no-this-before-super | string |
rules.no-throw-literal | string |
rules.no-undef | string |
rules.no-undef-init | string |
rules.no-undefined | string |
rules.no-underscore-dangle | string |
rules.no-unmodified-loop-condition | string |
rules.no-unneeded-ternary | string |
rules.no-unreachable | string |
rules.no-unsafe-finally | string |
rules.no-unsafe-negation | string |
rules.no-unused-expressions | string |
rules.no-unused-labels | string |
rules.no-unused-vars | string |
rules.no-use-before-define | string |
rules.no-useless-call | string |
rules.no-useless-computed-key | string |
rules.no-useless-concat | string |
rules.no-useless-constructor | string |
rules.no-useless-escape | string |
rules.no-useless-rename | string |
rules.no-useless-return | string |
rules.no-var | string |
rules.no-void | string |
rules.no-warning-comments | string |
rules.no-with | string |
rules.object-shorthand | string[] |
rules.one-var | string[] |
rules.operator-assignment | string[] |
rules.padding-line-between-statements | string |
rules.prefer-const | (string | { destructuring: string = 'all' })[] |
rules.prefer-destructuring | (string | { AssignmentExpression: { array: boolean = true; object: boolean = false } ; VariableDeclarator: { array: boolean = false; object: boolean = true } })[] |
rules.prefer-numeric-literals | string |
rules.prefer-promise-reject-errors | string |
rules.prefer-rest-params | string |
rules.prefer-spread | string |
rules.prefer-template | string |
rules.radix | string |
rules.require-await | string |
rules.require-jsdoc | string |
rules.require-yield | string |
rules.sort-imports | string |
rules.sort-keys | string |
rules.sort-vars | string |
rules.spaced-comment | string[] |
rules.strict | string[] |
rules.symbol-description | string |
rules.use-isnan | string |
rules.valid-jsdoc | string |
rules.valid-typeof | string |
rules.vars-on-top | string |
rules.yoda | string |