@zendeskgarden/eslint-config 34.0.0 → 36.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/eslint-config",
-  "version": "34.0.0",
+  "version": "36.0.0",
   "description": "Garden ESLint config",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -19,31 +19,31 @@
     "lint": "eslint index.js plugins/*.js rules/*.js --max-warnings 0",
     "prepare": "husky install",
     "tag": "[ `git rev-parse --abbrev-ref HEAD` = 'main' ] && standard-version --no-verify",
-    "test": "yarn lint && yarn format && git diff --quiet"
+    "test": "npm run format && npm run lint && git diff --quiet"
   },
   "peerDependencies": {
     "@babel/eslint-parser": "^7.15.0",
-    "eslint": "^8.29.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-node": "^11.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.22.9",
-    "@babel/eslint-parser": "7.22.9",
-    "@typescript-eslint/eslint-plugin": "6.1.0",
-    "@typescript-eslint/parser": "6.1.0",
-    "eslint": "8.45.0",
-    "eslint-plugin-jest": "27.2.3",
-    "eslint-plugin-jsx-a11y": "6.7.1",
+    "@babel/core": "7.23.6",
+    "@babel/eslint-parser": "7.23.3",
+    "@typescript-eslint/eslint-plugin": "6.15.0",
+    "@typescript-eslint/parser": "6.15.0",
+    "eslint": "8.56.0",
+    "eslint-plugin-jest": "27.6.0",
+    "eslint-plugin-jsx-a11y": "6.8.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-notice": "0.9.10",
-    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",
     "husky": "8.0.3",
-    "jest": "29.6.1",
+    "jest": "29.7.0",
     "prettier-package-json": "2.8.0",
     "react": "18.2.0",
     "standard-version": "9.5.0",
-    "typescript": "5.1.6"
+    "typescript": "5.3.3"
   },
   "keywords": [
     "eslint",

package/plugins/typescript-semantics.js

@@ -6,8 +6,8 @@
  */
 
 const bestPractices = require('../rules/best-practices').rules;
+const es6 = require('../rules/es6').rules;
 const possibleErrors = require('../rules/possible-errors').rules;
-const stylisticIssues = require('../rules/stylistic-issues').rules;
 
 module.exports = {
   plugins: ['@typescript-eslint'],
@@ -15,18 +15,15 @@ module.exports = {
   rules: {
     // Disable ESLint rules that are handled by TypeScript
     'dot-notation': 0,
-    'key-spacing': 0,
     'no-implied-eval': 0,
-    'no-return-await': 0,
     'no-throw-literal': 0,
+    'prefer-destructuring': 0,
     'require-await': 0,
 
     // disallows awaiting a value that is not a `Thenable`
     '@typescript-eslint/await-thenable': 2,
     // enforce dot notation whenever possible
     '@typescript-eslint/dot-notation': bestPractices['dot-notation'],
-    // enforce consistent spacing between keys and values in object literal properties
-    '@typescript-eslint/key-spacing': stylisticIssues['key-spacing'],
     // requires that `.toString()` is only called on objects which provide useful information when stringified
     '@typescript-eslint/no-base-to-string': 2,
     // requires expressions of type void to appear in statement position
@@ -68,8 +65,14 @@ module.exports = {
     '@typescript-eslint/no-unsafe-member-access': 2,
     // disallows returning any from a function
     '@typescript-eslint/no-unsafe-return': 2,
+    // require unary negation to take a number
+    '@typescript-eslint/no-unsafe-unary-minus': 2,
+    // disallow unnecessary template literals
+    '@typescript-eslint/no-useless-template-literals': 2,
     // prefers a non-null assertion over explicit type cast when possible
     '@typescript-eslint/non-nullable-type-assertion-style': 1,
+    // require destructuring from arrays and/or objects
+    '@typescript-eslint/prefer-destructuring': es6['prefer-destructuring'],
     // enforce includes method over `indexOf` method
     '@typescript-eslint/prefer-includes': 2,
     // enforce the usage of the nullish coalescing operator instead of logical chaining
@@ -96,8 +99,6 @@ module.exports = {
     '@typescript-eslint/restrict-plus-operands': 2,
     // enforce template literal expressions to be of string type
     '@typescript-eslint/restrict-template-expressions': 2,
-    // enforces consistent returning of awaited values
-    '@typescript-eslint/return-await': bestPractices['no-return-await'],
     // restricts the types allowed in boolean expressions
     '@typescript-eslint/strict-boolean-expressions': 1,
     // exhaustiveness checking in switch with union type

package/plugins/typescript.js

@@ -16,25 +16,18 @@ module.exports = {
   parser: '@typescript-eslint/parser',
   rules: {
     // Disable ESLint rules that are handled by TypeScript
-    'brace-style': 0,
-    'comma-dangle': 0,
-    'comma-spacing': 0,
+    'class-methods-use-this': 0,
     'constructor-super': 0,
     'default-param-last': 0,
-    'func-call-spacing': 0,
     'getter-return': 0,
-    'indent': 0,
     'init-declarations': 0,
     'keyword-spacing': 0,
-    'lines-between-class-members': 0,
     'no-array-constructor': 0,
     'no-const-assign': 0,
     'no-dupe-args': 0,
     'no-dupe-class-members': 0,
     'no-dupe-keys': 0,
     'no-empty-function': 0,
-    'no-extra-parens': 0,
-    'no-extra-semi': 0,
     'no-func-assign': 0,
     'no-import-assign': 0,
     'no-invalid-this': 0,
@@ -55,11 +48,6 @@ module.exports = {
     'no-unsafe-negation': 0,
     'no-unused-expressions': 0,
     'no-unused-vars': 0,
-    'object-curly-spacing': 0,
-    'quotes': 0,
-    'semi': 0,
-    'space-before-function-paren': 0,
-    'space-infix-ops': 0,
     'valid-typeof': 0,
 
     // require that member overloads be consecutive
@@ -72,14 +60,11 @@ module.exports = {
     '@typescript-eslint/ban-tslint-comment': 1,
     // bans specific types from being used
     '@typescript-eslint/ban-types': 2,
-    // enforce consistent brace style for blocks
-    '@typescript-eslint/brace-style': stylisticIssues['brace-style'],
     // ensures that literals on classes are exposed in a consistent style
     '@typescript-eslint/class-literal-property-style': 2,
-    // require or disallow trailing comma
-    '@typescript-eslint/comma-dangle': stylisticIssues['comma-dangle'],
-    // enforces consistent spacing before and after commas
-    '@typescript-eslint/comma-spacing': stylisticIssues['comma-spacing'],
+    // enforce that class methods utilize `this`
+    '@typescript-eslint/class-methods-use-this':
+      bestPractices['class-methods-use-this'],
     // enforce or disallow the use of the record type
     '@typescript-eslint/consistent-indexed-object-style': 2,
     // enforces consistent usage of type assertions
@@ -100,18 +85,10 @@ module.exports = {
     ],
     // require explicit return and argument types on exported functions' and classes' public class methods
     '@typescript-eslint/explicit-module-boundary-types': 2,
-    // require or disallow spacing between function identifiers and their invocations
-    '@typescript-eslint/func-call-spacing':
-      stylisticIssues['func-call-spacing'],
-    // enforce consistent indentation
-    '@typescript-eslint/indent': stylisticIssues.indent,
     // require or disallow initialization in variable declarations
     '@typescript-eslint/init-declarations': variables['init-declarations'],
     // enforce consistent spacing before and after keywords
     '@typescript-eslint/keyword-spacing': stylisticIssues['keyword-spacing'],
-    // require or disallow an empty line between class members
-    '@typescript-eslint/lines-between-class-members':
-      stylisticIssues['lines-between-class-members'],
     // require a specific member delimiter style for interfaces and type literals
     '@typescript-eslint/member-delimiter-style': 2,
     // require a consistent member declaration order
@@ -153,10 +130,6 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 2,
     // disallow extra non-null assertion
     '@typescript-eslint/no-extra-non-null-assertion': 2,
-    // disallow unnecessary parentheses
-    '@typescript-eslint/no-extra-parens': possibleErrors['no-extra-parens'],
-    // disallow unnecessary semicolons
-    '@typescript-eslint/no-extra-semi': possibleErrors['no-extra-semi'],
     // forbids the use of classes as namespaces
     '@typescript-eslint/no-extraneous-class': 2,
     // disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean
@@ -212,9 +185,6 @@ module.exports = {
     '@typescript-eslint/no-useless-constructor': es6['no-useless-constructor'],
     // disallows the use of require statements except in import statements
     '@typescript-eslint/no-var-requires': 2,
-    // enforce consistent spacing inside braces
-    '@typescript-eslint/object-curly-spacing':
-      stylisticIssues['object-curly-spacing'],
     // prefer usage of `as const` over literal type
     '@typescript-eslint/prefer-as-const': 2,
     // prefer initializing each enums member value
@@ -231,15 +201,6 @@ module.exports = {
     '@typescript-eslint/prefer-optional-chain': 0,
     // recommends using `@ts-expect-error` over `@ts-ignore`
     '@typescript-eslint/prefer-ts-expect-error': 2,
-    // enforce the consistent use of either backticks, double, or single quotes
-    '@typescript-eslint/quotes': stylisticIssues.quotes,
-    // require or disallow semicolons instead of ASI
-    '@typescript-eslint/semi': stylisticIssues.semi,
-    // enforces consistent spacing before function parenthesis
-    '@typescript-eslint/space-before-function-paren':
-      stylisticIssues['space-before-function-paren'],
-    // ensure there are spaces around infix operators
-    '@typescript-eslint/space-infix-ops': stylisticIssues['space-infix-ops'],
     // sets preference level for triple slash directives versus ES6-style import declarations
     '@typescript-eslint/triple-slash-reference': 2,
     // require consistent spacing around type annotations

package/rules/best-practices.js

@@ -27,8 +27,6 @@ module.exports = {
     'default-case-last': 2,
     // enforce default parameters to be last
     'default-param-last': 2,
-    // enforces consistent newlines before or after dots
-    'dot-location': [2, 'property'],
     // encourages use of dot notation whenever possible
     'dot-notation': [2, { allowKeywords: true }],
     // require the use of `===` and `!==`
@@ -69,8 +67,6 @@ module.exports = {
     'no-extra-label': 2,
     // disallow fallthrough of `case` statements
     'no-fallthrough': 2,
-    // disallow the use of leading or trailing decimal points in numeric literals
-    'no-floating-decimal': 2,
     // disallow assignments to native objects or read-only global variables
     'no-global-assign': 2,
     // disallow the type conversions with shorter notations
@@ -91,8 +87,6 @@ module.exports = {
     'no-loop-func': 2,
     // disallow the use of magic numbers
     'no-magic-numbers': 0,
-    // disallow use of multiple spaces
-    'no-multi-spaces': 2,
     // disallow use of multiline strings
     'no-multi-str': 2,
     // disallow use of `new` operator when not part of the assignment or comparison
@@ -119,8 +113,6 @@ module.exports = {
     'no-restricted-properties': 0,
     // disallow use of assignment in `return` statement
     'no-return-assign': 2,
-    // disallow unnecessary `return await`
-    'no-return-await': 2,
     // disallow use of `javascript:` urls.
     'no-script-url': 2,
     // disallow assignments where both sides are exactly the same
@@ -170,8 +162,6 @@ module.exports = {
     'require-unicode-regexp': 2,
     // requires to declare all vars on top of their containing scope
     'vars-on-top': 2,
-    // require immediate function invocation to be wrapped in parentheses
-    'wrap-iife': [2, 'any'],
     // require or disallow Yoda conditions
     'yoda': 2
   }

package/rules/es6.js

@@ -9,18 +9,10 @@ module.exports = {
   rules: {
     // require braces in arrow function body
     'arrow-body-style': 0,
-    // require parens in arrow function arguments
-    'arrow-parens': [2, 'as-needed'],
-    // require space before/after arrow function's arrow
-    'arrow-spacing': 2,
     // verify calls of `super()` in constructors
     'constructor-super': 2,
-    // enforce the spacing around the `*` in generator functions
-    'generator-star-spacing': 0,
     // disallow modifying variables of class declarations
     'no-class-assign': 0,
-    // disallow arrow functions where they could be confused with comparisons
-    'no-confusing-arrow': 2,
     // disallow modifying variables that are declared using `const`
     'no-const-assign': 2,
     // disallow duplicate name in class members
@@ -61,15 +53,9 @@ module.exports = {
     'prefer-template': 2,
     // disallow generator functions that do not have `yield`
     'require-yield': 0,
-    // enforce spacing between rest and spread operators and their expressions
-    'rest-spread-spacing': 2,
     // sort import declarations within module
     'sort-imports': 1,
     // require symbol descriptions
-    'symbol-description': 2,
-    // enforce spacing around embedded expressions of template strings
-    'template-curly-spacing': [2, 'never'],
-    // enforce spacing around the `*` in `yield*` expressions
-    'yield-star-spacing': [2, 'after']
+    'symbol-description': 2
   }
 };

package/rules/possible-errors.js

@@ -43,10 +43,6 @@ module.exports = {
     'no-ex-assign': 2,
     // disallow double-negation boolean casts in a boolean context
     'no-extra-boolean-cast': 2,
-    // disallow unnecessary parentheses
-    'no-extra-parens': [2, 'functions'],
-    // disallow unnecessary semicolons
-    'no-extra-semi': 2,
     // disallow overwriting functions written as function declarations
     'no-func-assign': 2,
     // disallow assigning to imported bindings

package/rules/stylistic-issues.js

@@ -7,83 +7,32 @@
 
 module.exports = {
   rules: {
-    // enforce linebreaks after opening and before closing array brackets
-    'array-bracket-newline': [2, 'consistent'],
-    // enforce spacing inside array brackets
-    'array-bracket-spacing': [2, 'never'],
-    // enforce line breaks after each array element
-    'array-element-newline': 0,
-    // disallow or enforce spaces inside of single line blocks
-    'block-spacing': [2, 'always'],
-    // enforce one true brace style
-    'brace-style': [2, '1tbs', { allowSingleLine: true }],
     // require camel case names
     'camelcase': [2, { properties: 'never' }],
     // enforce or disallow capitalization of the first letter of a comment
     'capitalize-comments': 0,
-    // disallow or enforce trailing commas
-    'comma-dangle': 2,
-    // enforce spacing before and after comma
-    'comma-spacing': [2, {
-      before: false,
-      after: true
-    }],
-    // enforce one true comma style
-    'comma-style': [2, 'last'],
-    // require or disallow padding inside computed properties
-    'computed-property-spacing': [2, 'never'],
     // enforces consistent naming when capturing the current execution context
     'consistent-this': [0, 'self'],
-    // enforce newline at the end of file, with no multiple empty lines
-    'eol-last': 2,
-    // require or disallow spacing between function identifiers and their invocations
-    'func-call-spacing': 2,
     // require function names to match the name of the variable or property to which they are assigned
     'func-name-matching': 2,
     // require function expressions to have a name
     'func-names': 1,
     // enforce use of function declarations or expressions
     'func-style': 0,
-    // enforce line breaks between arguments of a function call
-    'function-call-argument-newline': [2, 'consistent'],
-    // enforce consistent line breaks inside function parentheses
-    'function-paren-newline': 2,
     // disallow specified identifiers
     'id-denylist': 0,
     // this option enforces minimum and maximum identifier lengths (variable names, property names etc.)
     'id-length': 0,
     // require identifiers to match the provided regular expression
     'id-match': 0,
-    // enforce the location of arrow function bodies with implicit returns
-    'implicit-arrow-linebreak': 2,
-    // this option sets a specific tab width for your code
-    'indent': [2, 2, { SwitchCase: 1 }],
-    // specify whether double or single quotes should be used in JSX attributes
-    'jsx-quotes': 0,
-    // enforces spacing between keys and values in object literal properties
-    'key-spacing': [2, {
-      beforeColon: false,
-      afterColon: true
-    }],
     // enforce spacing before and after keywords
     'keyword-spacing': 2,
     // enforce position of line comments
     'line-comment-position': 0,
-    // disallow mixed 'LF' and 'CRLF' as linebreaks
-    'linebreak-style': 0,
-    // enforces empty lines around comments
-    'lines-around-comment': 0,
-    // require or disallow an empty line between class members
-    'lines-between-class-members': 2,
     // require or disallow logical assignment logical operator shorthand
     'logical-assignment-operators': 2,
     // specify the maximum depth that blocks can be nested
     'max-depth': [0, 4],
-    // specify the maximum length of a line in your program
-    'max-len': [1, 80, 2, {
-      ignoreComments: true,
-      ignoreUrls: true
-    }],
     // enforce a maximum number of lines per file
     'max-lines': 0,
     // enforce a maximum number of line of code in a function
@@ -94,18 +43,10 @@ module.exports = {
     'max-params': [0, 3],
     // specify the maximum number of statement allowed in a function
     'max-statements': [0, 10],
-    // specify the maximum number of statements allowed per line
-    'max-statements-per-line': [2, { max: 1 }],
     // enforce a particular style for multiline comments
     'multiline-comment-style': 0,
-    // enforce newlines between operands of ternary expressions
-    'multiline-ternary': 0,
     // require a capital letter for constructors
     'new-cap': [2, { newIsCap: true }],
-    // disallow the omission of parentheses when invoking a constructor with no arguments
-    'new-parens': 2,
-    // enforce newline after each call when chaining the calls
-    'newline-per-chained-call': 0,
     // disallow use of the `Array` constructor
     'no-array-constructor': 2,
     // disallow use of bitwise operators
@@ -116,130 +57,39 @@ module.exports = {
     'no-inline-comments': 0,
     // disallow `if` as the only statement in an `else` block
     'no-lonely-if': 2,
-    // disallow mixed binary operators
-    'no-mixed-operators': 2,
-    // disallow mixed spaces and tabs for indentation
-    'no-mixed-spaces-and-tabs': 2,
     // disallow use of chained assignment expressions
     'no-multi-assign': 2,
-    // disallow multiple empty lines
-    'no-multiple-empty-lines': [2, { max: 2 }],
     // disallow negated conditions
     'no-negated-condition': 2,
     // disallow nested ternary expressions
     'no-nested-ternary': 2,
-    // disallow use of the `Object` constructor
-    'no-new-object': 2,
+    // disallow calls to the `Object` constructor without an argument
+    'no-object-constructor': 2,
     // disallow use of unary operators, `++` and `--`
     'no-plusplus': 0,
     // disallow use of certain syntax in code
     'no-restricted-syntax': 0,
-    // disallow all tabs
-    'no-tabs': 2,
     // disallow the use of ternary operators
     'no-ternary': 0,
-    // disallow trailing whitespace at the end of lines
-    'no-trailing-spaces': 2,
     // disallow dangling underscores in identifiers
     'no-underscore-dangle': 0,
     // disallow the use of `Boolean` literals in conditional expressions
     'no-unneeded-ternary': 2,
-    // disallow whitespace before properties
-    'no-whitespace-before-property': 2,
-    // enforce the location of single-line statements
-    'nonblock-statement-body-position': 2,
-    // enforce consistent line breaks inside braces
-    'object-curly-newline': 0,
-    // require or disallow padding inside curly braces
-    'object-curly-spacing': [2, 'always'],
-    // enforce placing object properties on separate lines
-    'object-property-newline': 2,
     // allow just one var statement per function
     'one-var': [2, 'never'],
-    // require or disallow an newline around variable declarations
-    'one-var-declaration-per-line': [2, 'initializations'],
     // require assignment operator shorthand where possible or prohibit it entirely
     'operator-assignment': 0,
-    // enforce operators to be placed before or after line breaks
-    'operator-linebreak': [2, 'after'],
-    // enforce padding within blocks
-    'padded-blocks': [2, { blocks: 'never' }],
-    // require or disallow padding lines between statements
-    'padding-line-between-statements': [1,
-      {
-        blankLine: 'always',
-        prev: 'directive',
-        next: '*'
-      },
-      {
-        blankLine: 'any',
-        prev: 'directive',
-        next: 'directive'
-      },
-      {
-        blankLine: 'always',
-        prev: ['const', 'let', 'var'],
-        next: '*'
-      },
-      {
-        blankLine: 'any',
-        prev: ['const', 'let', 'var'],
-        next: ['const', 'let', 'var']
-      },
-      {
-        blankLine: 'always',
-        prev: '*',
-        next: 'return'
-      }],
     // disallow the use of `Math.pow` in favor of the `**` operator
     'prefer-exponentiation-operator': 1,
     // disallow use of `Object.prototype.hasOwnProperty.call()` and prefer use of `Object.hasOwn()`
     'prefer-object-has-own': 1,
     // prefer use of an object spread over `Object.assign`
     'prefer-object-spread': 1,
-    // require quotes around object literal property names
-    'quote-props': [2, 'consistent-as-needed'],
-    // specify whether double or single quotes should be used
-    'quotes': [2, 'single', 'avoid-escape'],
-    // require or disallow use of semicolons instead of ASI
-    'semi': [2, 'always'],
-    // enforce spacing before and after semicolons
-    'semi-spacing': [2, {
-      before: false,
-      after: true
-    }],
-    // enforce location of semicolons
-    'semi-style': 2,
     // require object keys to be sorted
     'sort-keys': 0,
     // sort variables within the same declaration block
     'sort-vars': 0,
-    // require or disallow space before blocks
-    'space-before-blocks': 2,
-    // require or disallow space before function opening parenthesis
-    'space-before-function-paren': [2, {
-      anonymous: 'never',
-      named: 'never',
-      asyncArrow: 'always'
-    }],
-    // require or disallow spaces inside parentheses
-    'space-in-parens': 2,
-    // require spaces around operators
-    'space-infix-ops': 2,
-    // Require or disallow spaces before/after unary operators
-    'space-unary-ops': 0,
-    // require or disallow a space immediately following the `//` or `/*` in a comment
-    'spaced-comment': [2, 'always', {
-      exceptions: ['-', '+'],
-      markers: ['=', '!'] // space here to support sprockets directives
-    }],
-    // enforce spacing around colons of switch statements
-    'switch-colon-spacing': 2,
-    // require or disallow spacing between template tags and their literals
-    'template-tag-spacing': 2,
     // require or disallow Unicode byte order mark (BOM)
-    'unicode-bom': 2,
-    // require regex literals to be wrapped in parentheses
-    'wrap-regex': 0
+    'unicode-bom': 2
   }
 };