@qualcomm-ui/eslint-config-typescript 1.0.0

package/LICENSE.txt

@@ -0,0 +1,31 @@
+Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the
+disclaimer below) provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Qualcomm Technologies, Inc. nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
+GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
+HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/base.js

@@ -0,0 +1,20 @@
+// 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",
+  },
+  name: "qui-typescript-base",
+  plugins: {
+    "@typescript-eslint": tseslint.plugin,
+  },
+})

package/index.js

@@ -0,0 +1,95 @@
+import base 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"
+
+export default {
+  configs: {
+    /**
+     * Base TypeScript configuration with parser and plugin setup.
+     * Required for all other configs to work.
+     */
+    base,
+
+    /**
+     * JSDoc validation rules (alignment, tag names, formatting).
+     * Use for code with public APIs or documentation requirements.
+     */
+    jsdoc,
+
+    /**
+     * TypeScript naming conventions (PascalCase for types, camelCase for
+     * properties, etc). Requires type information.
+     */
+    namingConventions,
+
+    /**
+     * Import optimizations for library code (consistent type imports, no side
+     * effects). Use for packages consumed by other projects.
+     */
+    performance,
+
+    /**
+     * 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:
+     *
+     * @example
+     * ```js
+     * // eslint.config.js
+     * import {defineConfig} from "eslint/config"
+     * import quiEslintTs from "@qualcomm-ui/eslint-config-typescript"
+     *
+     * export default defineConfig(
+     *  {
+     *    // other settings
+     *  },
+     *  {
+     *    extends: [...quiEslintTs.configs.recommended],
+     *    files: [/*TS Files*\/]
+     *  },
+     * )
+     * ```
+     */
+    recommended: [base, styleGuide, sortKeys, typeChecks, namingConventions],
+
+    /**
+     * Sort object properties, interface members, and type definitions
+     * alphabetically.
+     */
+    sortKeys,
+
+    /**
+     * Enforce explicit type exports for public APIs (prevents runtime bloat).
+     * Use for library entry points and public exports.
+     */
+    strictExports,
+
+    /**
+     * Code style rules (imports, formatting, unused code, etc).
+     * Enforces Prettier, import ordering, and code quality standards.
+     */
+    styleGuide,
+
+    /**
+     * Type-aware linting rules (await-thenable, no-unsafe-call, etc).
+     * Requires TypeScript type information. Catches type-related bugs.
+     */
+    typeChecks,
+  },
+}

package/jsdoc.js

@@ -0,0 +1,67 @@
+// 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"
+
+export default defineConfig({
+  name: "qui-jsdoc",
+  plugins: {jsdoc},
+  rules: {
+    "jsdoc/check-alignment": "error",
+    "jsdoc/check-indentation": "warn",
+    "jsdoc/check-tag-names": [
+      "error",
+      {
+        definedTags: [
+          "custom",
+          "docLink",
+          "group",
+          "option",
+          "tag",
+          "alpha",
+          "beta",
+          "betaDocumentation",
+          "decorator",
+          "defaultValue",
+          "deprecated",
+          "eventProperty",
+          "example",
+          "experimental",
+          "inheritDoc",
+          "internal",
+          "internalRemarks",
+          "label",
+          "link",
+          "override",
+          "packageDocumentation",
+          "param",
+          "preapproved",
+          "privateRemarks",
+          "public",
+          "readonly",
+          "remarks",
+          "returns",
+          "sealed",
+          "see",
+          "throws",
+          "typeParam",
+          "virtual",
+        ],
+      },
+    ],
+    "jsdoc/no-blank-block-descriptions": "error",
+    "jsdoc/no-multi-asterisks": "error",
+    "jsdoc/require-asterisk-prefix": "error",
+    "jsdoc/require-jsdoc": "off",
+    "jsdoc/tag-lines": [
+      "error",
+      "always",
+      {
+        count: 0,
+        endLines: 0,
+        startLines: 1,
+      },
+    ],
+  },
+})

package/naming-conventions.js

