Skip to main content

Module: @sapphire/eslint-config

References

default

Renames and re-exports eslintConfig

Variables

eslintConfig

โ€ข eslintConfig: Object

Default ESLint configuration for Sapphire Communitys

example

{
"extends": "@sapphire"
}

Type declaration

NameType
envObject
env.browserboolean
env.commonjsboolean
env.es2017boolean
env.es2020boolean
env.es6boolean
env.jestboolean
env.nodeboolean
extendsstring[]
parserstring
parserOptionsObject
parserOptions.ecmaVersionnumber
parserOptions.extraFileExtensionsstring[]
parserOptions.projectstring
parserOptions.sourceTypestring
parserOptions.warnOnUnsupportedTypeScriptVersionboolean
rootboolean
rulesObject
rules.@typescript-eslint/adjacent-overload-signaturesstring
rules.@typescript-eslint/array-typestring
rules.@typescript-eslint/await-thenablestring
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-stylestring
rules.@typescript-eslint/consistent-type-definitionsstring
rules.@typescript-eslint/default-param-laststring
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-typestring
rules.@typescript-eslint/explicit-member-accessibilitystring
rules.@typescript-eslint/explicit-module-boundary-typesstring
rules.@typescript-eslint/init-declarationsstring
rules.@typescript-eslint/member-ordering(string | { default: string[] })[]
rules.@typescript-eslint/no-base-to-stringstring
rules.@typescript-eslint/no-dupe-class-membersstring
rules.@typescript-eslint/no-duplicate-imports(string | { includeExports: boolean = false })[]
rules.@typescript-eslint/no-empty-interfacestring
rules.@typescript-eslint/no-explicit-anystring
rules.@typescript-eslint/no-extra-non-null-assertionstring
rules.@typescript-eslint/no-extraneous-classstring
rules.@typescript-eslint/no-floating-promisesstring
rules.@typescript-eslint/no-for-in-arraystring
rules.@typescript-eslint/no-implied-evalstring
rules.@typescript-eslint/no-invalid-thisstring
rules.@typescript-eslint/no-invalid-void-typestring
rules.@typescript-eslint/no-misused-newstring
rules.@typescript-eslint/no-namespacestring
rules.@typescript-eslint/no-non-null-asserted-optional-chainstring
rules.@typescript-eslint/no-non-null-assertionstring
rules.@typescript-eslint/no-throw-literalstring
rules.@typescript-eslint/no-unnecessary-boolean-literal-comparestring
rules.@typescript-eslint/no-unnecessary-qualifierstring
rules.@typescript-eslint/no-unsafe-assignmentstring
rules.@typescript-eslint/no-unsafe-callstring
rules.@typescript-eslint/no-unsafe-member-accessstring
rules.@typescript-eslint/no-unsafe-returnstring
rules.@typescript-eslint/no-unused-varsstring
rules.@typescript-eslint/no-use-before-definestring
rules.@typescript-eslint/no-useless-constructorstring
rules.@typescript-eslint/no-var-requiresstring
rules.@typescript-eslint/prefer-as-conststring
rules.@typescript-eslint/prefer-for-ofstring
rules.@typescript-eslint/prefer-includesstring
rules.@typescript-eslint/prefer-reduce-type-parameterstring
rules.@typescript-eslint/prefer-string-starts-ends-withstring
rules.@typescript-eslint/promise-function-asyncstring
rules.@typescript-eslint/require-awaitstring
rules.@typescript-eslint/restrict-plus-operandsstring
rules.@typescript-eslint/switch-exhaustiveness-checkstring
rules.@typescript-eslint/unbound-methodstring
rules.@typescript-eslint/unified-signaturesstring
rules.accessor-pairsstring
rules.array-callback-returnstring
rules.block-scoped-varstring
rules.callback-returnstring
rules.capitalized-commentsstring
rules.class-methods-use-thisstring
rules.complexitystring
rules.consistent-returnstring
rules.consistent-thisstring[]
rules.constructor-superstring
rules.default-casestring
rules.dot-notationstring
rules.eqeqeqstring[]
rules.for-directionstring
rules.func-name-matchingstring[]
rules.func-namesstring[]
rules.func-stylestring
rules.global-requirestring
rules.guard-for-instring
rules.handle-callback-errstring
rules.id-blackliststring
rules.id-lengthstring
rules.id-matchstring
rules.init-declarationsstring
rules.line-comment-positionstring
rules.lines-between-class-members(string | { exceptAfterSingleLine: boolean = true })[]
rules.max-depthstring
rules.max-linesstring
rules.max-nested-callbacksstring
rules.max-paramsstring
rules.max-statementsstring
rules.max-statements-per-line(string | { max: number = 1 })[]
rules.multiline-comment-stylestring
rules.new-capstring
rules.no-alertstring
rules.no-array-constructorstring
rules.no-await-in-loopstring
rules.no-bitwisestring
rules.no-buffer-constructorstring
rules.no-callerstring
rules.no-case-declarationsstring
rules.no-catch-shadowstring
rules.no-class-assignstring
rules.no-compare-neg-zerostring
rules.no-cond-assignstring
rules.no-consolestring
rules.no-const-assignstring
rules.no-constant-conditionstring
rules.no-control-regexstring
rules.no-debuggerstring
rules.no-delete-varstring
rules.no-div-regexstring
rules.no-dupe-argsstring
rules.no-dupe-class-membersstring
rules.no-dupe-keysstring
rules.no-duplicate-casestring
rules.no-duplicate-importsstring
rules.no-else-returnstring
rules.no-emptystring
rules.no-empty-character-classstring
rules.no-empty-functionstring
rules.no-empty-patternstring
rules.no-eq-nullstring
rules.no-evalstring
rules.no-ex-assignstring
rules.no-extend-nativestring
rules.no-extra-bindstring
rules.no-extra-boolean-caststring
rules.no-extra-labelstring
rules.no-fallthroughstring
rules.no-func-assignstring
rules.no-global-assignstring
rules.no-implicit-coercionstring
rules.no-implicit-globalsstring
rules.no-implied-evalstring
rules.no-import-assignstring
rules.no-inline-commentsstring
rules.no-inner-declarationsstring
rules.no-invalid-regexpstring
rules.no-invalid-thisstring
rules.no-irregular-whitespace(string | { skipComments: boolean = true; skipRegExps: boolean = true; skipStrings: boolean = true; skipTemplates: boolean = true })[]
rules.no-iteratorstring
rules.no-label-varstring
rules.no-labelsstring
rules.no-lone-blocksstring
rules.no-lonely-ifstring
rules.no-loop-funcstring
rules.no-magic-numbersstring
rules.no-mixed-requiresstring
rules.no-multi-assignstring
rules.no-multi-strstring
rules.no-negated-conditionstring
rules.no-nested-ternarystring
rules.no-newstring
rules.no-new-funcstring
rules.no-new-objectstring
rules.no-new-requirestring
rules.no-new-symbolstring
rules.no-new-wrappersstring
rules.no-obj-callsstring
rules.no-octalstring
rules.no-octal-escapestring
rules.no-param-reassignstring
rules.no-path-concatstring
rules.no-plusplusstring
rules.no-process-envstring
rules.no-process-exitstring
rules.no-protostring
rules.no-prototype-builtinsstring
rules.no-redeclarestring
rules.no-regex-spacesstring
rules.no-restricted-globalsstring
rules.no-restricted-importsstring
rules.no-restricted-modulesstring
rules.no-restricted-propertiesstring
rules.no-restricted-syntaxstring
rules.no-return-assignstring
rules.no-return-awaitstring
rules.no-script-urlstring
rules.no-self-assignstring
rules.no-self-comparestring
rules.no-setter-returnstring
rules.no-shadowstring
rules.no-shadow-restricted-namesstring
rules.no-sparse-arraysstring
rules.no-syncstring
rules.no-template-curly-in-stringstring
rules.no-ternarystring
rules.no-this-before-superstring
rules.no-throw-literalstring
rules.no-undefstring
rules.no-undef-initstring
rules.no-undefinedstring
rules.no-underscore-danglestring
rules.no-unmodified-loop-conditionstring
rules.no-unneeded-ternarystring
rules.no-unreachablestring
rules.no-unsafe-finallystring
rules.no-unsafe-negationstring
rules.no-unused-expressionsstring
rules.no-unused-labelsstring
rules.no-unused-varsstring
rules.no-use-before-definestring
rules.no-useless-callstring
rules.no-useless-computed-keystring
rules.no-useless-concatstring
rules.no-useless-constructorstring
rules.no-useless-escapestring
rules.no-useless-renamestring
rules.no-useless-returnstring
rules.no-varstring
rules.no-voidstring
rules.no-warning-commentsstring
rules.no-withstring
rules.object-shorthandstring[]
rules.one-varstring[]
rules.operator-assignmentstring[]
rules.padding-line-between-statementsstring
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-literalsstring
rules.prefer-promise-reject-errorsstring
rules.prefer-rest-paramsstring
rules.prefer-spreadstring
rules.prefer-templatestring
rules.radixstring
rules.require-awaitstring
rules.require-jsdocstring
rules.require-yieldstring
rules.sort-importsstring
rules.sort-keysstring
rules.sort-varsstring
rules.spaced-commentstring[]
rules.strictstring[]
rules.symbol-descriptionstring
rules.use-isnanstring
rules.valid-jsdocstring
rules.valid-typeofstring
rules.vars-on-topstring
rules.yodastring

Defined in

projects/utilities/packages/eslint-config/src/index.ts:10