Configurations Reference

Following the ESLint conventions for sharing configurations, each of the configurations are named with a different prefix to indicate what kind of configuration it is.

Each configuration might consist of 1 or more sub configurations. Each of the tables below contains information about what rules have been configured for each sub configuration and for what files.

Some of the rules have URL links to documentation; you can click on the name of the rule to see the associated documentation page.

Dynamic Loading

This page is actually dynamically created based on the configuration objects exported by the Lint plugin alongside some clever Vue magic

This does mean that some of the configurations might have weird names as they are directly loaded from the recommended configurations provided from plugins.

js/recommended Configuration

SA Recommended Javascript Configuration > ExtendedConfig[0]

• Applies to:
  • **/*.*js
  • **/*.ts
  • **/*.tsx

• Plugins Required:

  • @stylistic/eslint-plugin
• Rules

  Rule	Severity	Options
  @stylistic/array-bracket-spacing	error	[ "never" ]
  @stylistic/arrow-parens	error	[ "as-needed", { "requireForBlockBody": true } ]
  @stylistic/arrow-spacing	error	[ { "after": true, "before": true } ]
  @stylistic/block-spacing	error	[ "always" ]
  @stylistic/brace-style	error	[ "stroustrup", { "allowSingleLine": true } ]
  @stylistic/comma-dangle	error	[ "always-multiline" ]
  @stylistic/comma-spacing	error	[ { "after": true, "before": false } ]
  @stylistic/comma-style	error	[ "last" ]
  @stylistic/computed-property-spacing	error	[ "never", { "enforceForClassMembers": true } ]
  @stylistic/dot-location	error	[ "property" ]
  @stylistic/eol-last	error
  @stylistic/generator-star-spacing	error	[ { "after": true, "before": false } ]
  @stylistic/indent	error	[ 2, { "ArrayExpression": 1, "CallExpression": { "arguments": 1 }, "flatTernaryExpressions": false, "FunctionDeclaration": { "body": 1, "parameters": 1, "returnType": 1 }, "FunctionExpression": { "body": 1, "parameters": 1, "returnType": 1 }, "ignoreComments": false, "ignoredNodes": [ "TSUnionType", "TSIntersectionType" ], "ImportDeclaration": 1, "MemberExpression": 1, "ObjectExpression": 1, "offsetTernaryExpressions": true, "outerIIFEBody": 1, "SwitchCase": 1, "tabLength": 2, "VariableDeclarator": 1 } ]
  @stylistic/indent-binary-ops	error	[ 2 ]
  @stylistic/key-spacing	error	[ { "afterColon": true, "beforeColon": false } ]
  @stylistic/keyword-spacing	error	[ { "after": true, "before": true } ]
  @stylistic/lines-between-class-members	error	[ "always", { "exceptAfterSingleLine": true } ]
  @stylistic/max-statements-per-line	error	[ { "max": 1 } ]
  @stylistic/member-delimiter-style	error	[ { "multiline": { "delimiter": "none", "requireLast": false }, "multilineDetection": "brackets", "overrides": { "interface": { "multiline": { "delimiter": "none", "requireLast": false } } }, "singleline": { "delimiter": "comma" } } ]
  @stylistic/multiline-ternary	error	[ "always-multiline" ]
  @stylistic/new-parens	error
  @stylistic/no-extra-parens	error	[ "functions" ]
  @stylistic/no-floating-decimal	error
  @stylistic/no-mixed-operators	error	[ { "allowSamePrecedence": true, "groups": [ [ "==", "!=", "===", "!==", ">", ">=", "<", "<=" ], [ "&&", "||" ], [ "in", "instanceof" ] ] } ]
  @stylistic/no-mixed-spaces-and-tabs	error
  @stylistic/no-multi-spaces	error
  @stylistic/no-multiple-empty-lines	error	[ { "max": 1, "maxBOF": 0, "maxEOF": 0 } ]
  @stylistic/no-tabs	error
  @stylistic/no-trailing-spaces	error
  @stylistic/no-whitespace-before-property	error
  @stylistic/object-curly-spacing	error	[ "always" ]
  @stylistic/operator-linebreak	error	[ "before" ]
  @stylistic/padded-blocks	error	[ { "blocks": "never", "classes": "never", "switches": "never" } ]
  @stylistic/quote-props	error	[ "consistent-as-needed" ]
  @stylistic/quotes	error	[ "single", { "allowTemplateLiterals": "always", "avoidEscape": false } ]
  @stylistic/rest-spread-spacing	error	[ "never" ]
  @stylistic/semi	error	[ "never" ]
  @stylistic/semi-spacing	error	[ { "after": true, "before": false } ]
  @stylistic/space-before-blocks	error	[ "always" ]
  @stylistic/space-before-function-paren	error	[ { "anonymous": "always", "asyncArrow": "always", "named": "never" } ]
  @stylistic/space-in-parens	error	[ "never" ]
  @stylistic/space-infix-ops	error
  @stylistic/space-unary-ops	error	[ { "nonwords": false, "words": true } ]
  @stylistic/spaced-comment	error	[ "always", { "block": { "balanced": true, "exceptions": [ "*" ], "markers": [ "!" ] }, "line": { "exceptions": [ "/", "#" ], "markers": [ "/" ] } } ]
  @stylistic/template-curly-spacing	error
  @stylistic/template-tag-spacing	error	[ "never" ]
  @stylistic/type-annotation-spacing	error	[ {} ]
  @stylistic/type-generic-spacing	error
  @stylistic/type-named-tuple-spacing	error
  @stylistic/wrap-iife	error	[ "any", { "functionPrototypeMethods": true } ]
  @stylistic/yield-star-spacing	error	[ { "after": true, "before": false } ]
  @stylistic/jsx-closing-bracket-location	error
  @stylistic/jsx-closing-tag-location	error
  @stylistic/jsx-curly-brace-presence	error	[ { "propElementValues": "always" } ]
  @stylistic/jsx-curly-newline	error
  @stylistic/jsx-curly-spacing	error	[ "never" ]
  @stylistic/jsx-equals-spacing	error
  @stylistic/jsx-first-prop-new-line	error
  @stylistic/jsx-function-call-newline	error	[ "multiline" ]
  @stylistic/jsx-indent-props	error	[ 2 ]
  @stylistic/jsx-max-props-per-line	error	[ { "maximum": 1, "when": "multiline" } ]
  @stylistic/jsx-one-expression-per-line	error	[ { "allow": "single-child" } ]
  @stylistic/jsx-quotes	error
  @stylistic/jsx-tag-spacing	error	[ { "afterOpening": "never", "beforeClosing": "never", "beforeSelfClosing": "always", "closingSlash": "never" } ]
  @stylistic/jsx-wrap-multilines	error	[ { "arrow": "parens-new-line", "assignment": "parens-new-line", "condition": "parens-new-line", "declaration": "parens-new-line", "logical": "parens-new-line", "prop": "parens-new-line", "propertyValue": "parens-new-line", "return": "parens-new-line" } ]

SA Recommended Javascript Configuration

• Applies to:
  • **/*.*js
  • **/*.ts
  • **/*.tsx