@@ -0,0 +1,53 @@
+// 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-typechecked-naming-convention",
+  rules: {
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        custom: {
+          match: false,
+          regex: "^I[A-Z]",
+        },
+        format: ["PascalCase"],
+        selector: ["class", "enum", "interface", "typeAlias"],
+      },
+      {
+        custom: {
+          match: false,
+          regex: "^I[A-Z]",
+        },
+        format: ["PascalCase"],
+        leadingUnderscore: "allow",
+        selector: ["typeParameter"],
+      },
+      {
+        format: ["PascalCase"],
+        selector: "class",
+      },
+      {
+        filter: {
+          match: false,
+          regex: "^((ngAcceptInputType))",
+        },
+        format: ["camelCase"],
+        leadingUnderscore: "allow",
+        selector: ["classMethod", "classProperty"],
+      },
+      {
+        filter: {
+          match: false,
+          regex: "^((ngAcceptInputType))",
+        },
+        format: ["camelCase", "PascalCase"],
+        leadingUnderscore: "allow",
+        modifiers: ["protected", "readonly"],
+        selector: ["classMethod", "classProperty", "parameterProperty"],
+      },
+    ],
+  },
+})

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@qualcomm-ui/eslint-config-typescript",
+  "version": "1.0.0",
+  "description": "QUI ESLint config for consistent TypeScript code",
+  "author": "Ryan Bower",
+  "repository": "https://github.com/qualcomm/qualcomm-ui",
+  "sideEffects": false,
+  "type": "module",
+  "keywords": [
+    "eslint",
+    "config"
+  ],
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "base.js",
+    "jsdoc.js",
+    "performance.js",
+    "sort-keys.js",
+    "style-guide.js",
+    "naming-conventions.js",
+    "type-checks.js",
+    "strict-exports.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@qualcomm-ui/cli": "^1",
+    "@stylistic/eslint-plugin": "5.2.0",
+    "@typescript-eslint/eslint-plugin": "8.46.2",
+    "@typescript-eslint/parser": "8.46.2",
+    "eslint-plugin-comment-length": "^2.2.1",
+    "typescript-eslint": "8.40.0"
+  },
+  "peerDependencies": {
+    "@eslint/js": ">=9.37.0",
+    "@stylistic/eslint-plugin": ">=5.2.0",
+    "@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-perfectionist": ">=4.12.3",
+    "eslint-plugin-unused-imports": ">=4.1.4",
+    "prettier": ">=3.5.3",
+    "typescript": ">=5.7.3",
+    "typescript-eslint": ">=8.31.1"
+  }
+}

package/performance.js

@@ -0,0 +1,15 @@
+// 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",
+  },
+})

package/sort-keys.js

@@ -0,0 +1,27 @@
+// 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"
+
+export default defineConfig({
+  name: "qui-sort-keys",
+  plugins: {perfectionist},
+  rules: {
+    "perfectionist/sort-interfaces": [
+      "error",
+      {
+        partitionByComment: ["^group:"],
+        type: "natural",
+      },
+    ],
+    "perfectionist/sort-object-types": ["error", {type: "natural"}],
+    "perfectionist/sort-objects": [
+      "error",
+      {
+        partitionByComment: ["^group:"],
+        type: "natural",
+      },
+    ],
+  },
+})

package/strict-exports.js

@@ -0,0 +1,14 @@
+// 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-typechecked-strict-exports",
+  rules: {
+    "@typescript-eslint/consistent-type-exports": [
+      "error",
+      {fixMixedExportsWithInlineTypeSpecifier: true},
+    ],
+  },
+})

package/style-guide.js

