@prairielearn/eslint-config 0.0.1 → 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,76 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+import { type PrairieLearnPluginOptions } from './configs/prairielearn.js';
+export interface PrairieLearnEslintConfigOptions {
+    /**
+     * Root directory for TypeScript project service.
+     * Required for type-aware linting.
+     */
+    tsconfigRootDir: string;
+    /**
+     * Glob patterns for files to apply type-aware rules to.
+     * @default ['**\/*.{ts,tsx}']
+     */
+    typeAwareFiles?: string[];
+    /**
+     * Files to allow in defaultProject for type-aware linting.
+     * Useful for config files outside the main tsconfig.
+     * @default ['*.config.ts', '*.config.mts', 'vitest.config.ts']
+     */
+    allowDefaultProject?: string[];
+    /**
+     * Enable `@prairielearn/eslint-plugin` rules.
+     * @default true
+     */
+    prairielearn?: boolean;
+    /**
+     * Options for the `@prairielearn/eslint-plugin` rules.
+     */
+    prairieLearnOptions?: PrairieLearnPluginOptions;
+    /**
+     * Global ignores to apply.
+     * Will be merged with default ignores.
+     */
+    ignores?: string[];
+    /**
+     * Disable specific config modules.
+     */
+    disable?: {
+        react?: boolean;
+        vitest?: boolean;
+        perfectionist?: boolean;
+        unicorn?: boolean;
+        jsdoc?: boolean;
+        tanstack?: boolean;
+        lodash?: boolean;
+    };
+}
+/**
+ * Creates a PrairieLearn ESLint configuration array.
+ *
+ * @example
+ * ```js
+ * // eslint.config.mjs
+ * import { prairielearn } from '@prairielearn/eslint-config';
+ *
+ * export default [
+ *   ...prairielearn({
+ *     tsconfigRootDir: import.meta.dirname,
+ *   }),
+ *   // Add your project-specific rules here
+ * ];
+ * ```
+ */
+export declare function prairielearn(options: PrairieLearnEslintConfigOptions): TSESLint.FlatConfig.ConfigArray;
+export { baseConfig } from './configs/base.js';
+export { importsConfig } from './configs/imports.js';
+export { jsdocConfig } from './configs/jsdoc.js';
+export { lodashConfig } from './configs/lodash.js';
+export { perfectionistConfig } from './configs/perfectionist.js';
+export { prairieLearnConfig, type PrairieLearnPluginOptions } from './configs/prairielearn.js';
+export { reactConfig } from './configs/react.js';
+export { stylisticConfig } from './configs/stylistic.js';
+export { tanstackConfig } from './configs/tanstack.js';
+export { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';
+export { unicornConfig } from './configs/unicorn.js';
+export { vitestConfig } from './configs/vitest.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AASzD,OAAO,EAAE,KAAK,yBAAyB,EAAsB,MAAM,2BAA2B,CAAC;AAQ/F,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAEhD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,+BAA+B,GACvC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAyFjC;AAGD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport { globalIgnores } from 'eslint/config';\nimport tseslint from 'typescript-eslint';\n\nimport { baseConfig } from './configs/base.js';\nimport { importsConfig } from './configs/imports.js';\nimport { jsdocConfig } from './configs/jsdoc.js';\nimport { lodashConfig } from './configs/lodash.js';\nimport { perfectionistConfig } from './configs/perfectionist.js';\nimport { type PrairieLearnPluginOptions, prairieLearnConfig } from './configs/prairielearn.js';\nimport { reactConfig } from './configs/react.js';\nimport { stylisticConfig } from './configs/stylistic.js';\nimport { tanstackConfig } from './configs/tanstack.js';\nimport { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';\nimport { unicornConfig } from './configs/unicorn.js';\nimport { vitestConfig } from './configs/vitest.js';\n\nexport interface PrairieLearnEslintConfigOptions {\n  /**\n   * Root directory for TypeScript project service.\n   * Required for type-aware linting.\n   */\n  tsconfigRootDir: string;\n\n  /**\n   * Glob patterns for files to apply type-aware rules to.\n   * @default ['**\\/*.{ts,tsx}']\n   */\n  typeAwareFiles?: string[];\n\n  /**\n   * Files to allow in defaultProject for type-aware linting.\n   * Useful for config files outside the main tsconfig.\n   * @default ['*.config.ts', '*.config.mts', 'vitest.config.ts']\n   */\n  allowDefaultProject?: string[];\n\n  /**\n   * Enable `@prairielearn/eslint-plugin` rules.\n   * @default true\n   */\n  prairielearn?: boolean;\n\n  /**\n   * Options for the `@prairielearn/eslint-plugin` rules.\n   */\n  prairieLearnOptions?: PrairieLearnPluginOptions;\n\n  /**\n   * Global ignores to apply.\n   * Will be merged with default ignores.\n   */\n  ignores?: string[];\n\n  /**\n   * Disable specific config modules.\n   */\n  disable?: {\n    react?: boolean;\n    vitest?: boolean;\n    perfectionist?: boolean;\n    unicorn?: boolean;\n    jsdoc?: boolean;\n    tanstack?: boolean;\n    lodash?: boolean;\n  };\n}\n\n/**\n * Creates a PrairieLearn ESLint configuration array.\n *\n * @example\n * ```js\n * // eslint.config.mjs\n * import { prairielearn } from '@prairielearn/eslint-config';\n *\n * export default [\n *   ...prairielearn({\n *     tsconfigRootDir: import.meta.dirname,\n *   }),\n *   // Add your project-specific rules here\n * ];\n * ```\n */\nexport function prairielearn(\n  options: PrairieLearnEslintConfigOptions,\n): TSESLint.FlatConfig.ConfigArray {\n  const {\n    tsconfigRootDir,\n    typeAwareFiles = ['**/*.{ts,tsx}'],\n    allowDefaultProject = ['*.config.ts', '*.config.mts', 'vitest.config.ts'],\n    prairielearn: enablePrairielearn = true,\n    prairieLearnOptions,\n    ignores = [],\n    disable = {},\n  } = options;\n\n  const jsFiles = ['**/*.{js,jsx,ts,tsx,mjs,cjs,mts,cts}'];\n\n  const configs: TSESLint.FlatConfig.ConfigArray = [\n    // Base typescript-eslint configs (scoped to JS/TS files)\n    ...tseslint.config({\n      extends: [...tseslint.configs.stylistic, ...tseslint.configs.strict],\n      files: jsFiles,\n    }),\n    // Base configs (always included)\n    ...baseConfig(),\n    // TypeScript config (scoped to JS/TS files)\n    {\n      files: jsFiles,\n      ...typescriptConfig()[0],\n    },\n    ...importsConfig(),\n    ...stylisticConfig(),\n  ];\n\n  // Optional configs\n  if (!disable.react) {\n    configs.push(...reactConfig());\n  }\n\n  if (!disable.vitest) {\n    configs.push(...vitestConfig());\n  }\n\n  if (!disable.perfectionist) {\n    configs.push(...perfectionistConfig());\n  }\n\n  if (!disable.unicorn) {\n    configs.push(...unicornConfig());\n  }\n\n  if (!disable.jsdoc) {\n    configs.push(...jsdocConfig());\n  }\n\n  if (!disable.tanstack) {\n    configs.push(...tanstackConfig());\n  }\n\n  if (!disable.lodash) {\n    configs.push(...lodashConfig());\n  }\n\n  if (enablePrairielearn) {\n    configs.push(...prairieLearnConfig(prairieLearnOptions));\n  }\n\n  // Type-aware rules (applied to specified files)\n  // We use tseslint.config() to properly handle the extends syntax\n  configs.push(\n    ...tseslint.config({\n      extends: [\n        tseslint.configs.recommendedTypeCheckedOnly,\n        tseslint.configs.stylisticTypeCheckedOnly,\n      ],\n      files: typeAwareFiles,\n      languageOptions: {\n        parserOptions: {\n          projectService: {\n            allowDefaultProject,\n          },\n          tsconfigRootDir,\n        },\n      },\n      rules: typescriptTypeAwareRules(),\n    }),\n  );\n\n  // Default ignores\n  return [\n    ...configs,\n    globalIgnores(['.yarn/*', 'node_modules/*', 'dist/*', 'coverage/*', ...ignores]),\n  ];\n}\n\n// Re-export individual configs for advanced use\nexport { baseConfig } from './configs/base.js';\nexport { importsConfig } from './configs/imports.js';\nexport { jsdocConfig } from './configs/jsdoc.js';\nexport { lodashConfig } from './configs/lodash.js';\nexport { perfectionistConfig } from './configs/perfectionist.js';\nexport { prairieLearnConfig, type PrairieLearnPluginOptions } from './configs/prairielearn.js';\nexport { reactConfig } from './configs/react.js';\nexport { stylisticConfig } from './configs/stylistic.js';\nexport { tanstackConfig } from './configs/tanstack.js';\nexport { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';\nexport { unicornConfig } from './configs/unicorn.js';\nexport { vitestConfig } from './configs/vitest.js';\n"]}

package/dist/index.js

@@ -0,0 +1,112 @@
+import { globalIgnores } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+import { baseConfig } from './configs/base.js';
+import { importsConfig } from './configs/imports.js';
+import { jsdocConfig } from './configs/jsdoc.js';
+import { lodashConfig } from './configs/lodash.js';
+import { perfectionistConfig } from './configs/perfectionist.js';
+import { prairieLearnConfig } from './configs/prairielearn.js';
+import { reactConfig } from './configs/react.js';
+import { stylisticConfig } from './configs/stylistic.js';
+import { tanstackConfig } from './configs/tanstack.js';
+import { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';
+import { unicornConfig } from './configs/unicorn.js';
+import { vitestConfig } from './configs/vitest.js';
+/**
+ * Creates a PrairieLearn ESLint configuration array.
+ *
+ * @example
+ * ```js
+ * // eslint.config.mjs
+ * import { prairielearn } from '@prairielearn/eslint-config';
+ *
+ * export default [
+ *   ...prairielearn({
+ *     tsconfigRootDir: import.meta.dirname,
+ *   }),
+ *   // Add your project-specific rules here
+ * ];
+ * ```
+ */
+export function prairielearn(options) {
+    const { tsconfigRootDir, typeAwareFiles = ['**/*.{ts,tsx}'], allowDefaultProject = ['*.config.ts', '*.config.mts', 'vitest.config.ts'], prairielearn: enablePrairielearn = true, prairieLearnOptions, ignores = [], disable = {}, } = options;
+    const jsFiles = ['**/*.{js,jsx,ts,tsx,mjs,cjs,mts,cts}'];
+    const configs = [
+        // Base typescript-eslint configs (scoped to JS/TS files)
+        ...tseslint.config({
+            extends: [...tseslint.configs.stylistic, ...tseslint.configs.strict],
+            files: jsFiles,
+        }),
+        // Base configs (always included)
+        ...baseConfig(),
+        // TypeScript config (scoped to JS/TS files)
+        {
+            files: jsFiles,
+            ...typescriptConfig()[0],
+        },
+        ...importsConfig(),
+        ...stylisticConfig(),
+    ];
+    // Optional configs
+    if (!disable.react) {
+        configs.push(...reactConfig());
+    }
+    if (!disable.vitest) {
+        configs.push(...vitestConfig());
+    }
+    if (!disable.perfectionist) {
+        configs.push(...perfectionistConfig());
+    }
+    if (!disable.unicorn) {
+        configs.push(...unicornConfig());
+    }
+    if (!disable.jsdoc) {
+        configs.push(...jsdocConfig());
+    }
+    if (!disable.tanstack) {
+        configs.push(...tanstackConfig());
+    }
+    if (!disable.lodash) {
+        configs.push(...lodashConfig());
+    }
+    if (enablePrairielearn) {
+        configs.push(...prairieLearnConfig(prairieLearnOptions));
+    }
+    // Type-aware rules (applied to specified files)
+    // We use tseslint.config() to properly handle the extends syntax
+    configs.push(...tseslint.config({
+        extends: [
+            tseslint.configs.recommendedTypeCheckedOnly,
+            tseslint.configs.stylisticTypeCheckedOnly,
+        ],
+        files: typeAwareFiles,
+        languageOptions: {
+            parserOptions: {
+                projectService: {
+                    allowDefaultProject,
+                },
+                tsconfigRootDir,
+            },
+        },
+        rules: typescriptTypeAwareRules(),
+    }));
+    // Default ignores
+    return [
+        ...configs,
+        globalIgnores(['.yarn/*', 'node_modules/*', 'dist/*', 'coverage/*', ...ignores]),
+    ];
+}
+// Re-export individual configs for advanced use
+export { baseConfig } from './configs/base.js';
+export { importsConfig } from './configs/imports.js';
+export { jsdocConfig } from './configs/jsdoc.js';
+export { lodashConfig } from './configs/lodash.js';
+export { perfectionistConfig } from './configs/perfectionist.js';
+export { prairieLearnConfig } from './configs/prairielearn.js';
+export { reactConfig } from './configs/react.js';
+export { stylisticConfig } from './configs/stylistic.js';
+export { tanstackConfig } from './configs/tanstack.js';
+export { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';
+export { unicornConfig } from './configs/unicorn.js';
+export { vitestConfig } from './configs/vitest.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAkC,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAqDnD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAwC,EACP;IACjC,MAAM,EACJ,eAAe,EACf,cAAc,GAAG,CAAC,eAAe,CAAC,EAClC,mBAAmB,GAAG,CAAC,aAAa,EAAE,cAAc,EAAE,kBAAkB,CAAC,EACzE,YAAY,EAAE,kBAAkB,GAAG,IAAI,EACvC,mBAAmB,EACnB,OAAO,GAAG,EAAE,EACZ,OAAO,GAAG,EAAE,GACb,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,CAAC,sCAAsC,CAAC,CAAC;IAEzD,MAAM,OAAO,GAAoC;QAC/C,yDAAyD;QACzD,GAAG,QAAQ,CAAC,MAAM,CAAC;YACjB,OAAO,EAAE,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;YACpE,KAAK,EAAE,OAAO;SACf,CAAC;QACF,iCAAiC;QACjC,GAAG,UAAU,EAAE;QACf,4CAA4C;QAC5C;YACE,KAAK,EAAE,OAAO;YACd,GAAG,gBAAgB,EAAE,CAAC,CAAC,CAAC;SACzB;QACD,GAAG,aAAa,EAAE;QAClB,GAAG,eAAe,EAAE;KACrB,CAAC;IAEF,mBAAmB;IACnB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,GAAG,mBAAmB,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,EAAE,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,kBAAkB,EAAE,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,gDAAgD;IAChD,iEAAiE;IACjE,OAAO,CAAC,IAAI,CACV,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjB,OAAO,EAAE;YACP,QAAQ,CAAC,OAAO,CAAC,0BAA0B;YAC3C,QAAQ,CAAC,OAAO,CAAC,wBAAwB;SAC1C;QACD,KAAK,EAAE,cAAc;QACrB,eAAe,EAAE;YACf,aAAa,EAAE;gBACb,cAAc,EAAE;oBACd,mBAAmB;iBACpB;gBACD,eAAe;aAChB;SACF;QACD,KAAK,EAAE,wBAAwB,EAAE;KAClC,CAAC,CACH,CAAC;IAEF,kBAAkB;IAClB,OAAO;QACL,GAAG,OAAO;QACV,aAAa,CAAC,CAAC,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,CAAC;KACjF,CAAC;AAAA,CACH;AAED,gDAAgD;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAkC,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport { globalIgnores } from 'eslint/config';\nimport tseslint from 'typescript-eslint';\n\nimport { baseConfig } from './configs/base.js';\nimport { importsConfig } from './configs/imports.js';\nimport { jsdocConfig } from './configs/jsdoc.js';\nimport { lodashConfig } from './configs/lodash.js';\nimport { perfectionistConfig } from './configs/perfectionist.js';\nimport { type PrairieLearnPluginOptions, prairieLearnConfig } from './configs/prairielearn.js';\nimport { reactConfig } from './configs/react.js';\nimport { stylisticConfig } from './configs/stylistic.js';\nimport { tanstackConfig } from './configs/tanstack.js';\nimport { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';\nimport { unicornConfig } from './configs/unicorn.js';\nimport { vitestConfig } from './configs/vitest.js';\n\nexport interface PrairieLearnEslintConfigOptions {\n  /**\n   * Root directory for TypeScript project service.\n   * Required for type-aware linting.\n   */\n  tsconfigRootDir: string;\n\n  /**\n   * Glob patterns for files to apply type-aware rules to.\n   * @default ['**\\/*.{ts,tsx}']\n   */\n  typeAwareFiles?: string[];\n\n  /**\n   * Files to allow in defaultProject for type-aware linting.\n   * Useful for config files outside the main tsconfig.\n   * @default ['*.config.ts', '*.config.mts', 'vitest.config.ts']\n   */\n  allowDefaultProject?: string[];\n\n  /**\n   * Enable `@prairielearn/eslint-plugin` rules.\n   * @default true\n   */\n  prairielearn?: boolean;\n\n  /**\n   * Options for the `@prairielearn/eslint-plugin` rules.\n   */\n  prairieLearnOptions?: PrairieLearnPluginOptions;\n\n  /**\n   * Global ignores to apply.\n   * Will be merged with default ignores.\n   */\n  ignores?: string[];\n\n  /**\n   * Disable specific config modules.\n   */\n  disable?: {\n    react?: boolean;\n    vitest?: boolean;\n    perfectionist?: boolean;\n    unicorn?: boolean;\n    jsdoc?: boolean;\n    tanstack?: boolean;\n    lodash?: boolean;\n  };\n}\n\n/**\n * Creates a PrairieLearn ESLint configuration array.\n *\n * @example\n * ```js\n * // eslint.config.mjs\n * import { prairielearn } from '@prairielearn/eslint-config';\n *\n * export default [\n *   ...prairielearn({\n *     tsconfigRootDir: import.meta.dirname,\n *   }),\n *   // Add your project-specific rules here\n * ];\n * ```\n */\nexport function prairielearn(\n  options: PrairieLearnEslintConfigOptions,\n): TSESLint.FlatConfig.ConfigArray {\n  const {\n    tsconfigRootDir,\n    typeAwareFiles = ['**/*.{ts,tsx}'],\n    allowDefaultProject = ['*.config.ts', '*.config.mts', 'vitest.config.ts'],\n    prairielearn: enablePrairielearn = true,\n    prairieLearnOptions,\n    ignores = [],\n    disable = {},\n  } = options;\n\n  const jsFiles = ['**/*.{js,jsx,ts,tsx,mjs,cjs,mts,cts}'];\n\n  const configs: TSESLint.FlatConfig.ConfigArray = [\n    // Base typescript-eslint configs (scoped to JS/TS files)\n    ...tseslint.config({\n      extends: [...tseslint.configs.stylistic, ...tseslint.configs.strict],\n      files: jsFiles,\n    }),\n    // Base configs (always included)\n    ...baseConfig(),\n    // TypeScript config (scoped to JS/TS files)\n    {\n      files: jsFiles,\n      ...typescriptConfig()[0],\n    },\n    ...importsConfig(),\n    ...stylisticConfig(),\n  ];\n\n  // Optional configs\n  if (!disable.react) {\n    configs.push(...reactConfig());\n  }\n\n  if (!disable.vitest) {\n    configs.push(...vitestConfig());\n  }\n\n  if (!disable.perfectionist) {\n    configs.push(...perfectionistConfig());\n  }\n\n  if (!disable.unicorn) {\n    configs.push(...unicornConfig());\n  }\n\n  if (!disable.jsdoc) {\n    configs.push(...jsdocConfig());\n  }\n\n  if (!disable.tanstack) {\n    configs.push(...tanstackConfig());\n  }\n\n  if (!disable.lodash) {\n    configs.push(...lodashConfig());\n  }\n\n  if (enablePrairielearn) {\n    configs.push(...prairieLearnConfig(prairieLearnOptions));\n  }\n\n  // Type-aware rules (applied to specified files)\n  // We use tseslint.config() to properly handle the extends syntax\n  configs.push(\n    ...tseslint.config({\n      extends: [\n        tseslint.configs.recommendedTypeCheckedOnly,\n        tseslint.configs.stylisticTypeCheckedOnly,\n      ],\n      files: typeAwareFiles,\n      languageOptions: {\n        parserOptions: {\n          projectService: {\n            allowDefaultProject,\n          },\n          tsconfigRootDir,\n        },\n      },\n      rules: typescriptTypeAwareRules(),\n    }),\n  );\n\n  // Default ignores\n  return [\n    ...configs,\n    globalIgnores(['.yarn/*', 'node_modules/*', 'dist/*', 'coverage/*', ...ignores]),\n  ];\n}\n\n// Re-export individual configs for advanced use\nexport { baseConfig } from './configs/base.js';\nexport { importsConfig } from './configs/imports.js';\nexport { jsdocConfig } from './configs/jsdoc.js';\nexport { lodashConfig } from './configs/lodash.js';\nexport { perfectionistConfig } from './configs/perfectionist.js';\nexport { prairieLearnConfig, type PrairieLearnPluginOptions } from './configs/prairielearn.js';\nexport { reactConfig } from './configs/react.js';\nexport { stylisticConfig } from './configs/stylistic.js';\nexport { tanstackConfig } from './configs/tanstack.js';\nexport { typescriptConfig, typescriptTypeAwareRules } from './configs/typescript.js';\nexport { unicornConfig } from './configs/unicorn.js';\nexport { vitestConfig } from './configs/vitest.js';\n"]}

package/package.json

@@ -1,10 +1,52 @@
 {
   "name": "@prairielearn/eslint-config",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @prairielearn/eslint-config",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "version": "1.1.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PrairieLearn/PrairieLearn.git",
+    "directory": "packages/eslint-config"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "main": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsgo",
+    "dev": "tsgo --watch --preserveWatchOutput"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@eslint-react/eslint-plugin": "^2.9.4",
+    "@eslint/eslintrc": "^3.0.0",
+    "@eslint/js": "^9.29.0",
+    "@prairielearn/eslint-plugin": "^3.1.1",
+    "@stylistic/eslint-plugin": "^5.7.0",
+    "@tanstack/eslint-plugin-query": "^5.91.2",
+    "@typescript-eslint/utils": "^8.53.0",
+    "@vitest/eslint-plugin": "^1.6.6",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-jsdoc": "^62.0.0",
+    "eslint-plugin-jsx-a11y-x": "^0.1.1",
+    "eslint-plugin-no-floating-promise": "^2.0.0",
+    "eslint-plugin-perfectionist": "^5.3.1",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-you-might-not-need-an-effect": "^0.8.5",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "eslint-plugin-you-dont-need-lodash-underscore": "^6.14.0",
+    "globals": "^16.5.0",
+    "typescript-eslint": "^8.53.0"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "^2.0.0",
+    "@types/node": "^24.10.9",
+    "@typescript/native-preview": "^7.0.0-dev.20260106.1"
+  }
 }

package/src/configs/base.ts

@@ -0,0 +1,127 @@
+import js from '@eslint/js';
+import type { TSESLint } from '@typescript-eslint/utils';
+import noFloatingPromise from 'eslint-plugin-no-floating-promise';
+import globals from 'globals';
+
+/**
+ * Base JavaScript/TypeScript configuration.
+ * Core rules that apply to all JS/TS files.
+ */
+export function baseConfig(): TSESLint.FlatConfig.ConfigArray {
+  return [
+    {
+      languageOptions: {
+        globals: { ...globals.node },
+      },
+
+      linterOptions: {
+        reportUnusedDisableDirectives: 'error',
+      },
+
+      plugins: {
+        'no-floating-promise': noFloatingPromise,
+      },
+
+      rules: {
+        ...js.configs.all.rules,
+        'array-callback-return': 'off',
+        'arrow-body-style': 'off',
+        camelcase: 'off',
+        'capitalized-comments': 'off',
+        'class-methods-use-this': 'off',
+        complexity: 'off',
+        'consistent-return': 'off',
+        'consistent-this': 'off',
+        curly: ['error', 'multi-line', 'consistent'],
+        'default-case': 'off',
+        'dot-notation': 'off',
+        eqeqeq: ['error', 'smart'],
+        'func-names': 'off',
+        'func-style': 'off',
+        'guard-for-in': 'off',
+        'handle-callback-err': 'error',
+        'id-length': 'off',
+        'init-declarations': 'off',
+        'logical-assignment-operators': 'off',
+        'max-classes-per-file': 'off',
+        'max-depth': 'off',
+        'max-lines': 'off',
+        'max-lines-per-function': 'off',
+        'max-params': ['error', { max: 6 }],
+        'max-statements': 'off',
+        'new-cap': 'off',
+        'no-await-in-loop': 'off',
+        'no-bitwise': 'off',
+        'no-console': ['error', { allow: ['warn', 'error', 'table', 'trace'] }],
+        'no-continue': 'off',
+        'no-duplicate-imports': 'error',
+        'no-else-return': 'off',
+        'no-empty-function': 'off',
+        'no-eq-null': 'off',
+        'no-implicit-coercion': 'off',
+        'no-inline-comments': 'off',
+        'no-invalid-this': 'off',
+        'no-lonely-if': 'off',
+        'no-loop-func': 'off',
+        'no-magic-numbers': 'off',
+        'no-negated-condition': 'off',
+        'no-nested-ternary': 'off',
+        'no-new': 'off',
+        'no-param-reassign': 'off',
+        'no-plusplus': 'off',
+        'no-promise-executor-return': 'off',
+        'no-redeclare': 'off',
+        'no-restricted-globals': [
+          'error',
+          // These are not available in ES modules.
+          '__filename',
+          '__dirname',
+        ],
+        'no-shadow': 'off',
+        'no-template-curly-in-string': 'error',
+        'no-ternary': 'off',
+        'no-undef': 'off',
+        'no-undef-init': 'off',
+        'no-undefined': 'off',
+        'no-underscore-dangle': 'off',
+        'no-unmodified-loop-condition': 'off',
+        'no-unneeded-ternary': 'off',
+        'no-unused-vars': 'off',
+        'no-use-before-define': 'off',
+        'no-useless-assignment': 'off',
+        'no-useless-concat': 'off',
+        'no-useless-constructor': 'off',
+        'no-useless-return': 'off',
+        'no-void': 'off', // https://typescript-eslint.io/rules/no-floating-promises/#ignorevoid
+        'no-warning-comments': 'off',
+        'object-shorthand': 'error',
+        'one-var': ['off', 'never'],
+        'prefer-arrow-callback': 'off',
+        'prefer-const': ['error', { destructuring: 'all' }],
+        'prefer-destructuring': 'off',
+        'prefer-named-capture-group': 'off',
+        'prefer-object-has-own': 'off',
+        'prefer-template': 'off',
+        radix: ['error', 'as-needed'],
+        'require-atomic-updates': 'off',
+        'require-await': 'off',
+        'require-unicode-regexp': 'off',
+        'sort-vars': 'off',
+        'sort-keys': 'off',
+
+        // Floating promise detection
+        'no-floating-promise/no-floating-promise': 'error',
+
+        // Sort imports within a single import statement
+        'sort-imports': [
+          'error',
+          {
+            ignoreDeclarationSort: true,
+            ignoreMemberSort: false,
+            memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+          },
+        ],
+      },
+    },
+  ];
+}

package/src/configs/imports.ts

@@ -0,0 +1,50 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+import importX from 'eslint-plugin-import-x';
+
+/**
+ * Import ordering and resolution rules.
+ */
+export function importsConfig(): TSESLint.FlatConfig.ConfigArray {
+  return [
+    {
+      plugins: {
+        'import-x': importX,
+      },
+
+      rules: {
+        // Enforce alphabetical order of import specifiers within each import group.
+        // The import-x/order rule handles the overall sorting of the import groups.
+        'import-x/order': [
+          'error',
+          {
+            alphabetize: {
+              order: 'asc',
+            },
+
+            'newlines-between': 'always',
+
+            pathGroups: [
+              {
+                group: 'external',
+                pattern: '@prairielearn/**',
+                position: 'after',
+              },
+            ],
+
+            pathGroupsExcludedImportTypes: ['builtin'],
+          },
+        ],
+      },
+
+      settings: {
+        'import-x/parsers': {
+          '@typescript-eslint/parser': ['.ts', '.js'],
+        },
+        'import-x/resolver': {
+          node: true,
+          typescript: true,
+        },
+      },
+    },
+  ];
+}

package/src/configs/jsdoc.ts

@@ -0,0 +1,72 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+import jsdoc from 'eslint-plugin-jsdoc';
+
+/**
+ * JSDoc documentation rules.
+ */
+export function jsdocConfig(): TSESLint.FlatConfig.ConfigArray {
+  return [
+    {
+      plugins: {
+        jsdoc,
+      },
+
+      settings: {
+        jsdoc: {
+          contexts: [
+            // We don't want to require documentation of a 'locals' (res.locals) variable
+            // AST Parser: https://github.com/es-joy/jsdoccomment
+            {
+              comment: 'JsdocBlock:not(:has(JsdocTag[tag="param"][name="locals"]))',
+              context: 'FunctionDeclaration',
+            },
+            {
+              comment: 'JsdocBlock:not(:has(JsdocTag[tag="param"][name="locals"]))',
+              context: 'FunctionExpression',
+            },
+            'ArrowFunctionExpression',
+            'TSDeclareFunction',
+          ],
+          exemptDestructuredRootsFromChecks: true,
+        },
+      },
+    },
+    // TypeScript files
+    {
+      files: ['**/*.{ts,tsx}'],
+      rules: {
+        ...jsdoc.configs['flat/recommended-typescript-error'].rules,
+        'jsdoc/check-line-alignment': 'error',
+        'jsdoc/check-tag-names': ['error', { definedTags: ['knipignore'] }],
+        'jsdoc/convert-to-jsdoc-comments': [
+          'error',
+          {
+            allowedPrefixes: ['@ts-', 'istanbul ', 'c8 ', 'v8 ', 'eslint', 'prettier-', 'global'],
+            contexts: ['FunctionDeclaration', 'TSDeclareFunction'],
+            contextsBeforeAndAfter: ['TSPropertySignature'],
+            enforceJsdocLineStyle: 'single',
+          },
+        ],
+        'jsdoc/require-asterisk-prefix': 'error',
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/tag-lines': 'off',
+      },
+    },
+    // JavaScript files
+    {
+      files: ['**/*.js'],
+      rules: {
+        ...jsdoc.configs['flat/recommended-typescript-flavor-error'].rules,
+        'jsdoc/check-line-alignment': 'error',
+        'jsdoc/require-asterisk-prefix': 'error',
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param': 'off',
+        'jsdoc/require-param-description': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/tag-lines': 'off',
+      },
+    },
+  ];
+}

package/src/configs/lodash.ts

@@ -0,0 +1,26 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import type { TSESLint } from '@typescript-eslint/utils';
+import youDontNeedLodashUnderscore from 'eslint-plugin-you-dont-need-lodash-underscore';
+
+const compat = new FlatCompat();
+
+/**
+ * Lodash/underscore replacement rules.
+ */
+export function lodashConfig(): TSESLint.FlatConfig.ConfigArray {
+  return [
+    {
+      plugins: {
+        'you-dont-need-lodash-underscore': youDontNeedLodashUnderscore,
+      },
+    },
+    // Use FlatCompat to extend the legacy config
+    ...compat.extends('plugin:you-dont-need-lodash-underscore/all'),
+    {
+      rules: {
+        // The _.omit function is still useful in some contexts.
+        'you-dont-need-lodash-underscore/omit': 'off',
+      },
+    },
+  ];
+}

package/src/configs/perfectionist.ts

@@ -0,0 +1,48 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+import perfectionist from 'eslint-plugin-perfectionist';
+
+/**
+ * Perfectionist sorting rules.
+ * Most rules are off by default but pre-configured for convenient inline enabling.
+ * `sort-jsx-props` is enabled by default with callback grouping.
+ */
+export function perfectionistConfig(): TSESLint.FlatConfig.ConfigArray {
+  return [
+    {
+      plugins: {
+        perfectionist,
+      },
+
+      rules: {
+        // Configure all perfectionist rules to be off by default but with options preset
+        ...Object.fromEntries(
+          Object.keys(perfectionist.rules ?? {}).map((ruleName) => [
+            'perfectionist/' + ruleName,
+            [
+              // Configure the options for every rule, to make inline usage more convenient.
+              'off',
+              // These rules don't have a comment partition
+              ['sort-heritage-clauses', 'sort-jsx-props', 'sort-switch-case'].includes(ruleName)
+                ? { type: 'natural' }
+                : { partitionByComment: true, type: 'natural' },
+            ],
+          ]),
+        ),
+
+        // Enable sort-jsx-props with callback grouping
+        'perfectionist/sort-jsx-props': [
+          'error',
+          {
+            customGroups: [
+              { elementNamePattern: '^on[A-Z]', groupName: 'callback' },
+              { elementNamePattern: '^(key|ref)$', groupName: 'reserved' },
+            ],
+            groups: ['reserved', 'unknown', 'shorthand-prop', 'callback'],
+            ignoreCase: true,
+            type: 'unsorted',
+          },
+        ],
+      },
+    },
+  ];
+}

package/src/configs/prairielearn.ts

@@ -0,0 +1,42 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+
+import prairielearn from '@prairielearn/eslint-plugin';
+
+export interface PrairieLearnPluginOptions {
+  /**
+   * Types to allow when using the safe-db-types rule.
+   */
+  allowDbTypes?: string[];
+}
+
+/**
+ * PrairieLearn-specific ESLint plugin rules.
+ * Includes AWS client configuration, JSX safety, SQL blocks, and database type safety.
+ */
+export function prairieLearnConfig(
+  options?: PrairieLearnPluginOptions,
+): TSESLint.FlatConfig.ConfigArray {
+  const { allowDbTypes = [] } = options ?? {};
+
+  return [
+    {
+      plugins: {
+        '@prairielearn': prairielearn,
+      },
+
+      rules: {
+        '@prairielearn/aws-client-mandatory-config': 'error',
+        '@prairielearn/aws-client-shared-config': 'error',
+        '@prairielearn/jsx-no-dollar-interpolation': 'error',
+        '@prairielearn/no-current-target-in-callback': 'error',
+        '@prairielearn/no-unused-sql-blocks': 'error',
+        '@prairielearn/safe-db-types': [
+          'error',
+          {
+            allowDbTypes,
+          },
+        ],
+      },
+    },
+  ];
+}