• Plugins Required:

  • import
  • @sourceacademy
• Rules

  Rule	Severity	Options
  import/first	warn
  import/newline-after-import	warn
  import/no-cycle	error
  import/no-duplicates	warn	[ { "prefer-inline": false } ]
  import/no-useless-path-segments	error
  import/order	warn	[ { "groups": [ "builtin", "external", "internal", "parent", "sibling", "index" ], "named": { "import": true, "types": "types-last" }, "alphabetize": { "order": "asc", "orderImportKind": "asc" } } ]
  no-empty	error	[ { "allowEmptyCatch": true } ]
  @sourceacademy/default-import-name	warn	[ { "path": "pathlib" } ]
  @sourceacademy/region-comment	error
  @stylistic/brace-style	warn	[ "1tbs", { "allowSingleLine": true } ]
  @stylistic/function-call-spacing	warn	[ "never" ]
  @stylistic/function-paren-newline	warn	[ "multiline-arguments" ]
  @stylistic/nonblock-statement-body-position	error	[ "beside" ]
  @stylistic/object-curly-newline	warn	[ { "ImportDeclaration": { "multiline": true } } ]
  @stylistic/object-curly-spacing	warn	[ "always" ]
  @stylistic/quotes	warn	[ "single", { "avoidEscape": true } ]
  @stylistic/semi	warn	[ "always" ]

Rules for cjs files

• Applies to:
  • **/*.cjs
• Rules

  Rule	Severity	Options
  @typescript-eslint/no-require-imports	off

jsdoc/recommended Configuration

jsdoc/recommended

• Applies to:
  • **/*.*js
  • **/*.ts
  • **/*.tsx

• Plugins Required:

  • jsdoc
• Rules

  Rule	Severity	Options
  jsdoc/check-alignment	warn
  jsdoc/require-asterisk-prefix	warn

