feat(eslint-config)!: make nest and next configs executable to dynamically accept apps

Author: rozsival

packages/eslint-config/README.md

@@ -22,12 +22,16 @@ Use one of the following configurations in your repository's root `eslint.config
 
 ### Base
 
+Suitable for general TypeScript projects.
+
 ```javascript
 export { base as default } from '@apitree.cz/eslint-config';
 ```
 
 ### React
 
+Necessary for React (JSX/MDX) projects.
+
 ```javascript
 import { base, react } from '@apitree.cz/eslint-config';
 
@@ -41,30 +45,29 @@ Next.js configuration requires to specify the path to the app(s).
 ```javascript
 import { base, react, nextjs } from '@apitree.cz/eslint-config';
 
-export default [
-  ...base,
-  ...react,
-  {
-    files: ['apps/*/<next-js-app-name>/**/*'],
-    // or `files: ['**/*.{ts,tsx}']` in single-app repo
-    ...nextjs,
-  },
-];
+export default [...base, ...react, ...nextjs(['apps/<nextjs-app>'])];
 ```
 
+> Omit the apps array if you have a single Next.js app repository (no monorepo).
+
 ### Nest.js
 
 Nest.js configuration requires to specify the path to the app(s).
 
 ```javascript
 import { base, nestjs } from '@apitree.cz/eslint-config';
 
