@qualcomm-ui/eslint-config-typescript 1.0.1 → 1.1.0

package/index.d.ts

@@ -0,0 +1,91 @@
+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
+
+    /**
+     * TypeScript naming conventions (PascalCase for types, camelCase for
+     * properties, etc). Requires type information.
+     */
+    namingConventions: ConfigObject
+
+    /**
+     * Import optimizations for library code (consistent type imports, no side
+     * effects). Use for packages consumed by other projects.
+     */
+    performance: 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:
+     *
+     * @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: ConfigObject[]
+
+    /**
+     * Sort object properties, interface members, and type definitions
+     * alphabetically.
+     */
+    sortKeys: ConfigObject
+
+    /**
+     * Enforce explicit type exports for public APIs (prevents runtime bloat).
+     * Use for library entry points and public exports.
+     */
+    strictExports: ConfigObject
+
+    /**
+     * Code style rules (imports, formatting, unused code, etc).
+     * Enforces Prettier, import ordering, and code quality standards.
+     */
+    styleGuide: ConfigObject
+
+    /**
+     * Type-aware linting rules (await-thenable, no-unsafe-call, etc).
+     * Requires TypeScript type information. Catches type-related bugs.
+     */
+    typeChecks: ConfigObject
+  }
+}
+
+declare const typescriptConfig: TypescriptConfigExport
+export default typescriptConfig

package/index.js

@@ -9,87 +9,14 @@ 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualcomm-ui/eslint-config-typescript",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "QUI ESLint config for consistent TypeScript code",
   "author": "Ryan Bower",
   "license": "BSD-3-Clause-Clear",
@@ -12,7 +12,10 @@
     "config"
   ],
   "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js",
     "base.js",
     "jsdoc.js",
@@ -27,12 +30,13 @@
     "access": "public"
   },
   "devDependencies": {
+    "@eslint/core": "^1.0.0",
     "@qualcomm-ui/cli": "^1.0.2",
     "@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"
+    "typescript-eslint": "8.46.2"
   },
   "peerDependencies": {
     "@eslint/js": ">=9.37.0",