jsdoc/recommended

• Applies to:
  • **/*.ts
  • **/*.tsx
• Rules

  Rule	Severity	Options
  jsdoc/no-types	warn

md/recommended Configuration

Markdown Files > markdown/recommended

• Applies to:
  • [ "**/*.md", "**/*.md" ]

• Plugins Required:

  • @eslint/markdown
• Rules

  Rule	Severity	Options
  markdown/fenced-code-language	error
  markdown/heading-increment	error
  markdown/no-duplicate-definitions	error
  markdown/no-empty-definitions	error
  markdown/no-empty-images	error
  markdown/no-empty-links	error
  markdown/no-invalid-label-refs	error
  markdown/no-missing-atx-heading-space	error
  markdown/no-missing-label-refs	error
  markdown/no-missing-link-fragments	error
  markdown/no-multiple-h1	error
  markdown/no-reference-like-urls	error
  markdown/no-reversed-media-syntax	error
  markdown/no-space-in-emphasis	error
  markdown/no-unused-definitions	error
  markdown/require-alt-text	error
  markdown/table-column-count	error

Markdown Files

• Applies to:
  • **/*.md

• Plugins Required:

  • @eslint/markdown
• Rules

  Rule	Severity	Options
  markdown/no-missing-label-refs	off
  markdown/no-multiple-h1	off
  markdown/require-alt-text	off

style/recommended Configuration

style/recommended

• Applies to:
• Ignores: [ "**/*.md" ]

• Plugins Required:

  • @stylistic/eslint-plugin
• Rules

  Rule	Severity	Options
  @stylistic/eol-last	warn
  @stylistic/indent	warn	[ 2, { "SwitchCase": 1 } ]
  @stylistic/no-mixed-spaces-and-tabs	warn
  @stylistic/no-multiple-empty-lines	warn	[ { "max": 1, "maxEOF": 0 } ]
  @stylistic/no-multi-spaces	warn	[ { "ignoreEOLComments": true } ]
  @stylistic/no-trailing-spaces	warn
  @stylistic/spaced-comment	warn	[ "always", { "markers": [ "TODO", "TODOS", "TODO WIP", "FIXME", "WIP", "NOTE", "NOTES", "LIST" ] } ]

ts/recommended Configuration

Global Typescript Rules__typescript-eslint/base

• Applies to:
  • **/*.{ts,tsx}

• Plugins Required:

  • @typescript-eslint/eslint-plugin

• This configuration has no rules.

Global Typescript Rules__typescript-eslint/eslint-recommended

• Applies to:
  • **/*.{ts,tsx}
• Rules

  Rule	Severity	Options
  constructor-super	off
  getter-return	off
  no-class-assign	off
  no-const-assign	off
  no-dupe-args	off
  no-dupe-class-members	off
  no-dupe-keys	off
  no-func-assign	off
  no-import-assign	off
  no-new-native-nonconstructor	off
  no-new-symbol	off
  no-obj-calls	off
  no-redeclare	off
  no-setter-return	off
  no-this-before-super	off
  no-undef	off
  no-unreachable	off
  no-unsafe-negation	off
  no-var	error
  no-with	off
  prefer-const	error
  prefer-rest-params	error
  prefer-spread	error

Global Typescript Rules__typescript-eslint/recommended

• Applies to:
  • **/*.{ts,tsx}
• Rules

  Rule	Severity	Options
  @typescript-eslint/ban-ts-comment	error
  no-array-constructor	off
  @typescript-eslint/no-array-constructor	error
  @typescript-eslint/no-duplicate-enum-values	error
  @typescript-eslint/no-empty-object-type	error
  @typescript-eslint/no-explicit-any	error
  @typescript-eslint/no-extra-non-null-assertion	error
  @typescript-eslint/no-misused-new	error
  @typescript-eslint/no-namespace	error
  @typescript-eslint/no-non-null-asserted-optional-chain	error
  @typescript-eslint/no-require-imports	error
  @typescript-eslint/no-this-alias	error
  @typescript-eslint/no-unnecessary-type-constraint	error
  @typescript-eslint/no-unsafe-declaration-merging	error
  @typescript-eslint/no-unsafe-function-type	error
  no-unused-expressions	off
  @typescript-eslint/no-unused-expressions	error
  no-unused-vars	off
  @typescript-eslint/no-unused-vars	error
  @typescript-eslint/no-wrapper-object-types	error
  @typescript-eslint/prefer-as-const	error
  @typescript-eslint/prefer-namespace-keyword	error
  @typescript-eslint/triple-slash-reference	error

Global Typescript Rules

• Applies to:
  • **/*.{ts,tsx}

