@cedarjs/eslint-config 5.0.7-next.338 → 5.0.7

package/README.md

@@ -6,9 +6,10 @@
   - [Purpose and Vision](#purpose-and-vision)
   - [Roadmap](#roadmap)
   - [Contributing](#contributing)
-  - [Usage](#usage)
-  - [Overriding Default Configuration](#overriding-default-configuration)
-  - [Migrating from Legacy (`.eslintrc.js`) Config](#migrating-from-legacy-eslintrcjs-config)
+  - [Usage (Flat Config - Recommended)](#usage-flat-config---recommended)
+  - [Overriding Default Configuration (Flat Config)](#overriding-default-configuration-flat-config)
+  - [Migration Guide (Optional)](#migration-guide-optional)
+  - [Legacy Configuration (Still Supported)](#legacy-configuration-still-supported)
 
 ## Purpose and Vision
 
@@ -31,12 +32,12 @@ Our configuration uses recommended rule presets, including those from [ESLint](h
 
 This package doesn't depend on other CedarJS Framework packages. To contribute, you should be familiar with the ESLint package. Keep in mind that any rules added should not conflict with code formatting tools (e.g. [Prettier](https://prettier.io/docs/en/integrating-with-linters.html)).
 
-## Usage
+## Usage (Flat Config - Recommended)
 
-CedarJS uses ESLint's flat config format by default. Create an `eslint.config.mjs` file in your project root — the `.mjs` extension means the ESM syntax below works whether or not your project has `"type": "module"` set:
+CedarJS uses ESLint's flat config format by default. Create an `eslint.config.js` file in your project root:
 
 ```javascript
-// cedar-app/eslint.config.mjs
+// cedar-app/eslint.config.js
 import cedarConfig from '@cedarjs/eslint-config'
 
 export default await cedarConfig()
@@ -44,12 +45,12 @@ export default await cedarConfig()
 
 Note: The config is async because it needs to load your Cedar project configuration.
 
-## Overriding Default Configuration
+## Overriding Default Configuration (Flat Config)
 
 To override rules in your CedarJS app, add additional config objects after the Cedar config:
 
 ```javascript
-// cedar-app/eslint.config.mjs
+// cedar-app/eslint.config.js
 import cedarConfig from '@cedarjs/eslint-config'
 
 export default [
@@ -66,7 +67,7 @@ export default [
 You can also add file-specific overrides:
 
 ```javascript
-// cedar-app/eslint.config.mjs
+// cedar-app/eslint.config.js
 import cedarConfig from '@cedarjs/eslint-config'
 
 export default [
@@ -83,7 +84,7 @@ export default [
 To ignore specific files or directories:
 
 ```javascript
-// cedar-app/eslint.config.mjs
+// cedar-app/eslint.config.js
 import cedarConfig from '@cedarjs/eslint-config'
 
 export default [
@@ -94,15 +95,15 @@ export default [
 ]
 ```
 
-## Migrating from Legacy (`.eslintrc.js`) Config
+## Migration Guide (Optional)
 
-**The legacy `.eslintrc.js`/`package.json#eslintConfig` format is no longer supported.** Follow these steps to migrate to flat config:
+**The legacy `.eslintrc.js` format still works** - you don't have to migrate. However, if you want to use the new flat config format, follow these steps:
 
 1. **Create a new flat config file** in your project root:
 
    ```javascript
-   // eslint.config.mjs (or, optionally, eslint.config.js for ESM projects with
-   // "type": "module")
+   // eslint.config.mjs (for CommonJS projects)
+   // or eslint.config.js (for ESM projects with "type": "module")
    import cedarConfig from '@cedarjs/eslint-config'
 
    export default await cedarConfig()
@@ -136,3 +137,31 @@ export default [
    ```
 
 That's it! Your linting should work the same as before.
+
+## Legacy Configuration (Still Supported)
+
+The legacy `.eslintrc.js` format is still fully supported. You can continue using it:
+
+```javascript
+// cedar-app/.eslintrc.js
+module.exports = {
+  extends: ['@cedarjs/eslint-config'],
+  root: true,
+  rules: {
+    'jsx-a11y/no-onchange': 'off',
+  },
+}
+```
+
+Or in `package.json`:
+
+```json
+{
+  "eslintConfig": {
+    "extends": "@cedarjs/eslint-config",
+    "root": true
+  }
+}
+```
+
+**Note:** While both formats are supported, we recommend migrating to flat config when convenient. See the [Migration Guide](#migration-guide-optional) above.

package/dist/index.d.mts

@@ -1,3 +1,2 @@
-/** @returns {Promise<import('eslint').Linter.FlatConfig[]>} */
-export default function createConfig(): Promise<import("eslint").Linter.FlatConfig[]>;
+export default function createConfig(): Promise<any[]>;
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../index.mjs"],"names":[],"mappings":"AAiBA,+DAA+D;AAC/D,wCADc,OAAO,CAAC,OAAO,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAoK1D"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../index.mjs"],"names":[],"mappings":"AAkBA,uDAkKC"}

package/dist/index.d.ts

@@ -0,0 +1,144 @@
+declare const plugins_1: any[];
+export const rules: {
+    'react-compiler/react-compiler': number;
+};
+declare let _extends: (string | false)[];
+export declare let ignorePatterns: string[];
+export declare namespace parserOptions {
+    let requireConfigFile: boolean;
+    namespace babelOptions {
+        let plugins: [string, import("@babel/core").PluginOptions][];
+        let overrides: ({
+            presets: import("@babel/core").PluginItem[] | null | undefined;
+            plugins: ([import("@babel/core").PluginTarget, import("@babel/core").PluginOptions, string | undefined] | [import("@babel/core").PluginTarget, import("@babel/core").PluginOptions])[];
+            extends: string | undefined;
+            babelrc: boolean;
+            ignore: string[];
+            test: string[];
+        } | {
+            presets: ((string | undefined)[] | (string | object)[])[];
+            plugins: import("@babel/core").TransformOptions[];
+            extends: string | undefined;
+            babelrc: boolean;
+            ignore: string[];
+            test: string[];
+        })[];
+    }
+}
+declare let overrides_1: ({
+    files: string[];
+    rules: {
+        'no-undef': string;
+        'jsx-a11y/aria-role': (number | {
+            ignoreNonDOM: boolean;
+        })[];
+        '@cedarjs/unsupported-route-components': string;
+        '@cedarjs/service-type-annotations'?: undefined;
+    };
+    env?: undefined;
+    globals?: undefined;
+    plugins?: undefined;
+} | {
+    files: string;
+    env: {
+        node: boolean;
+        es6: boolean;
+        commonjs?: undefined;
+        browser?: undefined;
+        'shared-node-browser'?: undefined;
+    };
+    globals: {
+        gql: string;
+        context: string;
+        Promise?: undefined;
+        React?: undefined;
+        process?: undefined;
+        require?: undefined;
+        mockGraphQLQuery?: undefined;
+        mockGraphQLMutation?: undefined;
+        mockCurrentUser?: undefined;
+        scenario?: undefined;
+        defineScenario?: undefined;
+    };
+    rules?: undefined;
+    plugins?: undefined;
+} | {
+    files: string[];
+    plugins: string[];
+    rules: {
+        '@cedarjs/service-type-annotations': string;
+        'no-undef'?: undefined;
+        'jsx-a11y/aria-role'?: undefined;
+        '@cedarjs/unsupported-route-components'?: undefined;
+    };
+    env?: undefined;
+    globals?: undefined;
+} | {
+    files: string[];
+    env: {
+        node: boolean;
+        commonjs: boolean;
+        es6?: undefined;
+        browser?: undefined;
+        'shared-node-browser'?: undefined;
+    };
+    globals: {
+        Promise: string;
+        gql?: undefined;
+        context?: undefined;
+        React?: undefined;
+        process?: undefined;
+        require?: undefined;
+        mockGraphQLQuery?: undefined;
+        mockGraphQLMutation?: undefined;
+        mockCurrentUser?: undefined;
+        scenario?: undefined;
+        defineScenario?: undefined;
+    };
+    rules?: undefined;
+    plugins?: undefined;
+} | {
+    files: string;
+    env: {
+        browser: boolean;
+        es6: boolean;
+        'shared-node-browser': boolean;
+        node?: undefined;
+        commonjs?: undefined;
+    };
+    globals: {
+        React: string;
+        gql: string;
+        process: string;
+        require: string;
+        context?: undefined;
+        Promise?: undefined;
+        mockGraphQLQuery?: undefined;
+        mockGraphQLMutation?: undefined;
+        mockCurrentUser?: undefined;
+        scenario?: undefined;
+        defineScenario?: undefined;
+    };
+    rules?: undefined;
+    plugins?: undefined;
+} | {
+    files: string[];
+    globals: {
+        mockGraphQLQuery: string;
+        mockGraphQLMutation: string;
+        mockCurrentUser: string;
+        scenario: string;
+        defineScenario: string;
+        gql?: undefined;
+        context?: undefined;
+        Promise?: undefined;
+        React?: undefined;
+        process?: undefined;
+        require?: undefined;
+    };
+    rules?: undefined;
+    env?: undefined;
+    plugins?: undefined;
+})[];
+export { _extends as extends, plugins, overrides_1 as overrides };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":"AAyCA,+BAAkB;AAClB;;EAAgB"}

package/dist/shared.d.mts

@@ -1,4 +1,3 @@
-export default sharedConfigs;
-/** @type {import('eslint').Linter.FlatConfig[]} */
-declare const sharedConfigs: import("eslint").Linter.FlatConfig[];
+declare const _default: any[];
+export default _default;
 //# sourceMappingURL=shared.d.mts.map

package/dist/shared.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../shared.mjs"],"names":[],"mappings":";AA8BA,mDAAmD;AACnD,6BADW,OAAO,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,CAoP9C"}
+{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../shared.mjs"],"names":[],"mappings":""}

package/dist/shared.d.ts

@@ -0,0 +1,144 @@
+declare let _extends: string[];
+export { _extends as extends };
+export declare let parser: string;
+export declare let plugins: string[];
+export declare let ignorePatterns: string[];
+export declare let settings: {
+    react: {
+        version: string;
+    };
+    'import-x/internal-regex': string;
+};
+export declare let rules: {
+    '@cedarjs/process-env-computed': string;
+    'prettier/prettier': string;
+    'no-console': string;
+    'prefer-object-spread': string;
+    'prefer-spread': string;
+    'no-unused-expressions': (string | {
+        allowShortCircuit: boolean;
+        allowTernary: boolean;
+    })[];
+    'no-useless-escape': string;
+    camelcase: (string | {
+        properties: string;
+    })[];
+    'no-new': string;
+    'new-cap': (string | {
+        newIsCap: boolean;
+        capIsNew: boolean;
+    })[];
+    'no-unused-vars': (string | {
+        varsIgnorePattern: string;
+        argsIgnorePattern: string;
+    })[];
+    'react/prop-types': string;
+    'react/display-name': string;
+    'react-hooks/exhaustive-deps': string;
+    'import-x/order': (string | {
+        'newlines-between': string;
+        pathGroupsExcludedImportTypes: never[];
+        groups: string[];
+        pathGroups: ({
+            pattern: string;
+            group: string;
+            position: string;
+            patternOptions?: undefined;
+        } | {
+            pattern: string;
+            patternOptions: {
+                nobrace: boolean;
+                noglobstar: boolean;
+            };
+            group: string;
+            position: string;
+        })[];
+        alphabetize: {
+            order: string;
+            caseInsensitive: boolean;
+        };
+    })[];
+    'no-restricted-imports': (string | {
+        patterns: {
+            group: string[];
+            message: string;
+        }[];
+    })[];
+};
+export declare let overrides: ({
+    files: string[];
+    excludedFiles: string[];
+    rules: {
+        'react-hooks/rules-of-hooks': string;
+        '@typescript-eslint/no-empty-function'?: undefined;
+        '@typescript-eslint/prefer-function-type'?: undefined;
+        '@typescript-eslint/no-var-requires'?: undefined;
+        '@typescript-eslint/no-require-imports'?: undefined;
+        '@typescript-eslint/no-empty-object-type'?: undefined;
+        '@typescript-eslint/no-unused-vars'?: undefined;
+        'no-restricted-imports'?: undefined;
+    };
+    parser?: undefined;
+    extends?: undefined;
+    env?: undefined;
+} | {
+    files: string[];
+    parser: string;
+    extends: string[];
+    rules: {
+        '@typescript-eslint/no-empty-function': string;
+        '@typescript-eslint/prefer-function-type': string;
+        '@typescript-eslint/no-var-requires': string;
+        '@typescript-eslint/no-require-imports': string;
+        '@typescript-eslint/no-empty-object-type': string;
+        '@typescript-eslint/no-unused-vars': (string | {
+            varsIgnorePattern: string;
+            argsIgnorePattern: string;
+        })[];
+        'react-hooks/rules-of-hooks'?: undefined;
+        'no-restricted-imports'?: undefined;
+    };
+    excludedFiles?: undefined;
+    env?: undefined;
+} | {
+    files: string[];
+    env: {
+        node: boolean;
+        es6: boolean;
+        commonjs: boolean;
+        jest: boolean;
+    };
+    excludedFiles?: undefined;
+    rules?: undefined;
+    parser?: undefined;
+    extends?: undefined;
+} | {
+    files: string[];
+    env: {
+        node: boolean;
+        commonjs: boolean;
+        jest: boolean;
+        es6?: undefined;
+    };
+    excludedFiles?: undefined;
+    rules?: undefined;
+    parser?: undefined;
+    extends?: undefined;
+} | {
+    files: string[];
+    rules: {
+        'no-restricted-imports': string;
+        'react-hooks/rules-of-hooks'?: undefined;
+        '@typescript-eslint/no-empty-function'?: undefined;
+        '@typescript-eslint/prefer-function-type'?: undefined;
+        '@typescript-eslint/no-var-requires'?: undefined;
+        '@typescript-eslint/no-require-imports'?: undefined;
+        '@typescript-eslint/no-empty-object-type'?: undefined;
+        '@typescript-eslint/no-unused-vars'?: undefined;
+    };
+    excludedFiles?: undefined;
+    parser?: undefined;
+    extends?: undefined;
+    env?: undefined;
+})[];
+//# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../shared.js"],"names":[],"mappings":""}