@prairielearn/eslint-config 0.0.1 → 1.0.0

package/README.md

@@ -1,45 +1,113 @@
 # @prairielearn/eslint-config
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@prairielearn/eslint-config`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+Shared ESLint configuration for PrairieLearn projects.
+
+## Installation
+
+```bash
+npm install @prairielearn/eslint-config
+# or
+yarn add @prairielearn/eslint-config
+```
+
+## Usage
+
+Create an `eslint.config.mjs` file in your project root:
+
+```js
+import { prairielearn } from '@prairielearn/eslint-config';
+
+export default [
+  ...prairielearn({
+    tsconfigRootDir: import.meta.dirname,
+  }),
+  // Add your project-specific rules here
+];
+```
+
+## Options
+
+| Option                | Type       | Default                                               | Description                                             |
+| --------------------- | ---------- | ----------------------------------------------------- | ------------------------------------------------------- |
+| `tsconfigRootDir`     | `string`   | _required_                                            | Root directory for TypeScript project service           |
+| `typeAwareFiles`      | `string[]` | `['**/*.{ts,tsx}']`                                   | Glob patterns for files to apply type-aware rules to    |
+| `allowDefaultProject` | `string[]` | `['*.config.ts', '*.config.mts', 'vitest.config.ts']` | Files to allow in defaultProject for type-aware linting |
+| `prairielearn`        | `boolean`  | `true`                                                | Enable `@prairielearn/eslint-plugin` rules              |
+| `prairieLearnOptions` | `object`   | `{}`                                                  | Options for `@prairielearn/eslint-plugin` (see below)   |
+| `ignores`             | `string[]` | `[]`                                                  | Additional global ignores                               |
+| `disable`             | `object`   | `{}`                                                  | Disable specific config modules                         |
+
+### Disabling Config Modules
+
+You can disable specific config modules:
+
+```js
+...prairielearn({
+  tsconfigRootDir: import.meta.dirname,
+  disable: {
+    react: true,      // Disable React/hooks/accessibility rules
+    vitest: true,     // Disable Vitest test rules
+    perfectionist: true, // Disable sorting rules
+    unicorn: true,    // Disable Unicorn rules
+    jsdoc: true,      // Disable JSDoc rules
+    tanstack: true,   // Disable TanStack Query rules
+    lodash: true,     // Disable lodash replacement rules
+  },
+});
+```
+
+### PrairieLearn Plugin Options
+
+The `prairieLearnOptions` object accepts:
+
+| Option         | Type       | Default | Description                                     |
+| -------------- | ---------- | ------- | ----------------------------------------------- |
+| `allowDbTypes` | `string[]` | `[]`    | Type names to allow in the `safe-db-types` rule |
+
+Example:
+
+```js
+...prairielearn({
+  tsconfigRootDir: import.meta.dirname,
+  prairieLearnOptions: {
+    allowDbTypes: ['SprocUsersGetDisplayedRoleSchema'],
+  },
+});
+```
+
+## Included Plugins
+
+This config includes rules from:
+
+- `@typescript-eslint` - TypeScript-specific rules
+- `@eslint-react` - React best practices
+- `react-hooks` - React Hooks rules
+- `jsx-a11y-x` - Accessibility rules
+- `import-x` - Import ordering
+- `perfectionist` - Code sorting
+- `unicorn` - JavaScript best practices
+- `vitest` - Test framework rules
+- `jsdoc` - Documentation rules
+- `@stylistic` - Code style rules
+- `@tanstack/query` - React Query rules
+- `@prairielearn/eslint-plugin` - PrairieLearn-specific rules
+
+## Advanced Usage
+
+For advanced customization, you can import individual config functions. Note that type-aware linting requires the `tsconfigRootDir` option which is only configured by the main `prairielearn()` function:
+
+```js
+import {
+  baseConfig,
+  typescriptConfig,
+  reactConfig,
+  importsConfig,
+  // ... etc
+} from '@prairielearn/eslint-config';
+
+export default [
+  ...baseConfig(),
+  ...typescriptConfig(),
+  // Mix and match as needed
+];
+```

package/dist/configs/base.d.ts

@@ -0,0 +1,7 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+/**
+ * Base JavaScript/TypeScript configuration.
+ * Core rules that apply to all JS/TS files.
+ */
+export declare function baseConfig(): TSESLint.FlatConfig.ConfigArray;
+//# sourceMappingURL=base.d.ts.map

package/dist/configs/base.d.ts.map

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

package/dist/configs/base.js

@@ -0,0 +1,121 @@
+import js from '@eslint/js';
+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() {
+    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': 'off',
+                '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'],
+                    },
+                ],
+            },
+        },
+    ];
+}
+//# sourceMappingURL=base.js.map

package/dist/configs/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/configs/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B;;;GAGG;AACH,MAAM,UAAU,UAAU,GAAoC;IAC5D,OAAO;QACL;YACE,eAAe,EAAE;gBACf,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE;aAC7B;YAED,aAAa,EAAE;gBACb,6BAA6B,EAAE,OAAO;aACvC;YAED,OAAO,EAAE;gBACP,qBAAqB,EAAE,iBAAiB;aACzC;YAED,KAAK,EAAE;gBACL,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK;gBACvB,uBAAuB,EAAE,KAAK;gBAC9B,kBAAkB,EAAE,KAAK;gBACzB,SAAS,EAAE,KAAK;gBAChB,sBAAsB,EAAE,KAAK;gBAC7B,wBAAwB,EAAE,KAAK;gBAC/B,UAAU,EAAE,KAAK;gBACjB,mBAAmB,EAAE,KAAK;gBAC1B,iBAAiB,EAAE,KAAK;gBACxB,KAAK,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;gBAC5C,cAAc,EAAE,KAAK;gBACrB,cAAc,EAAE,KAAK;gBACrB,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;gBAC1B,YAAY,EAAE,KAAK;gBACnB,YAAY,EAAE,KAAK;gBACnB,cAAc,EAAE,KAAK;gBACrB,qBAAqB,EAAE,OAAO;gBAC9B,WAAW,EAAE,KAAK;gBAClB,mBAAmB,EAAE,KAAK;gBAC1B,8BAA8B,EAAE,KAAK;gBACrC,sBAAsB,EAAE,KAAK;gBAC7B,WAAW,EAAE,KAAK;gBAClB,WAAW,EAAE,KAAK;gBAClB,wBAAwB,EAAE,KAAK;gBAC/B,YAAY,EAAE,KAAK;gBACnB,gBAAgB,EAAE,KAAK;gBACvB,SAAS,EAAE,KAAK;gBAChB,kBAAkB,EAAE,KAAK;gBACzB,YAAY,EAAE,KAAK;gBACnB,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;gBACvE,aAAa,EAAE,KAAK;gBACpB,sBAAsB,EAAE,OAAO;gBAC/B,gBAAgB,EAAE,KAAK;gBACvB,mBAAmB,EAAE,KAAK;gBAC1B,YAAY,EAAE,KAAK;gBACnB,sBAAsB,EAAE,KAAK;gBAC7B,oBAAoB,EAAE,KAAK;gBAC3B,iBAAiB,EAAE,KAAK;gBACxB,cAAc,EAAE,KAAK;gBACrB,cAAc,EAAE,KAAK;gBACrB,kBAAkB,EAAE,KAAK;gBACzB,sBAAsB,EAAE,KAAK;gBAC7B,mBAAmB,EAAE,KAAK;gBAC1B,QAAQ,EAAE,KAAK;gBACf,mBAAmB,EAAE,KAAK;gBAC1B,aAAa,EAAE,KAAK;gBACpB,4BAA4B,EAAE,KAAK;gBACnC,cAAc,EAAE,KAAK;gBACrB,uBAAuB,EAAE;oBACvB,OAAO;oBACP,yCAAyC;oBACzC,YAAY;oBACZ,WAAW;iBACZ;gBACD,WAAW,EAAE,KAAK;gBAClB,6BAA6B,EAAE,OAAO;gBACtC,YAAY,EAAE,KAAK;gBACnB,UAAU,EAAE,KAAK;gBACjB,eAAe,EAAE,KAAK;gBACtB,cAAc,EAAE,KAAK;gBACrB,sBAAsB,EAAE,KAAK;gBAC7B,8BAA8B,EAAE,KAAK;gBACrC,qBAAqB,EAAE,KAAK;gBAC5B,gBAAgB,EAAE,KAAK;gBACvB,sBAAsB,EAAE,KAAK;gBAC7B,uBAAuB,EAAE,KAAK;gBAC9B,mBAAmB,EAAE,KAAK;gBAC1B,wBAAwB,EAAE,KAAK;gBAC/B,mBAAmB,EAAE,KAAK;gBAC1B,SAAS,EAAE,KAAK,EAAE,sEAAsE;gBACxF,qBAAqB,EAAE,KAAK;gBAC5B,kBAAkB,EAAE,OAAO;gBAC3B,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC3B,uBAAuB,EAAE,KAAK;gBAC9B,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;gBACnD,sBAAsB,EAAE,KAAK;gBAC7B,4BAA4B,EAAE,KAAK;gBACnC,uBAAuB,EAAE,KAAK;gBAC9B,iBAAiB,EAAE,KAAK;gBACxB,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;gBAC7B,wBAAwB,EAAE,KAAK;gBAC/B,eAAe,EAAE,KAAK;gBACtB,wBAAwB,EAAE,KAAK;gBAC/B,WAAW,EAAE,KAAK;gBAClB,WAAW,EAAE,KAAK;gBAElB,6BAA6B;gBAC7B,yCAAyC,EAAE,OAAO;gBAElD,gDAAgD;gBAChD,cAAc,EAAE;oBACd,OAAO;oBACP;wBACE,qBAAqB,EAAE,IAAI;wBAC3B,gBAAgB,EAAE,KAAK;wBACvB,qBAAqB,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC;qBAC7D;iBACF;aACF;SACF;KACF,CAAC;AAAA,CACH","sourcesContent":["import js from '@eslint/js';\nimport type { TSESLint } from '@typescript-eslint/utils';\nimport noFloatingPromise from 'eslint-plugin-no-floating-promise';\nimport globals from 'globals';\n\n/**\n * Base JavaScript/TypeScript configuration.\n * Core rules that apply to all JS/TS files.\n */\nexport function baseConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      languageOptions: {\n        globals: { ...globals.node },\n      },\n\n      linterOptions: {\n        reportUnusedDisableDirectives: 'error',\n      },\n\n      plugins: {\n        'no-floating-promise': noFloatingPromise,\n      },\n\n      rules: {\n        ...js.configs.all.rules,\n        'array-callback-return': 'off',\n        'arrow-body-style': 'off',\n        camelcase: 'off',\n        'capitalized-comments': 'off',\n        'class-methods-use-this': 'off',\n        complexity: 'off',\n        'consistent-return': 'off',\n        'consistent-this': 'off',\n        curly: ['error', 'multi-line', 'consistent'],\n        'default-case': 'off',\n        'dot-notation': 'off',\n        eqeqeq: ['error', 'smart'],\n        'func-names': 'off',\n        'func-style': 'off',\n        'guard-for-in': 'off',\n        'handle-callback-err': 'error',\n        'id-length': 'off',\n        'init-declarations': 'off',\n        'logical-assignment-operators': 'off',\n        'max-classes-per-file': 'off',\n        'max-depth': 'off',\n        'max-lines': 'off',\n        'max-lines-per-function': 'off',\n        'max-params': 'off',\n        'max-statements': 'off',\n        'new-cap': 'off',\n        'no-await-in-loop': 'off',\n        'no-bitwise': 'off',\n        'no-console': ['error', { allow: ['warn', 'error', 'table', 'trace'] }],\n        'no-continue': 'off',\n        'no-duplicate-imports': 'error',\n        'no-else-return': 'off',\n        'no-empty-function': 'off',\n        'no-eq-null': 'off',\n        'no-implicit-coercion': 'off',\n        'no-inline-comments': 'off',\n        'no-invalid-this': 'off',\n        'no-lonely-if': 'off',\n        'no-loop-func': 'off',\n        'no-magic-numbers': 'off',\n        'no-negated-condition': 'off',\n        'no-nested-ternary': 'off',\n        'no-new': 'off',\n        'no-param-reassign': 'off',\n        'no-plusplus': 'off',\n        'no-promise-executor-return': 'off',\n        'no-redeclare': 'off',\n        'no-restricted-globals': [\n          'error',\n          // These are not available in ES modules.\n          '__filename',\n          '__dirname',\n        ],\n        'no-shadow': 'off',\n        'no-template-curly-in-string': 'error',\n        'no-ternary': 'off',\n        'no-undef': 'off',\n        'no-undef-init': 'off',\n        'no-undefined': 'off',\n        'no-underscore-dangle': 'off',\n        'no-unmodified-loop-condition': 'off',\n        'no-unneeded-ternary': 'off',\n        'no-unused-vars': 'off',\n        'no-use-before-define': 'off',\n        'no-useless-assignment': 'off',\n        'no-useless-concat': 'off',\n        'no-useless-constructor': 'off',\n        'no-useless-return': 'off',\n        'no-void': 'off', // https://typescript-eslint.io/rules/no-floating-promises/#ignorevoid\n        'no-warning-comments': 'off',\n        'object-shorthand': 'error',\n        'one-var': ['off', 'never'],\n        'prefer-arrow-callback': 'off',\n        'prefer-const': ['error', { destructuring: 'all' }],\n        'prefer-destructuring': 'off',\n        'prefer-named-capture-group': 'off',\n        'prefer-object-has-own': 'off',\n        'prefer-template': 'off',\n        radix: ['error', 'as-needed'],\n        'require-atomic-updates': 'off',\n        'require-await': 'off',\n        'require-unicode-regexp': 'off',\n        'sort-vars': 'off',\n        'sort-keys': 'off',\n\n        // Floating promise detection\n        'no-floating-promise/no-floating-promise': 'error',\n\n        // Sort imports within a single import statement\n        'sort-imports': [\n          'error',\n          {\n            ignoreDeclarationSort: true,\n            ignoreMemberSort: false,\n            memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],\n          },\n        ],\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/imports.d.ts

@@ -0,0 +1,6 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+/**
+ * Import ordering and resolution rules.
+ */
+export declare function importsConfig(): TSESLint.FlatConfig.ConfigArray;
+//# sourceMappingURL=imports.d.ts.map

package/dist/configs/imports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imports.d.ts","sourceRoot":"","sources":["../../src/configs/imports.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAGzD;;GAEG;AACH,wBAAgB,aAAa,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CA2C/D","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport importX from 'eslint-plugin-import-x';\n\n/**\n * Import ordering and resolution rules.\n */\nexport function importsConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        'import-x': importX,\n      },\n\n      rules: {\n        // Enforce alphabetical order of import specifiers within each import group.\n        // The import-x/order rule handles the overall sorting of the import groups.\n        'import-x/order': [\n          'error',\n          {\n            alphabetize: {\n              order: 'asc',\n            },\n\n            'newlines-between': 'always',\n\n            pathGroups: [\n              {\n                group: 'external',\n                pattern: '@prairielearn/**',\n                position: 'after',\n              },\n            ],\n\n            pathGroupsExcludedImportTypes: ['builtin'],\n          },\n        ],\n      },\n\n      settings: {\n        'import-x/parsers': {\n          '@typescript-eslint/parser': ['.ts', '.js'],\n        },\n        'import-x/resolver': {\n          node: true,\n          typescript: true,\n        },\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/imports.js

@@ -0,0 +1,44 @@
+import importX from 'eslint-plugin-import-x';
+/**
+ * Import ordering and resolution rules.
+ */
+export function importsConfig() {
+    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,
+                },
+            },
+        },
+    ];
+}
+//# sourceMappingURL=imports.js.map

package/dist/configs/imports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"imports.js","sourceRoot":"","sources":["../../src/configs/imports.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,wBAAwB,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,aAAa,GAAoC;IAC/D,OAAO;QACL;YACE,OAAO,EAAE;gBACP,UAAU,EAAE,OAAO;aACpB;YAED,KAAK,EAAE;gBACL,4EAA4E;gBAC5E,4EAA4E;gBAC5E,gBAAgB,EAAE;oBAChB,OAAO;oBACP;wBACE,WAAW,EAAE;4BACX,KAAK,EAAE,KAAK;yBACb;wBAED,kBAAkB,EAAE,QAAQ;wBAE5B,UAAU,EAAE;4BACV;gCACE,KAAK,EAAE,UAAU;gCACjB,OAAO,EAAE,kBAAkB;gCAC3B,QAAQ,EAAE,OAAO;6BAClB;yBACF;wBAED,6BAA6B,EAAE,CAAC,SAAS,CAAC;qBAC3C;iBACF;aACF;YAED,QAAQ,EAAE;gBACR,kBAAkB,EAAE;oBAClB,2BAA2B,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;iBAC5C;gBACD,mBAAmB,EAAE;oBACnB,IAAI,EAAE,IAAI;oBACV,UAAU,EAAE,IAAI;iBACjB;aACF;SACF;KACF,CAAC;AAAA,CACH","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport importX from 'eslint-plugin-import-x';\n\n/**\n * Import ordering and resolution rules.\n */\nexport function importsConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        'import-x': importX,\n      },\n\n      rules: {\n        // Enforce alphabetical order of import specifiers within each import group.\n        // The import-x/order rule handles the overall sorting of the import groups.\n        'import-x/order': [\n          'error',\n          {\n            alphabetize: {\n              order: 'asc',\n            },\n\n            'newlines-between': 'always',\n\n            pathGroups: [\n              {\n                group: 'external',\n                pattern: '@prairielearn/**',\n                position: 'after',\n              },\n            ],\n\n            pathGroupsExcludedImportTypes: ['builtin'],\n          },\n        ],\n      },\n\n      settings: {\n        'import-x/parsers': {\n          '@typescript-eslint/parser': ['.ts', '.js'],\n        },\n        'import-x/resolver': {\n          node: true,\n          typescript: true,\n        },\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/jsdoc.d.ts

@@ -0,0 +1,6 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+/**
+ * JSDoc documentation rules.
+ */
+export declare function jsdocConfig(): TSESLint.FlatConfig.ConfigArray;
+//# sourceMappingURL=jsdoc.d.ts.map

package/dist/configs/jsdoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../../src/configs/jsdoc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAGzD;;GAEG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAiE7D","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport jsdoc from 'eslint-plugin-jsdoc';\n\n/**\n * JSDoc documentation rules.\n */\nexport function jsdocConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        jsdoc,\n      },\n\n      settings: {\n        jsdoc: {\n          contexts: [\n            // We don't want to require documentation of a 'locals' (res.locals) variable\n            // AST Parser: https://github.com/es-joy/jsdoccomment\n            {\n              comment: 'JsdocBlock:not(:has(JsdocTag[tag=\"param\"][name=\"locals\"]))',\n              context: 'FunctionDeclaration',\n            },\n            {\n              comment: 'JsdocBlock:not(:has(JsdocTag[tag=\"param\"][name=\"locals\"]))',\n              context: 'FunctionExpression',\n            },\n            'ArrowFunctionExpression',\n            'TSDeclareFunction',\n          ],\n          exemptDestructuredRootsFromChecks: true,\n        },\n      },\n    },\n    // TypeScript files\n    {\n      files: ['**/*.{ts,tsx}'],\n      rules: {\n        ...jsdoc.configs['flat/recommended-typescript-error'].rules,\n        'jsdoc/check-line-alignment': 'error',\n        'jsdoc/check-tag-names': 'error',\n        'jsdoc/convert-to-jsdoc-comments': [\n          'error',\n          {\n            allowedPrefixes: ['@ts-', 'istanbul ', 'c8 ', 'v8 ', 'eslint', 'prettier-', 'global'],\n            contexts: ['FunctionDeclaration', 'TSDeclareFunction'],\n            contextsBeforeAndAfter: ['TSPropertySignature'],\n            enforceJsdocLineStyle: 'single',\n          },\n        ],\n        'jsdoc/require-asterisk-prefix': 'error',\n        'jsdoc/require-jsdoc': 'off',\n        'jsdoc/require-param': 'off',\n        'jsdoc/require-returns': 'off',\n        'jsdoc/tag-lines': 'off',\n      },\n    },\n    // JavaScript files\n    {\n      files: ['**/*.js'],\n      rules: {\n        ...jsdoc.configs['flat/recommended-typescript-flavor-error'].rules,\n        'jsdoc/check-line-alignment': 'error',\n        'jsdoc/require-asterisk-prefix': 'error',\n        'jsdoc/require-jsdoc': 'off',\n        'jsdoc/require-param': 'off',\n        'jsdoc/require-param-description': 'off',\n        'jsdoc/require-returns': 'off',\n        'jsdoc/tag-lines': 'off',\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/jsdoc.js

@@ -0,0 +1,70 @@
+import jsdoc from 'eslint-plugin-jsdoc';
+/**
+ * JSDoc documentation rules.
+ */
+export function jsdocConfig() {
+    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',
+                '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',
+            },
+        },
+    ];
+}
+//# sourceMappingURL=jsdoc.js.map

package/dist/configs/jsdoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.js","sourceRoot":"","sources":["../../src/configs/jsdoc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,qBAAqB,CAAC;AAExC;;GAEG;AACH,MAAM,UAAU,WAAW,GAAoC;IAC7D,OAAO;QACL;YACE,OAAO,EAAE;gBACP,KAAK;aACN;YAED,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,QAAQ,EAAE;wBACR,6EAA6E;wBAC7E,qDAAqD;wBACrD;4BACE,OAAO,EAAE,4DAA4D;4BACrE,OAAO,EAAE,qBAAqB;yBAC/B;wBACD;4BACE,OAAO,EAAE,4DAA4D;4BACrE,OAAO,EAAE,oBAAoB;yBAC9B;wBACD,yBAAyB;wBACzB,mBAAmB;qBACpB;oBACD,iCAAiC,EAAE,IAAI;iBACxC;aACF;SACF;QACD,mBAAmB;QACnB;YACE,KAAK,EAAE,CAAC,eAAe,CAAC;YACxB,KAAK,EAAE;gBACL,GAAG,KAAK,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC,KAAK;gBAC3D,4BAA4B,EAAE,OAAO;gBACrC,uBAAuB,EAAE,OAAO;gBAChC,iCAAiC,EAAE;oBACjC,OAAO;oBACP;wBACE,eAAe,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC;wBACrF,QAAQ,EAAE,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;wBACtD,sBAAsB,EAAE,CAAC,qBAAqB,CAAC;wBAC/C,qBAAqB,EAAE,QAAQ;qBAChC;iBACF;gBACD,+BAA+B,EAAE,OAAO;gBACxC,qBAAqB,EAAE,KAAK;gBAC5B,qBAAqB,EAAE,KAAK;gBAC5B,uBAAuB,EAAE,KAAK;gBAC9B,iBAAiB,EAAE,KAAK;aACzB;SACF;QACD,mBAAmB;QACnB;YACE,KAAK,EAAE,CAAC,SAAS,CAAC;YAClB,KAAK,EAAE;gBACL,GAAG,KAAK,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC,KAAK;gBAClE,4BAA4B,EAAE,OAAO;gBACrC,+BAA+B,EAAE,OAAO;gBACxC,qBAAqB,EAAE,KAAK;gBAC5B,qBAAqB,EAAE,KAAK;gBAC5B,iCAAiC,EAAE,KAAK;gBACxC,uBAAuB,EAAE,KAAK;gBAC9B,iBAAiB,EAAE,KAAK;aACzB;SACF;KACF,CAAC;AAAA,CACH","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport jsdoc from 'eslint-plugin-jsdoc';\n\n/**\n * JSDoc documentation rules.\n */\nexport function jsdocConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        jsdoc,\n      },\n\n      settings: {\n        jsdoc: {\n          contexts: [\n            // We don't want to require documentation of a 'locals' (res.locals) variable\n            // AST Parser: https://github.com/es-joy/jsdoccomment\n            {\n              comment: 'JsdocBlock:not(:has(JsdocTag[tag=\"param\"][name=\"locals\"]))',\n              context: 'FunctionDeclaration',\n            },\n            {\n              comment: 'JsdocBlock:not(:has(JsdocTag[tag=\"param\"][name=\"locals\"]))',\n              context: 'FunctionExpression',\n            },\n            'ArrowFunctionExpression',\n            'TSDeclareFunction',\n          ],\n          exemptDestructuredRootsFromChecks: true,\n        },\n      },\n    },\n    // TypeScript files\n    {\n      files: ['**/*.{ts,tsx}'],\n      rules: {\n        ...jsdoc.configs['flat/recommended-typescript-error'].rules,\n        'jsdoc/check-line-alignment': 'error',\n        'jsdoc/check-tag-names': 'error',\n        'jsdoc/convert-to-jsdoc-comments': [\n          'error',\n          {\n            allowedPrefixes: ['@ts-', 'istanbul ', 'c8 ', 'v8 ', 'eslint', 'prettier-', 'global'],\n            contexts: ['FunctionDeclaration', 'TSDeclareFunction'],\n            contextsBeforeAndAfter: ['TSPropertySignature'],\n            enforceJsdocLineStyle: 'single',\n          },\n        ],\n        'jsdoc/require-asterisk-prefix': 'error',\n        'jsdoc/require-jsdoc': 'off',\n        'jsdoc/require-param': 'off',\n        'jsdoc/require-returns': 'off',\n        'jsdoc/tag-lines': 'off',\n      },\n    },\n    // JavaScript files\n    {\n      files: ['**/*.js'],\n      rules: {\n        ...jsdoc.configs['flat/recommended-typescript-flavor-error'].rules,\n        'jsdoc/check-line-alignment': 'error',\n        'jsdoc/require-asterisk-prefix': 'error',\n        'jsdoc/require-jsdoc': 'off',\n        'jsdoc/require-param': 'off',\n        'jsdoc/require-param-description': 'off',\n        'jsdoc/require-returns': 'off',\n        'jsdoc/tag-lines': 'off',\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/lodash.d.ts

@@ -0,0 +1,6 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+/**
+ * Lodash/underscore replacement rules.
+ */
+export declare function lodashConfig(): TSESLint.FlatConfig.ConfigArray;
+//# sourceMappingURL=lodash.d.ts.map

package/dist/configs/lodash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lodash.d.ts","sourceRoot":"","sources":["../../src/configs/lodash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAKzD;;GAEG;AACH,wBAAgB,YAAY,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAgB9D","sourcesContent":["import { FlatCompat } from '@eslint/eslintrc';\nimport type { TSESLint } from '@typescript-eslint/utils';\nimport youDontNeedLodashUnderscore from 'eslint-plugin-you-dont-need-lodash-underscore';\n\nconst compat = new FlatCompat();\n\n/**\n * Lodash/underscore replacement rules.\n */\nexport function lodashConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        'you-dont-need-lodash-underscore': youDontNeedLodashUnderscore,\n      },\n    },\n    // Use FlatCompat to extend the legacy config\n    ...compat.extends('plugin:you-dont-need-lodash-underscore/all'),\n    {\n      rules: {\n        // The _.omit function is still useful in some contexts.\n        'you-dont-need-lodash-underscore/omit': 'off',\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/lodash.js

@@ -0,0 +1,24 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import youDontNeedLodashUnderscore from 'eslint-plugin-you-dont-need-lodash-underscore';
+const compat = new FlatCompat();
+/**
+ * Lodash/underscore replacement rules.
+ */
+export function lodashConfig() {
+    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',
+            },
+        },
+    ];
+}
+//# sourceMappingURL=lodash.js.map

package/dist/configs/lodash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lodash.js","sourceRoot":"","sources":["../../src/configs/lodash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,2BAA2B,MAAM,+CAA+C,CAAC;AAExF,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;AAEhC;;GAEG;AACH,MAAM,UAAU,YAAY,GAAoC;IAC9D,OAAO;QACL;YACE,OAAO,EAAE;gBACP,iCAAiC,EAAE,2BAA2B;aAC/D;SACF;QACD,6CAA6C;QAC7C,GAAG,MAAM,CAAC,OAAO,CAAC,4CAA4C,CAAC;QAC/D;YACE,KAAK,EAAE;gBACL,wDAAwD;gBACxD,sCAAsC,EAAE,KAAK;aAC9C;SACF;KACF,CAAC;AAAA,CACH","sourcesContent":["import { FlatCompat } from '@eslint/eslintrc';\nimport type { TSESLint } from '@typescript-eslint/utils';\nimport youDontNeedLodashUnderscore from 'eslint-plugin-you-dont-need-lodash-underscore';\n\nconst compat = new FlatCompat();\n\n/**\n * Lodash/underscore replacement rules.\n */\nexport function lodashConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        'you-dont-need-lodash-underscore': youDontNeedLodashUnderscore,\n      },\n    },\n    // Use FlatCompat to extend the legacy config\n    ...compat.extends('plugin:you-dont-need-lodash-underscore/all'),\n    {\n      rules: {\n        // The _.omit function is still useful in some contexts.\n        'you-dont-need-lodash-underscore/omit': 'off',\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/perfectionist.d.ts

@@ -0,0 +1,8 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+/**
+ * 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 declare function perfectionistConfig(): TSESLint.FlatConfig.ConfigArray;
+//# sourceMappingURL=perfectionist.d.ts.map

package/dist/configs/perfectionist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perfectionist.d.ts","sourceRoot":"","sources":["../../src/configs/perfectionist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAGzD;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAuCrE","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport perfectionist from 'eslint-plugin-perfectionist';\n\n/**\n * Perfectionist sorting rules.\n * Most rules are off by default but pre-configured for convenient inline enabling.\n * `sort-jsx-props` is enabled by default with callback grouping.\n */\nexport function perfectionistConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        perfectionist,\n      },\n\n      rules: {\n        // Configure all perfectionist rules to be off by default but with options preset\n        ...Object.fromEntries(\n          Object.keys(perfectionist.rules ?? {}).map((ruleName) => [\n            'perfectionist/' + ruleName,\n            [\n              // Configure the options for every rule, to make inline usage more convenient.\n              'off',\n              // These rules don't have a comment partition\n              ['sort-heritage-clauses', 'sort-jsx-props', 'sort-switch-case'].includes(ruleName)\n                ? { type: 'natural' }\n                : { partitionByComment: true, type: 'natural' },\n            ],\n          ]),\n        ),\n\n        // Enable sort-jsx-props with callback grouping\n        'perfectionist/sort-jsx-props': [\n          'error',\n          {\n            customGroups: [\n              { elementNamePattern: '^on[A-Z]', groupName: 'callback' },\n              { elementNamePattern: '^(key|ref)$', groupName: 'reserved' },\n            ],\n            groups: ['reserved', 'unknown', 'shorthand-prop', 'callback'],\n            ignoreCase: true,\n            type: 'unsorted',\n          },\n        ],\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/perfectionist.js

@@ -0,0 +1,43 @@
+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() {
+    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',
+                    },
+                ],
+            },
+        },
+    ];
+}
+//# sourceMappingURL=perfectionist.js.map

package/dist/configs/perfectionist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perfectionist.js","sourceRoot":"","sources":["../../src/configs/perfectionist.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,GAAoC;IACrE,OAAO;QACL;YACE,OAAO,EAAE;gBACP,aAAa;aACd;YAED,KAAK,EAAE;gBACL,iFAAiF;gBACjF,GAAG,MAAM,CAAC,WAAW,CACnB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;oBACvD,gBAAgB,GAAG,QAAQ;oBAC3B;wBACE,8EAA8E;wBAC9E,KAAK;wBACL,6CAA6C;wBAC7C,CAAC,uBAAuB,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;4BAChF,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE;4BACrB,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;qBAClD;iBACF,CAAC,CACH;gBAED,+CAA+C;gBAC/C,8BAA8B,EAAE;oBAC9B,OAAO;oBACP;wBACE,YAAY,EAAE;4BACZ,EAAE,kBAAkB,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE;4BACzD,EAAE,kBAAkB,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE;yBAC7D;wBACD,MAAM,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,UAAU,CAAC;wBAC7D,UAAU,EAAE,IAAI;wBAChB,IAAI,EAAE,UAAU;qBACjB;iBACF;aACF;SACF;KACF,CAAC;AAAA,CACH","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport perfectionist from 'eslint-plugin-perfectionist';\n\n/**\n * Perfectionist sorting rules.\n * Most rules are off by default but pre-configured for convenient inline enabling.\n * `sort-jsx-props` is enabled by default with callback grouping.\n */\nexport function perfectionistConfig(): TSESLint.FlatConfig.ConfigArray {\n  return [\n    {\n      plugins: {\n        perfectionist,\n      },\n\n      rules: {\n        // Configure all perfectionist rules to be off by default but with options preset\n        ...Object.fromEntries(\n          Object.keys(perfectionist.rules ?? {}).map((ruleName) => [\n            'perfectionist/' + ruleName,\n            [\n              // Configure the options for every rule, to make inline usage more convenient.\n              'off',\n              // These rules don't have a comment partition\n              ['sort-heritage-clauses', 'sort-jsx-props', 'sort-switch-case'].includes(ruleName)\n                ? { type: 'natural' }\n                : { partitionByComment: true, type: 'natural' },\n            ],\n          ]),\n        ),\n\n        // Enable sort-jsx-props with callback grouping\n        'perfectionist/sort-jsx-props': [\n          'error',\n          {\n            customGroups: [\n              { elementNamePattern: '^on[A-Z]', groupName: 'callback' },\n              { elementNamePattern: '^(key|ref)$', groupName: 'reserved' },\n            ],\n            groups: ['reserved', 'unknown', 'shorthand-prop', 'callback'],\n            ignoreCase: true,\n            type: 'unsorted',\n          },\n        ],\n      },\n    },\n  ];\n}\n"]}

package/dist/configs/prairielearn.d.ts

@@ -0,0 +1,13 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+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 declare function prairieLearnConfig(options?: PrairieLearnPluginOptions): TSESLint.FlatConfig.ConfigArray;
+//# sourceMappingURL=prairielearn.d.ts.map

package/dist/configs/prairielearn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prairielearn.d.ts","sourceRoot":"","sources":["../../src/configs/prairielearn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAIzD,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,yBAAyB,GAClC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAwBjC","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\n\nimport prairielearn from '@prairielearn/eslint-plugin';\n\nexport interface PrairieLearnPluginOptions {\n  /**\n   * Types to allow when using the safe-db-types rule.\n   */\n  allowDbTypes?: string[];\n}\n\n/**\n * PrairieLearn-specific ESLint plugin rules.\n * Includes AWS client configuration, JSX safety, SQL blocks, and database type safety.\n */\nexport function prairieLearnConfig(\n  options?: PrairieLearnPluginOptions,\n): TSESLint.FlatConfig.ConfigArray {\n  const { allowDbTypes = [] } = options ?? {};\n\n  return [\n    {\n      plugins: {\n        '@prairielearn': prairielearn,\n      },\n\n      rules: {\n        '@prairielearn/aws-client-mandatory-config': 'error',\n        '@prairielearn/aws-client-shared-config': 'error',\n        '@prairielearn/jsx-no-dollar-interpolation': 'error',\n        '@prairielearn/no-current-target-in-callback': 'error',\n        '@prairielearn/no-unused-sql-blocks': 'error',\n        '@prairielearn/safe-db-types': [\n          'error',\n          {\n            allowDbTypes,\n          },\n        ],\n      },\n    },\n  ];\n}\n"]}