• Plugins Required:

  • @typescript-eslint/eslint-plugin
• Rules

  Rule	Severity	Options
  no-unused-vars	off
  jsdoc/no-types	warn
  @stylistic/type-annotation-spacing	warn	[ { "overrides": { "colon": { "before": false, "after": true } } } ]
  @typescript-eslint/ban-ts-comment	error
  @typescript-eslint/ban-types	off
  @typescript-eslint/no-duplicate-type-constituents	off
  @typescript-eslint/no-explicit-any	off
  @typescript-eslint/no-import-type-side-effects	error
  @typescript-eslint/no-redundant-type-constituents	off
  @typescript-eslint/no-unused-vars	warn	[ { "argsIgnorePattern": "^_" } ]

tsx/recommended Configuration

SA TSX Config > ExtendedConfig[0]

• Applies to:
  • **/*.tsx

• Plugins Required:

  • react
• Rules

  Rule	Severity	Options
  react/display-name	error
  react/jsx-key	error
  react/jsx-no-comment-textnodes	error
  react/jsx-no-duplicate-props	error
  react/jsx-no-target-blank	error
  react/jsx-no-undef	error
  react/jsx-uses-react	error
  react/jsx-uses-vars	error
  react/no-children-prop	error
  react/no-danger-with-children	error
  react/no-deprecated	error
  react/no-direct-mutation-state	error
  react/no-find-dom-node	error
  react/no-is-mounted	error
  react/no-render-return-value	error
  react/no-string-refs	error
  react/no-unescaped-entities	error
  react/no-unknown-property	error
  react/no-unsafe	off
  react/prop-types	error
  react/react-in-jsx-scope	error
  react/require-render-return	error

SA TSX Config > ExtendedConfig[1]

• Applies to:
  • **/*.tsx

• Plugins Required:

  • react
• Rules

  Rule	Severity	Options
  react/react-in-jsx-scope	off
  react/jsx-uses-react	off

SA TSX Config

• Applies to:
  • **/*.tsx

• Plugins Required:

  • eslint-plugin-react-hooks
  • react
• Rules

  Rule	Severity	Options
  react-hooks/rules-of-hooks	error
  react/jsx-key	off
  react/prefer-stateless-function	warn
  react/prop-types	off
  @stylistic/jsx-equals-spacing	warn	[ "never" ]
  @stylistic/jsx-indent-props	warn	[ 2 ]
  @stylistic/jsx-props-no-multi-spaces	warn
  @stylistic/jsx-self-closing-comp	warn

vitest/recommended Configuration

SA Recommended Vitest Config > vitest/recommended

• Applies to:
  • **/__tests__/**/*.ts*
  • **/__mocks__/**/*.ts*
  • **/vitest.*.ts

• Plugins Required:

  • vitest
• Rules

  Rule	Severity	Options
  vitest/expect-expect	error
  vitest/no-commented-out-tests	error
  vitest/no-conditional-expect	error
  vitest/no-disabled-tests	warn
  vitest/no-focused-tests	error
  vitest/no-identical-title	error
  vitest/no-import-node-test	error
  vitest/no-interpolation-in-snapshots	error
  vitest/no-mocks-import	error
  vitest/no-standalone-expect	error
  vitest/no-unneeded-async-expect-function	error
  vitest/prefer-called-exactly-once-with	error
  vitest/require-local-test-context-for-concurrent-snapshots	error
  vitest/valid-describe-callback	error
  vitest/valid-expect	error
  vitest/valid-expect-in-promise	error
  vitest/valid-title	error

SA Recommended Vitest Config

• Applies to:
  • **/__tests__/**/*.ts*
  • **/__mocks__/**/*.ts*
  • **/vitest.*.ts

• Plugins Required:

  • vitest
• Rules

  Rule	Severity	Options
  no-empty-pattern	off
  @stylistic/quotes	off
  vitest/expect-expect	error	[ { "assertFunctionNames": [ "expect*" ] } ]
  vitest/no-alias-methods	off
  vitest/no-conditional-expect	off
  vitest/no-export	off
  vitest/no-focused-tests	warn	[ { "fixable": false } ]
  vitest/require-top-level-describe	off
  vitest/prefer-hooks-on-top	warn
  vitest/valid-describe-callback	off
  vitest/valid-expect-in-promise	error
  import/extensions	error	[ "never", { "config": "ignore" } ]