-export default [
-  ...base,
-  {
-    files: ['apps/*/<nest-js-app-name>/**/*'],
-    // or `files: ['**/*.ts']` in single-app repo
-    ...nestjs,
-  },
-];
+export default [...base, ...nestjs(['apps/<nestjs-app>'])];
+```
+
+> Omit the apps array if you have a single Nest.js app repository (no monorepo).
+
+### Storybook
+
+Necessary for projects containing Storybook instance.
+
+```javascript
+import { base, react, storybook } from '@apitree.cz/eslint-config';
+
+export default [...base, ...react, ...storybook];
 ```

packages/eslint-config/src/nestjs/config.ts

@@ -1,29 +1,23 @@
-import { FlatCompat } from '@eslint/eslintrc';
+import type { Linter } from 'eslint';
 
-const compat = new FlatCompat({
-  baseDirectory: import.meta.dirname,
-});
-
-export const [config] = compat.config({
-  overrides: [
-    {
-      files: ['src/**/models/**/*.ts'],
-      rules: {
-        'import/no-cycle': 'off', // Allow circular dependencies in models as they might reference each other
-      },
+export const config = (apps = ['.']): Linter.Config[] => [
+  {
+    files: apps.map((app) => `${app}/src/**/models/**/*.ts`),
+    rules: {
+      'import/no-cycle': 'off', // Allow circular dependencies in models as they might reference each other
     },
-    {
-      files: ['src/**/*.ts'],
-      rules: {
-        'class-methods-use-this': 'off', // Allow class methods that don't use `this` keyword
-        'no-empty-function': ['error', { allow: ['constructors'] }], // Allow empty constructors for Nest classes
-        '@typescript-eslint/consistent-type-imports': 'off', // Allow types being imported without `type` keyword as Nest.js services and models are ambiguous
-        '@typescript-eslint/no-extraneous-class': [
-          // Allow classes that are used as Nest decorators
-          'error',
-          { allowWithDecorator: true },
-        ],
-      },
+  },
+  {
+    files: apps.map((app) => `${app}/src/**/*.ts`),
+    rules: {
+      'class-methods-use-this': 'off', // Allow class methods that don't use `this` keyword
+      'no-empty-function': ['error', { allow: ['constructors'] }], // Allow empty constructors for Nest classes
+      '@typescript-eslint/consistent-type-imports': 'off', // Allow types being imported without `type` keyword as Nest.js services and models are ambiguous
+      '@typescript-eslint/no-extraneous-class': [
+        // Allow classes that are used as Nest decorators
+        'error',
+        { allowWithDecorator: true },
+      ],
     },
-  ],
-});
+  },
+];

packages/eslint-config/src/nextjs/config.ts

@@ -1,54 +1,57 @@
 import { FlatCompat } from '@eslint/eslintrc';
+import type { Linter } from 'eslint';
 
 const compat = new FlatCompat({
   baseDirectory: import.meta.dirname,
 });
 
-export const [config] = compat.config({
-  extends: ['plugin:@next/next/recommended'],
-  plugins: ['@next/next'],
-  settings: {
-    next: {
-      rootDir: process.cwd(),
-    },
-  },
-  overrides: [
-    {
-      files: ['next-env.d.ts'],
-      rules: {
-        'unicorn/prevent-abbreviations': 'off', // next-env.d.ts is a Next.js convention
+export const config = (apps = ['.']): Linter.Config[] => [
+  ...compat.config({
+    extends: ['plugin:@next/next/recommended'],
+    plugins: ['@next/next'],
+    settings: {
+      next: {
+        rootDir: process.cwd(),
       },
     },
-    {
-      files: ['src/app/**/*.ts', 'src/app/**/*.tsx', 'src/pages/**/*.ts', 'src/pages/**/*.tsx'],
-      rules: {
-        'react/function-component-definition': [
-          // Allow components as function declarations in Next.js App and Page components for shorthand default exports
-          'error',
-          {
-            namedComponents: ['arrow-function', 'function-declaration'],
-            unnamedComponents: 'function-expression',
-          },
-        ],
-      },
+  }),
+  {
+    files: apps.map((app) => `${app}/next-env.d.ts`),
+    rules: {
+      'unicorn/prevent-abbreviations': 'off', // next-env.d.ts is a Next.js convention
     },
-    {
-      files: ['app/**/layout.tsx', 'src/**/layouts/**/*.tsx'],
-      rules: {
-        '@next/next/no-head-element': 'off', // Allow <head/> element in Next.js App layouts
-      },
+  },
+  {
+    files: apps.map((app) => [`${app}/src/app/**/*.{ts,tsx}`, `${app}/src/pages/**/*.{ts,tsx}`]).flat(),
+    rules: {
+      'react/function-component-definition': [
+        // Allow components as function declarations in Next.js App and Page components for shorthand default exports
+        'error',
+        {
+          namedComponents: ['arrow-function', 'function-declaration'],
+          unnamedComponents: 'function-expression',
+        },
+      ],
     },
-    {
-      files: ['src/**/layouts/**/*.tsx', 'rc/pages/_app.tsx', 'src/pages/_document.tsx'],
-      rules: {
-        'react/jsx-props-no-spreading': 'off', // Allow spreading props in Next.js App layouts, _app.tsx and _document.tsx
-      },
+  },
+  {
+    files: apps.map((app) => [`${app}/app/**/layout.tsx`, `${app}/src/**/layouts/**/*.tsx`]).flat(),
+    rules: {
+      '@next/next/no-head-element': 'off', // Allow <head/> element in Next.js App layouts
     },
-    {
-      files: ['src/**/actions.ts'],
-      rules: {
-        '@typescript-eslint/require-await': 'off', // Next.js Server Actions must be async but don't need to await
-      },
+  },
+  {
+    files: apps
+      .map((app) => [`${app}/src/**/layouts/**/*.tsx`, `${app}/src/pages/_app.tsx`, `${app}/src/pages/_document.tsx`])
+      .flat(),
+    rules: {
+      'react/jsx-props-no-spreading': 'off', // Allow spreading props in Next.js App layouts, _app.tsx and _document.tsx
     },
-  ],
-});
+  },
+  {
+    files: apps.map((app) => `${app}/src/**/actions.ts`),
+    rules: {
+      '@typescript-eslint/require-await': 'off', // Next.js Server Actions must be async but don't need to await
+    },
+  },
+];