Split into multiple entry points to fix import errors from unused configs

Author: matejchalk

README.md

@@ -58,10 +58,10 @@ To use the default config, follow these steps:
 3. Include default config in your [ESLint configuration file](https://eslint.org/docs/latest/use/configure/configuration-files) (usually `eslint.config.js`):
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import javascript from '@code-pushup/eslint-config/javascript.js';
    import tseslint from 'typescript-eslint';
 
-   export default tseslint.config(...cpeslint.javascript);
+   export default tseslint.config(...javascript);
    ```
 
 Depending on your tech stack, you may wish to extend other configs as well ([listed above](#⚙️-configs)). This will require installing additional peer dependencies. For more details, refer to setup docs for the configs you're interested in using.

docs/angular.md

@@ -15,11 +15,11 @@ Config for **Angular** projects.
 4. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import angular from '@code-pushup/eslint-config/angular.js';
    import tseslint from 'typescript-eslint';
 
    export default tseslint.config(
-     ...cpeslint.angular,
+     ...angular,
      {
        // It is recommended that selectors in Angular use a common custom prefix
        // - see https://angular.io/guide/styleguide#style-02-07

docs/cypress.md

@@ -14,10 +14,10 @@ Config for projects using **Cypress** for testing.
 3. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import cypress from '@code-pushup/eslint-config/cypress.js';
    import tseslint from 'typescript-eslint';
 
-   export default tseslint.config(...cpeslint.cypress);
+   export default tseslint.config(...cypress);
    ```
 
 ## 📏 Rules (6)

docs/graphql.md

@@ -17,7 +17,7 @@ Config for **GraphQL servers** implemented in Node.js.
 
      ```js
      export default tseslint.config(
-       ...cpeslint.graphql,
+       // ...
        {
          files: ['**/*.graphql'],
          languageOptions: {
@@ -33,10 +33,10 @@ Config for **GraphQL servers** implemented in Node.js.
 4. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import graphql from '@code-pushup/eslint-config/graphql.js';
    import tseslint from 'typescript-eslint';
    
-   export default tseslint.config(...cpeslint.graphql);
+   export default tseslint.config(...graphql);
    ```
 
 ## 📏 Rules (317)

docs/javascript.md

@@ -4,15 +4,7 @@ Default config, suitable for any **JavaScript/TypeScript** project.
 
 ## 🏗️ Setup
 
-1. If you haven't already, make sure to [install `@code-pushup/eslint-config` and its required peer dependencies](../README.md#🏗️-setup).
-2. Add to your `eslint.config.js` file:
-
-   ```js
-   import cpeslint from '@code-pushup/eslint-config';
-   import tseslint from 'typescript-eslint';
-   
-   export default tseslint.config(...cpeslint.javascript);
-   ```
+Refer to [setup instructions in README](../README.md#🏗️-setup).
 
 ## 📏 Rules (290)
 

docs/jest.md

@@ -14,11 +14,11 @@ Config for projects using **Jest** for testing.
 3. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import jest from '@code-pushup/eslint-config/jest.js';
    import tseslint from 'typescript-eslint';
 
    export default tseslint.config(
-     ...cpeslint.jest,
+     ...jest,
      {
        // customize rules if needed:
        rules: {

docs/ngrx.md

@@ -15,11 +15,11 @@ Config for **Angular** projects using **NgRx** library.
 4. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import ngrx from '@code-pushup/eslint-config/ngrx.js';
    import tseslint from 'typescript-eslint';
 
    export default tseslint.config(
-     ...cpeslint.ngrx,
+     ...ngrx,
      {
        // It is recommended that selectors in Angular use a common custom prefix
        // - see https://angular.io/guide/styleguide#style-02-07

docs/node.md

@@ -14,10 +14,10 @@ Config for **Node.js** projects.
 3. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import node from '@code-pushup/eslint-config/node.js';
    import tseslint from 'typescript-eslint';
 
-   export default tseslint.config(...cpeslint.node);
+   export default tseslint.config(...node);
    ```
 
 ## 📏 Rules (294)

docs/storybook.md

@@ -14,10 +14,10 @@ Config for projects using **Storybook** for UI components.
 3. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import storybook from '@code-pushup/eslint-config/storybook.js';
    import tseslint from 'typescript-eslint';
 
-   export default tseslint.config(...cpeslint.storybook);
+   export default tseslint.config(...storybook);
    ```
 
 ## 📏 Rules (11)

docs/typescript.md

@@ -59,10 +59,10 @@ Config for strict **TypeScript** projects.
 3. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import typescript from '@code-pushup/eslint-config/typescript.js';
    import tseslint from 'typescript-eslint';
    
-   export default tseslint.config(...cpeslint.typescript);
+   export default tseslint.config(...typescript);
    ```
 
 ## 📏 Rules (345)

docs/vitest.md

@@ -14,11 +14,11 @@ Config for projects using **Vitest** for testing.
 3. Add to your `eslint.config.js` file:
 
    ```js
-   import cpeslint from '@code-pushup/eslint-config';
+   import vitest from '@code-pushup/eslint-config/vitest.js';
    import tseslint from 'typescript-eslint';
 
    export default tseslint.config(
-     ...cpeslint.vitest,
+     ...vitest,
      {
        // customize rules if needed:
        rules: {

eslint.config.js

@@ -1,9 +1,10 @@
 // @ts-check
 
 import tseslint from 'typescript-eslint';
-import cpeslint from './src/index.js';
+import node from './src/configs/node.js';
+import vitest from './src/configs/vitest.js';
 
-export default tseslint.config(...cpeslint.node, ...cpeslint.vitest, {
+export default tseslint.config(...node, ...vitest, {
   rules: {
     '@typescript-eslint/no-magic-numbers': 'off',
     'import/extensions': ['error', { js: 'always', json: 'never' }],

package.json

@@ -8,7 +8,9 @@
   "type": "module",
   "main": "./src/index.js",
   "exports": {
-    ".": "./src/index.js"
+    ".": "./src/configs/javascript.js",
+    "./*": "./src/configs/*.js",
+    "./*.js": "./src/configs/*.js"
   },
   "files": [
     "./src"

scripts/helpers/configs.js

@@ -116,7 +116,7 @@ export default tseslint.config(
       md`Otherwise, you can use ${md.link('https://the-guild.dev/graphql/eslint/docs/getting-started/parser-options#schema', md.code('parserOptions.schema'))}, e.g.:${md.codeBlock(
         'js',
         `export default tseslint.config(
-  ...cpeslint.graphql,
+  // ...
   {
     files: ['**/*.graphql'],
     languageOptions: {

scripts/helpers/format-config.js

@@ -51,7 +51,7 @@ export function configRulesToMarkdown(
     .paragraph(configDescription(config))
     .heading(2, '🏗️ Setup')
     .$if(
-      config === 'index',
+      config === 'javascript',
       doc =>
         doc.paragraph(
           md`Refer to ${md.link(setupLink, 'setup instructions in README')}.`,
@@ -74,16 +74,16 @@ export function configRulesToMarkdown(
           md`Add to your ${md.code('eslint.config.js')} file:${md.codeBlock(
             'js',
             [
-              "import cpeslint from '@code-pushup/eslint-config';",
+              `import ${config} from '@code-pushup/eslint-config/${config}.js';`,
               "import tseslint from 'typescript-eslint';",
               '',
               ...(configsExtraEslintrc[config]
                 ? [
                     'export default tseslint.config(',
-                    `  ...cpeslint.${config}${configsExtraEslintrc[config]}`,
+                    `  ...${config}${configsExtraEslintrc[config]}`,
                     ');',
                   ]
-                : [`export default tseslint.config(...cpeslint.${config});`]),
+                : [`export default tseslint.config(...${config});`]),
             ].join('\n'),
           )}`,
         ]),

scripts/helpers/format-readme.js

@@ -71,10 +71,10 @@ export function configsToMarkdown(configs, peerDeps, extended) {
       md`Include default config in your ${md.link('https://eslint.org/docs/latest/use/configure/configuration-files', 'ESLint configuration file')} (usually ${md.code('eslint.config.js')}):${md.codeBlock(
         'js',
         [
-          "import cpeslint from '@code-pushup/eslint-config';",
+          "import javascript from '@code-pushup/eslint-config/javascript.js';",
           "import tseslint from 'typescript-eslint';",
           '',
-          'export default tseslint.config(...cpeslint.javascript);',
+          'export default tseslint.config(...javascript);',
         ].join('\n'),
       )}`,
     ])

src/index.js

@@ -46,9 +46,9 @@ describe('typescript config', () => {
   });
 
   test('should only explicitly reference rules which require type checking (with specified exceptions)', async () => {
-    const {
-      default: { typescript },
-    } = await import('@code-pushup/eslint-config');
+    const { default: typescript } = await import(
+      '@code-pushup/eslint-config/typescript'
+    );
     const ruleIds = getExplicitRuleIds(typescript);
     const rules = await loadRulesByIds(ruleIds);
     const rulesWithoutTypes = Object.entries(rules)

tests/configs/typescript.spec.js

@@ -25,10 +25,10 @@ export function createLintUtils(
     await fs.mkdir(cwd, { recursive: true });
     await fs.writeFile(
       path.join(cwd, 'eslint.config.js'),
-      `import cpeslint from '@code-pushup/eslint-config'
+      `import ${configName} from '@code-pushup/eslint-config/${configName}.js'
 
 export default [
-  ...cpeslint['${configName}'],
+  ...${configName},
   {
     languageOptions: {
       parserOptions: {

tests/helpers/lint-utils.js

@@ -57,9 +57,7 @@ describe('package.json checks', () => {
   });
 
   test('should mark peer dependency as optional if not included in default config', async () => {
-    const {
-      default: { javascript },
-    } = await import('@code-pushup/eslint-config');
+    const { default: javascript } = await import('@code-pushup/eslint-config');
     const plugins = javascript.flatMap(config =>
       Object.keys(config.plugins ?? {}),
     );