@tanstack/eslint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@tanstack/eslint-config",
+  "version": "0.1.0",
+  "description": "Shared ESLint config used by TanStack projects.",
+  "author": "tannerlinsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/config.git",
+    "directory": "packages/eslint-config"
+  },
+  "homepage": "https://tanstack.com/config",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./src/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "preferGlobal": false,
+  "sideEffects": false,
+  "files": [
+    "src"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.21.0",
+    "@stylistic/eslint-plugin-js": "^4.1.0",
+    "eslint-plugin-import-x": "^4.6.1",
+    "eslint-plugin-n": "^17.16.1",
+    "globals": "^16.0.0",
+    "typescript-eslint": "^8.25.0",
+    "vue-eslint-parser": "^9.4.3"
+  },
+  "devDependencies": {
+    "@types/eslint": "^9.6.1",
+    "eslint": "^9.21.0"
+  },
+  "scripts": {
+    "test:types": "tsc",
+    "test:eslint": "eslint ./src",
+    "test:build": "publint --strict"
+  }
+}

package/src/import.js

@@ -0,0 +1,33 @@
+// https://github.com/un-ts/eslint-plugin-import-x
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const importRules = {
+  /** Bans the use of inline type-only markers for named imports */
+  'import/consistent-type-specifier-style': ['error', 'prefer-top-level'],
+  /** Reports any imports that come after non-import statements */
+  'import/first': 'error',
+  /** Stylistic preference */
+  'import/newline-after-import': 'error',
+  /** No require() or module.exports */
+  'import/no-commonjs': 'error',
+  /** No import loops */
+  'import/no-cycle': 'error',
+  /** Reports if a resolved path is imported more than once */
+  'import/no-duplicates': 'error',
+  /** Stylistic preference */
+  'import/order': [
+    'error',
+    {
+      groups: [
+        'builtin',
+        'external',
+        'internal',
+        'parent',
+        'sibling',
+        'index',
+        'object',
+        'type',
+      ],
+    },
+  ],
+}

package/src/index.js

@@ -0,0 +1,87 @@
+import tseslint from 'typescript-eslint'
+import vueparser from 'vue-eslint-parser'
+import stylisticJs from '@stylistic/eslint-plugin-js'
+import pluginImport from 'eslint-plugin-import-x'
+import pluginNode from 'eslint-plugin-n'
+import globals from 'globals'
+import { javascriptRules } from './javascript.js'
+import { importRules } from './import.js'
+import { typescriptRules } from './typescript.js'
+import { nodeRules } from './node.js'
+import { stylisticRules } from './stylistic.js'
+
+const JS_GLOB_INCLUDE = ['**/*.{js,ts,tsx}']
+const VUE_GLOB_INCLUDE = ['**/*.vue']
+
+const GLOB_EXCLUDE = [
+  '**/.nx/**',
+  '**/.svelte-kit/**',
+  '**/build/**',
+  '**/coverage/**',
+  '**/dist/**',
+  '**/snap/**',
+  '**/vite.config.*.timestamp-*.*',
+]
+
+const jsRules = {
+  ...javascriptRules,
+  ...typescriptRules,
+  ...importRules,
+  ...nodeRules,
+  ...stylisticRules,
+}
+
+const jsPlugins = {
+  '@stylistic/js': stylisticJs,
+  '@typescript-eslint': tseslint.plugin,
+  import: pluginImport,
+  node: pluginNode,
+}
+
+/** @type {import('eslint').Linter.Config[]} */
+export const tanstackConfig = [
+  {
+    name: 'tanstack/ignores',
+    ignores: GLOB_EXCLUDE,
+  },
+  {
+    name: 'tanstack/setup',
+    files: JS_GLOB_INCLUDE,
+    languageOptions: {
+      sourceType: 'module',
+      ecmaVersion: 2020,
+      // @ts-expect-error
+      parser: tseslint.parser,
+      parserOptions: {
+        project: true,
+        parser: tseslint.parser,
+      },
+      globals: {
+        ...globals.browser,
+      },
+    },
+    // @ts-expect-error
+    plugins: jsPlugins,
+    rules: jsRules,
+  },
+  {
+    name: 'tanstack/vue',
+    files: VUE_GLOB_INCLUDE,
+    languageOptions: {
+      parser: vueparser,
+      parserOptions: {
+        sourceType: 'module',
+        ecmaVersion: 2020,
+        parser: tseslint.parser,
+        project: true,
+        extraFileExtensions: ['.vue'],
+      },
+      globals: {
+        ...globals.browser,
+      },
+    },
+    // @ts-expect-error
+    plugins: jsPlugins,
+    rules: jsRules,
+  },
+]

package/src/javascript.js

