@qualcomm-ui/eslint-config-typescript 2.0.0 → 3.0.0

package/base.js

@@ -1,20 +1,17 @@
 // Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 
-import {defineConfig} from "eslint/config"
 import tseslint from "typescript-eslint"
 
-export default defineConfig({
-  languageOptions: {
-    ecmaVersion: 2022,
-    parser: tseslint.parser,
-    parserOptions: {
-      ecmaFeatures: {jsx: true},
-    },
-    sourceType: "module",
+export const typescriptLanguageOptions = {
+  ecmaVersion: 2022,
+  parser: tseslint.parser,
+  parserOptions: {
+    ecmaFeatures: {jsx: true},
   },
-  name: "qui-typescript-base",
-  plugins: {
-    "@typescript-eslint": tseslint.plugin,
-  },
-})
+  sourceType: "module",
+}
+
+export const typescriptPlugins = {
+  "@typescript-eslint": tseslint.plugin,
+}

package/index.d.ts

@@ -2,50 +2,31 @@ import type {ConfigObject} from "@eslint/core"
 
 interface TypescriptConfigExport {
   configs: {
-    /**
-     * Base TypeScript configuration with parser and plugin setup.
-     * Required for each config to work.
-     */
-    base: ConfigObject
-
     /**
      * JSDoc validation rules (alignment, tag names, formatting).
      * Use for code with public APIs or documentation requirements.
      */
-    jsdoc: ConfigObject
+    jsdoc: ConfigObject[]
 
     /**
      * TypeScript naming conventions (PascalCase for types, camelCase for
      * properties, etc). Requires type information.
+     *
+     * This is included in the {@link recommended} config.
      */
-    namingConventions: ConfigObject
-
-    /**
-     * Import optimizations for library code (consistent type imports, no side
-     * effects). Use for packages consumed by other projects.
-     */
-    performance: ConfigObject
+    namingConventions: ConfigObject[]
 
     /**
-     * Array of recommended configs. This is equivalent to the following:
-     * ```js
-     * import qui from "@qualcomm-ui/eslint-config-typescript"
-     *
-     * const recommended = [
-     *   qui.configs.base,
-     *   qui.configs.styleGuide,
-     *   qui.configs.sortKeys,
-     *   qui.configs.typeChecks,
-     *   qui.configs.namingConventions,
-     * ]
-     * ```
-     *
-     * Usage:
+     * Recommended TypeScript configuration. This includes the settings from the
+     * `styleGuide`, `sortKeys`, `typeChecks`, and `namingConventions` configs. This
+     * rule requires type information, which can be provided via `languageOptions`.
+     * An example configuration is available below:
      *
      * @example
      * ```js
      * // eslint.config.js
      * import {defineConfig} from "eslint/config"
+     * import tseslint from "typescript-eslint"
      * import quiEslintTs from "@qualcomm-ui/eslint-config-typescript"
      *
      * export default defineConfig(
@@ -53,8 +34,14 @@ interface TypescriptConfigExport {
      *    // other settings
      *  },
      *  {
-     *    extends: [...quiEslintTs.configs.recommended],
-     *    files: [/*TS Files*\/]
+     *    extends: [quiEslintTs.configs.recommended],
+     *    files: [/*TS Files*\/],
+     *    languageOptions: {
+     *      parser: tseslint.parser,
+     *      parserOptions: {
+     *        projectService: true,
+     *      },
+     *    }
      *  },
      * )
      * ```
@@ -64,26 +51,32 @@ interface TypescriptConfigExport {
     /**
      * Sort object properties, interface members, and type definitions
      * alphabetically.
+     *
+     * This is included in the {@link recommended} config.
      */
-    sortKeys: ConfigObject
+    sortKeys: ConfigObject[]
 
     /**
      * Enforce explicit type exports for public APIs (prevents runtime bloat).
      * Use for library entry points and public exports.
      */
-    strictExports: ConfigObject
+    strictExports: ConfigObject[]
 
     /**
      * Code style rules (imports, formatting, unused code, etc).
-     * Enforces Prettier, import ordering, and code quality standards.
+     * Enforces oxfmt, import ordering, and code quality standards.
+     *
+     * This is included in the {@link recommended} config.
      */
-    styleGuide: ConfigObject
+    styleGuide: ConfigObject[]
 
     /**
      * Type-aware linting rules (await-thenable, no-unsafe-call, etc).
      * Requires TypeScript type information. Catches type-related bugs.
+     *
+     * This is included in the {@link recommended} config.
      */
-    typeChecks: ConfigObject
+    typeChecks: ConfigObject[]
   }
 }
 

package/index.js

@@ -1,19 +1,38 @@
-import base from "./base.js"
+import {typescriptLanguageOptions} from "./base.js"
 import jsdoc from "./jsdoc.js"
 import namingConventions from "./naming-conventions.js"
-import performance from "./performance.js"
 import sortKeys from "./sort-keys.js"
 import strictExports from "./strict-exports.js"
 import styleGuide from "./style-guide.js"
 import typeChecks from "./type-checks.js"
 
+const [namingConventionsConfig] = namingConventions
+const [sortKeysConfig] = sortKeys
+const [styleGuideConfig] = styleGuide
+const [typeChecksConfig] = typeChecks
+
+const recommended = {
+  languageOptions: typescriptLanguageOptions,
+  name: "qui-typescript-recommended",
+  plugins: {
+    ...namingConventionsConfig.plugins,
+    ...sortKeysConfig.plugins,
+    ...styleGuideConfig.plugins,
+    ...typeChecksConfig.plugins,
+  },
+  rules: {
+    ...namingConventionsConfig.rules,
+    ...sortKeysConfig.rules,
+    ...styleGuideConfig.rules,
+    ...typeChecksConfig.rules,
+  },
+}
+
 export default {
   configs: {
-    base,
     jsdoc,
     namingConventions,
-    performance,
-    recommended: [base, styleGuide, sortKeys, typeChecks, namingConventions],
+    recommended,
     sortKeys,
     strictExports,
     styleGuide,

package/jsdoc.js

@@ -1,8 +1,8 @@
 // Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 
-import {defineConfig} from "eslint/config"
 import jsdoc from "eslint-plugin-jsdoc"
+import {defineConfig} from "eslint/config"
 
 export default defineConfig({
   name: "qui-jsdoc",

package/naming-conventions.js

@@ -3,8 +3,12 @@
 
 import {defineConfig} from "eslint/config"
 
+import {typescriptLanguageOptions, typescriptPlugins} from "./base.js"
+
 export default defineConfig({
+  languageOptions: typescriptLanguageOptions,
   name: "qui-typechecked-naming-convention",
+  plugins: {...typescriptPlugins},
   rules: {
     "@typescript-eslint/naming-convention": [
       "error",

package/package.json

@@ -1,38 +1,49 @@
 {
   "name": "@qualcomm-ui/eslint-config-typescript",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "QUI ESLint config for consistent TypeScript code",
-  "author": "Ryan Bower",
+  "keywords": [
+    "config",
+    "eslint"
+  ],
   "license": "BSD-3-Clause-Clear",
-  "repository": "https://github.com/qualcomm/qualcomm-ui",
-  "publishConfig": {
-    "access": "public"
+  "author": "Ryan Bower",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/qualcomm/qualcomm-ui"
   },
-  "type": "module",
-  "sideEffects": false,
   "files": [
     "index.d.ts",
     "index.js",
     "base.js",
     "jsdoc.js",
-    "performance.js",
     "sort-keys.js",
     "style-guide.js",
     "naming-conventions.js",
     "type-checks.js",
     "strict-exports.js"
   ],
+  "type": "module",
+  "sideEffects": false,
   "main": "index.js",
   "module": "index.js",
   "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@eslint/core": "^1.0.0",
-    "@qualcomm-ui/cli": "^1.0.6",
+    "@qualcomm-ui/cli": "1.0.7",
+    "@qualcomm-ui/tsconfig": "2.1.1",
     "@stylistic/eslint-plugin": "5.2.0",
-    "@typescript-eslint/eslint-plugin": "8.48.1",
-    "@typescript-eslint/parser": "8.48.1",
+    "@typescript-eslint/eslint-plugin": "8.58.2",
+    "@typescript-eslint/parser": "8.58.2",
+    "cross-env": "^10.1.0",
     "eslint-plugin-comment-length": "^2.2.1",
-    "typescript-eslint": "8.48.1"
+    "eslint-plugin-oxfmt": "0.9.0",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-unicorn": "^65.0.1",
+    "typescript-eslint": "8.58.2"
   },
   "peerDependencies": {
     "@eslint/js": ">=9.37.0",
@@ -40,20 +51,17 @@
     "@typescript-eslint/eslint-plugin": ">=8.31.1",
     "@typescript-eslint/parser": ">=8.31.1",
     "eslint": ">=9.37.0",
-    "eslint-config-prettier": ">=10.1.2",
     "eslint-import-resolver-typescript": ">=4.3.4",
     "eslint-plugin-comment-length": ">=2.2.1",
     "eslint-plugin-import": ">=2.31.0",
     "eslint-plugin-jsdoc": ">=50.6.11",
-    "eslint-plugin-prettier": ">=5.2.6",
+    "eslint-plugin-oxfmt": ">=0.9.0",
     "eslint-plugin-perfectionist": ">=4.12.3",
+    "eslint-plugin-promise": ">=7.2.1",
+    "eslint-plugin-unicorn": ">=65.0.1",
     "eslint-plugin-unused-imports": ">=4.1.4",
-    "prettier": ">=3.5.3",
+    "oxfmt": ">=0.54.0",
     "typescript": ">=5.7.3",
     "typescript-eslint": ">=8.31.1"
-  },
-  "keywords": [
-    "eslint",
-    "config"
-  ]
+  }
 }

package/sort-keys.js

@@ -1,12 +1,17 @@
 // Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 
-import {defineConfig} from "eslint/config"
 import perfectionist from "eslint-plugin-perfectionist"
+import {defineConfig} from "eslint/config"
+
+/** @type {NonNullable<import("eslint").Linter.Config["plugins"]>} */
+const plugins = {
+  perfectionist,
+}
 
 export default defineConfig({
   name: "qui-sort-keys",
-  plugins: {perfectionist},
+  plugins,
   rules: {
     "perfectionist/sort-interfaces": [
       "error",

package/strict-exports.js

@@ -3,8 +3,14 @@
 
 import {defineConfig} from "eslint/config"
 
+import {typescriptLanguageOptions, typescriptPlugins} from "./base.js"
+
 export default defineConfig({
+  languageOptions: typescriptLanguageOptions,
   name: "qui-typechecked-strict-exports",
+  plugins: {
+    ...typescriptPlugins,
+  },
   rules: {
     "@typescript-eslint/consistent-type-exports": [
       "error",

package/style-guide.js

@@ -2,27 +2,145 @@
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 
 import stylistic from "@stylistic/eslint-plugin"
-import {defineConfig} from "eslint/config"
 import commentLength from "eslint-plugin-comment-length"
 import importPlugin from "eslint-plugin-import"
+import eslintPluginOxfmt from "eslint-plugin-oxfmt"
 import perfectionist from "eslint-plugin-perfectionist"
-import prettierPlugin from "eslint-plugin-prettier"
+import promisePlugin from "eslint-plugin-promise"
+import eslintPluginUnicorn from "eslint-plugin-unicorn"
 import unusedImportsPlugin from "eslint-plugin-unused-imports"
+import {defineConfig} from "eslint/config"
+
+import {typescriptLanguageOptions, typescriptPlugins} from "./base.js"
+
+const oxlintParityRules = {
+  "@typescript-eslint/no-dupe-class-members": "error",
+  "@typescript-eslint/no-loss-of-precision": "error",
+  "@typescript-eslint/no-redeclare": "off",
+  "@typescript-eslint/no-unused-private-class-members": "error",
+  "block-scoped-var": "error",
+  "constructor-super": "error",
+  curly: "error",
+  eqeqeq: ["error", "smart"],
+  "for-direction": "error",
+  "getter-return": "error",
+  "no-array-constructor": "off",
+  "no-async-promise-executor": "error",
+  "no-caller": "error",
+  "no-class-assign": "error",
+  "no-compare-neg-zero": "error",
+  "no-cond-assign": "error",
+  "no-const-assign": "error",
+  "no-constant-binary-expression": "error",
+  "no-constant-condition": "error",
+  "no-debugger": "error",
+  "no-delete-var": "warn",
+  "no-dupe-class-members": "off",
+  "no-dupe-else-if": "error",
+  "no-dupe-keys": "error",
+  "no-duplicate-case": "error",
+  "no-empty-character-class": "error",
+  "no-empty-pattern": "error",
+  "no-empty-static-block": "error",
+  "no-eval": "error",
+  "no-ex-assign": "error",
+  "no-extend-native": "error",
+  "no-extra-bind": "error",
+  "no-extra-boolean-cast": "error",
+  "no-func-assign": "error",
+  "no-global-assign": "error",
+  "no-implied-eval": "off",
+  "no-import-assign": "error",
+  "no-invalid-regexp": "error",
+  "no-irregular-whitespace": "error",
+  "no-iterator": "error",
+  "no-loss-of-precision": "off",
+  "no-misleading-character-class": "error",
+  "no-new-native-nonconstructor": "error",
+  "no-new-wrappers": "error",
+  "no-nonoctal-decimal-escape": "error",
+  "no-obj-calls": "error",
+  "no-object-constructor": "error",
+  "no-redeclare": "off",
+  "no-self-assign": "error",
+  "no-self-compare": "error",
+  "no-setter-return": "error",
+  "no-shadow-restricted-names": "error",
+  "no-sparse-arrays": "error",
+  "no-this-before-super": "error",
+  "no-unassigned-vars": "error",
+  "no-unreachable": "error",
+  "no-unsafe-finally": "error",
+  "no-unsafe-negation": "error",
+  "no-unsafe-optional-chaining": "error",
+  "no-unused-expressions": "off",
+  "no-unused-labels": "error",
+  "no-unused-private-class-members": "off",
+  "no-unused-vars": "off",
+  "no-useless-backreference": "error",
+  "no-useless-catch": "error",
+  "no-useless-concat": "error",
+  "no-useless-escape": "warn",
+  "no-useless-rename": "error",
+  "no-with": "error",
+  "object-shorthand": "error",
+  "prefer-const": "error",
+  "prefer-object-has-own": "error",
+  "prefer-spread": "error",
+  "prefer-template": "error",
+  "promise/always-return": "warn",
+  "promise/catch-or-return": "warn",
+  "promise/no-multiple-resolved": "error",
+  "promise/no-nesting": "error",
+  "promise/no-new-statics": "error",
+  "promise/no-return-in-finally": "warn",
+  "promise/no-return-wrap": "error",
+  "promise/param-names": "error",
+  "promise/spec-only": "error",
+  "require-yield": "error",
+  "use-isnan": "error",
+  "valid-typeof": "error",
+}
+
+const unicornRules = {
+  "unicorn/no-array-for-each": "warn",
+  "unicorn/no-await-in-promise-methods": "error",
+  "unicorn/no-invalid-fetch-options": "error",
+  "unicorn/no-invalid-remove-event-listener": "error",
+  "unicorn/no-static-only-class": "error",
+  "unicorn/no-unnecessary-await": "error",
+  "unicorn/no-unreadable-iife": "error",
+  "unicorn/no-useless-length-check": "error",
+  "unicorn/prefer-array-find": "error",
+  "unicorn/prefer-node-protocol": "error",
+  "unicorn/prefer-set-size": "error",
+  "unicorn/prefer-string-trim-start-end": "error",
+}
 
 export default defineConfig({
+  languageOptions: typescriptLanguageOptions,
   name: "qui-style-guide",
   plugins: {
+    ...typescriptPlugins,
     "@stylistic": stylistic,
     "comment-length": commentLength,
     import: importPlugin,
+    oxfmt: eslintPluginOxfmt,
     perfectionist,
-    prettier: prettierPlugin,
+    promise: promisePlugin,
+    unicorn: eslintPluginUnicorn,
     "unused-imports": unusedImportsPlugin,
   },
   rules: {
+    ...oxlintParityRules,
+    ...unicornRules,
     ...commentLength.configs["flat/recommended"].rules,
     "@stylistic/spaced-comment": ["error", "always", {block: {balanced: true}}],
     "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/consistent-type-imports": [
+      "error",
+      {fixStyle: "inline-type-imports"},
+    ],
     "@typescript-eslint/explicit-member-accessibility": [
       "error",
       {
@@ -38,7 +156,7 @@ export default defineConfig({
     ],
     "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/no-extra-semi": "off",
-    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/no-import-type-side-effects": "error",
     "@typescript-eslint/no-var-requires": "off",
     "comment-length/limit-multi-line-comments": [
       "warn",
@@ -54,63 +172,12 @@ export default defineConfig({
         maxLength: 85,
       },
     ],
-    curly: "error",
-    eqeqeq: [
-      "error",
-      "always",
-      {
-        null: "ignore",
-      },
-    ],
     "import/newline-after-import": ["error", {count: 1}],
-    "import/no-cycle": [0],
+    "import/no-cycle": "off",
     "import/no-duplicates": ["error", {"prefer-inline": true}],
-    "import/order": [
-      "error",
-      {
-        alphabetize: {
-          caseInsensitive: true,
-          order: "asc",
-        },
-        groups: [
-          ["builtin", "external"],
-          ["internal"],
-          ["parent"],
-          ["sibling", "index"],
-          ["unknown"],
-        ],
-        "newlines-between": "always",
-        pathGroups: [
-          {
-            group: "external",
-            pattern: "react",
-            position: "before",
-          },
-          {
-            group: "external",
-            pattern: "@qualcomm-ui/**",
-            position: "after",
-          },
-          {
-            group: "internal",
-            pattern: "~**",
-          },
-          {
-            group: "internal",
-            pattern: "~**/*",
-          },
-          {
-            group: "internal",
-            pattern: "~**/**",
-          },
-        ],
-        pathGroupsExcludedImportTypes: ["react"],
-      },
-    ],
+    "import/order": "off",
     "multiline-comment-style": ["off"],
-    "no-array-constructor": "error",
     "no-case-declarations": "off",
-    "no-const-assign": "error",
     "no-duplicate-imports": "off",
     "no-inner-declarations": "off",
     "no-invalid-this": "off",
@@ -140,21 +207,8 @@ export default defineConfig({
       },
     ],
     "no-undef": "off",
-    "no-unused-vars": "off",
-    "no-useless-concat": "error",
-    "no-useless-escape": "warn",
     "no-var": "error",
-    "object-shorthand": "error",
-    "prefer-const": "error",
-    "prefer-template": ["error"],
-    "prettier/prettier": "error",
-    "sort-imports": [
-      "error",
-      {
-        ignoreCase: true,
-        ignoreDeclarationSort: true,
-      },
-    ],
+    "oxfmt/oxfmt": "error",
     "unused-imports/no-unused-imports": "error",
     "unused-imports/no-unused-vars": [
       "error",

package/type-checks.js

@@ -3,19 +3,23 @@
 
 import {defineConfig} from "eslint/config"
 
+import {typescriptLanguageOptions, typescriptPlugins} from "./base.js"
+
 /**
- * This configuration is based on https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended-type-checked.ts
+ * This configuration is based on
+ * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended-type-checked.ts
  *
- * There are some key differences, primarily regarding rules involving `any`. We set
- * most of these to either warn or off:
- * - Interop with untyped JS is a real pain point where `any` is pragmatic.
- * - Type gymnastics that satisfy the compiler but obscure intent can be worse than
- * `any`
- * - The ceremony of unknown + guards can be disproportionate to the actual risk.
- * - External libraries that use `any` can cause issues with our own types.
+ * There are some key differences, primarily regarding rules involving `any`. We
+ * set most of these to either warn or off: - Interop with untyped JS is a real
+ * pain point where `any` is pragmatic. - Type gymnastics that satisfy the
+ * compiler but obscure intent can be worse than `any` - The ceremony of unknown
+ * + guards can be disproportionate to the actual risk. - External libraries
+ * that use `any` can cause issues with our own types.
  */
 export default defineConfig({
+  languageOptions: typescriptLanguageOptions,
   name: "qui-typechecked-recommended",
+  plugins: {...typescriptPlugins},
   rules: {
     "@typescript-eslint/await-thenable": "error",
     "@typescript-eslint/ban-ts-comment": "warn", // Allow use of @ts-ignore, but warn
@@ -40,9 +44,9 @@ export default defineConfig({
     "@typescript-eslint/no-namespace": "error",
     "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
     /**
-     * Some projects choose to occasionally intentionally include a redundant type
-     * constituent for documentation purposes. Like our icon, which is a union of:
-     * `"xs" | "sm" | "md" | "lg" | "xl" | string | number`
+     * Some projects choose to occasionally intentionally include a redundant
+     * type constituent for documentation purposes. Like our icon, which is a
+     * union of: `"xs" | "sm" | "md" | "lg" | "xl" | string | number`
      */
     "@typescript-eslint/no-redundant-type-constituents": "off",
     "@typescript-eslint/no-require-imports": "error",

package/performance.js

@@ -1,15 +0,0 @@
-// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
-// SPDX-License-Identifier: BSD-3-Clause-Clear
-
-import {defineConfig} from "eslint/config"
-
-export default defineConfig({
-  name: "qui-performance",
-  rules: {
-    "@typescript-eslint/consistent-type-imports": [
-      "error",
-      {fixStyle: "inline-type-imports"},
-    ],
-    "@typescript-eslint/no-import-type-side-effects": "error",
-  },
-})