@@ -0,0 +1,171 @@
+// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+// 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 perfectionist from "eslint-plugin-perfectionist"
+import prettierPlugin from "eslint-plugin-prettier"
+import unusedImportsPlugin from "eslint-plugin-unused-imports"
+
+export default defineConfig({
+  name: "qui-style-guide",
+  plugins: {
+    "@stylistic": stylistic,
+    "comment-length": commentLength,
+    import: importPlugin,
+    perfectionist,
+    prettier: prettierPlugin,
+    "unused-imports": unusedImportsPlugin,
+  },
+  rules: {
+    ...commentLength.configs["flat/recommended"].rules,
+    "@stylistic/spaced-comment": ["error", "always", {block: {balanced: true}}],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/explicit-member-accessibility": [
+      "error",
+      {
+        accessibility: "explicit",
+        overrides: {
+          accessors: "no-public",
+          constructors: "off",
+          methods: "no-public",
+          parameterProperties: "off",
+          properties: "no-public",
+        },
+      },
+    ],
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/no-extra-semi": "off",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "comment-length/limit-multi-line-comments": [
+      "warn",
+      {
+        ignoreUrls: true,
+        maxLength: 85,
+      },
+    ],
+    "comment-length/limit-single-line-comments": [
+      "warn",
+      {
+        ignoreUrls: true,
+        maxLength: 85,
+      },
+    ],
+    curly: "error",
+    eqeqeq: [
+      "error",
+      "always",
+      {
+        null: "ignore",
+      },
+    ],
+    "import/newline-after-import": ["error", {count: 1}],
+    "import/no-cycle": [0],
+    "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"],
+      },
+    ],
+    "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",
+    "no-prototype-builtins": "off",
+    "no-restricted-imports": [
+      "error",
+      {
+        patterns: [
+          {
+            group: ["@qualcomm-ui/*/src/**/*"],
+            message:
+              "Relative imports from src directories are not allowed. Please ensure that the targeted dependency is exported properly from its module",
+          },
+          {
+            group: ["@qualcomm-ui/*/src"],
+            message: 'Remove "src" (import directly)',
+          },
+        ],
+      },
+    ],
+    "no-restricted-syntax": [
+      "error",
+      {
+        message: "Use `private` instead",
+        selector:
+          ":matches(PropertyDefinition, MethodDefinition) > PrivateIdentifier.key",
+      },
+    ],
+    "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,
+      },
+    ],
+    "unused-imports/no-unused-imports": "error",
+    "unused-imports/no-unused-vars": [
+      "error",
+      {
+        args: "after-used",
+        argsIgnorePattern: "^_",
+        caughtErrors: "all",
+        caughtErrorsIgnorePattern: "^",
+        vars: "all",
+        varsIgnorePattern: "^_",
+      },
+    ],
+  },
+})

package/type-checks.js

@@ -0,0 +1,60 @@
+// 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-typechecked-recommended",
+  rules: {
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/ban-ts-comment": "warn",
+    "@typescript-eslint/no-array-constructor": "error",
+    "@typescript-eslint/no-array-delete": "error",
+    "@typescript-eslint/no-base-to-string": "error",
+    "@typescript-eslint/no-duplicate-enum-values": "error",
+    "@typescript-eslint/no-duplicate-type-constituents": "error",
+    "@typescript-eslint/no-empty-object-type": "off",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-extra-non-null-assertion": "error",
+    "@typescript-eslint/no-floating-promises": "warn",
+    "@typescript-eslint/no-for-in-array": "error",
+    "@typescript-eslint/no-implied-eval": "error",
+    "@typescript-eslint/no-misused-new": "error",
+    "@typescript-eslint/no-misused-promises": "warn",
+    "@typescript-eslint/no-namespace": "warn",
+    "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+    "@typescript-eslint/no-redundant-type-constituents": "off",
+    "@typescript-eslint/no-require-imports": "off",
+    "@typescript-eslint/no-this-alias": "error",
+    "@typescript-eslint/no-unnecessary-type-assertion": "warn",
+    "@typescript-eslint/no-unnecessary-type-constraint": "error",
+    "@typescript-eslint/no-unsafe-argument": "warn",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-call": "warn",
+    "@typescript-eslint/no-unsafe-declaration-merging": "error",
+    "@typescript-eslint/no-unsafe-enum-comparison": "error",
+    "@typescript-eslint/no-unsafe-function-type": "warn",
+    "@typescript-eslint/no-unsafe-member-access": "warn",
+    "@typescript-eslint/no-unsafe-return": "warn",
+    "@typescript-eslint/no-unsafe-unary-minus": "error",
+    "@typescript-eslint/no-unused-expressions": "error",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/no-wrapper-object-types": "error",
+    "@typescript-eslint/only-throw-error": "error",
+    "@typescript-eslint/prefer-as-const": "error",
+    "@typescript-eslint/prefer-namespace-keyword": "error",
+    "@typescript-eslint/prefer-promise-reject-errors": "warn",
+    "@typescript-eslint/require-await": "warn",
+    "@typescript-eslint/restrict-plus-operands": "error",
+    "@typescript-eslint/restrict-template-expressions": "off",
+    "@typescript-eslint/triple-slash-reference": "off",
+    "@typescript-eslint/unbound-method": "off",
+    "no-array-constructor": "off",
+    "no-implied-eval": "off",
+    "no-throw-literal": "off",
+    "no-unused-expressions": "off",
+    "no-unused-vars": "off",
+    "prefer-promise-reject-errors": "off",
+    "require-await": "off",
+  },
+})