@@ -0,0 +1,56 @@
+// https://eslint.org/docs/latest/rules/
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const javascriptRules = {
+  /** TODO */
+  'for-direction': 'error',
+  'no-async-promise-executor': 'error',
+  'no-case-declarations': 'error',
+  'no-class-assign': 'error',
+  'no-compare-neg-zero': 'error',
+  'no-cond-assign': 'error',
+  'no-constant-binary-expression': 'error',
+  'no-constant-condition': 'error',
+  'no-control-regex': 'error',
+  'no-debugger': 'error',
+  'no-delete-var': 'error',
+  'no-dupe-else-if': 'error',
+  'no-duplicate-case': 'error',
+  'no-empty-character-class': 'error',
+  'no-empty-pattern': 'error',
+  'no-empty-static-block': 'error',
+  'no-ex-assign': 'error',
+  'no-extra-boolean-cast': 'error',
+  'no-fallthrough': 'error',
+  'no-global-assign': 'error',
+  'no-invalid-regexp': 'error',
+  'no-irregular-whitespace': 'error',
+  'no-loss-of-precision': 'error',
+  'no-misleading-character-class': 'error',
+  'no-nonoctal-decimal-escape': 'error',
+  'no-octal': 'error',
+  'no-regex-spaces': 'error',
+  'no-self-assign': 'error',
+  /** Warn about variable with identical names in the outer scope */
+  'no-shadow': 'warn',
+  'no-shadow-restricted-names': 'error',
+  'no-sparse-arrays': 'error',
+  'no-unsafe-finally': 'error',
+  'no-unsafe-optional-chaining': 'error',
+  'no-unused-labels': 'error',
+  'no-unused-private-class-members': 'error',
+  'no-useless-backreference': 'error',
+  'no-useless-catch': 'error',
+  'no-useless-escape': 'error',
+  /** Prefer let and const */
+  'no-var': 'error',
+  'no-with': 'error',
+  /** Prefer const if never re-assigned */
+  'prefer-const': 'error',
+  'require-yield': 'error',
+  /** Stylistic consistency */
+  'sort-imports': ['error', { ignoreDeclarationSort: true }],
+  'use-isnan': 'error',
+  /** Enforce comparing typeof against valid strings */
+  'valid-typeof': 'error',
+}

package/src/node.js

@@ -0,0 +1,7 @@
+// https://github.com/eslint-community/eslint-plugin-n
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const nodeRules = {
+  /** Enforce usage of the `node:` prefix for builtin imports */
+  'node/prefer-node-protocol': 'error',
+}

package/src/stylistic.js

@@ -0,0 +1,7 @@
+// https://eslint.style/packages/js
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const stylisticRules = {
+  /** Enforce consistency of spacing after the start of a comment */
+  '@stylistic/js/spaced-comment': 'error',
+}

package/src/typescript.js

@@ -0,0 +1,72 @@
+// https://typescript-eslint.io/rules/
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const typescriptRules = {
+  /** Prefer Array<T> format */
+  '@typescript-eslint/array-type': [
+    'error',
+    { default: 'generic', readonly: 'generic' },
+  ],
+  /** Prevent @ts-ignore, allow @ts-expect-error */
+  '@typescript-eslint/ban-ts-comment': [
+    'error',
+    {
+      'ts-expect-error': false,
+      'ts-ignore': 'allow-with-description',
+    },
+  ],
+  /** Enforce import type { T } */
+  '@typescript-eslint/consistent-type-imports': [
+    'error',
+    { prefer: 'type-imports' },
+  ],
+  /** Shorthand method style is less strict */
+  '@typescript-eslint/method-signature-style': ['error', 'property'],
+  /** Enforces generic type convention */
+  '@typescript-eslint/naming-convention': [
+    'error',
+    {
+      selector: 'typeParameter',
+      format: ['PascalCase'],
+      leadingUnderscore: 'forbid',
+      trailingUnderscore: 'forbid',
+      custom: {
+        regex: '^(T|T[A-Z][A-Za-z]+)$',
+        match: true,
+      },
+    },
+  ],
+  /** Duplicate values can lead to bugs that are hard to track down */
+  '@typescript-eslint/no-duplicate-enum-values': 'error',
+  /** Using the operator any more than once does nothing */
+  '@typescript-eslint/no-extra-non-null-assertion': 'error',
+  /** There are several potential bugs with this compared to other loops */
+  '@typescript-eslint/no-for-in-array': 'error',
+  /** Don't over-define types for simple things like strings */
+  '@typescript-eslint/no-inferrable-types': [
+    'error',
+    { ignoreParameters: true },
+  ],
+  /** Enforce valid definition of new and constructor */
+  '@typescript-eslint/no-misused-new': 'error',
+  /** Disallow TypeScript namespaces */
+  '@typescript-eslint/no-namespace': 'error',
+  /** Disallow non-null assertions after an optional chain expression */
+  '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+  /** Detects conditionals which will always evaluate truthy or falsy */
+  '@typescript-eslint/no-unnecessary-condition': 'error',
+  /** Checks if the the explicit type is identical to the inferred type */
+  '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+  /** Disallow using the unsafe built-in Function type */
+  '@typescript-eslint/no-unsafe-function-type': 'error',
+  /** Disallow using confusing built-in primitive class wrappers */
+  '@typescript-eslint/no-wrapper-object-types': 'error',
+  /** Enforce the use of as const over literal type */
+  '@typescript-eslint/prefer-as-const': 'error',
+  /** Prefer for-of loop over the standard for loop */
+  '@typescript-eslint/prefer-for-of': 'warn',
+  /** Warn about async functions which have no await expression */
+  '@typescript-eslint/require-await': 'warn',
+  /** Prefer of ES6-style import declarations */
+  '@typescript-eslint/triple-slash-reference': 'error',
+}