fix: eslint needs extra configs to resolve paths correctly

Merged the release CI fixes from another branch here as that one is failing for unknow reasons
tablecheck · Oct 2, 2023 · 400fbb3 · 400fbb3
1 parent c750302
commit 400fbb3
Show file tree

Hide file tree

Showing 7 changed files with 113 additions and 65 deletions.
diff --git a/.github/setup/action.yml b/.github/setup/action.yml
@@ -29,12 +29,12 @@ runs:
 
     - name: Setup branch for NX (main)
       shell: bash
-      if: github.ref == 'refs/head/main'
+      if: github.ref == 'refs/heads/main'
       run: git branch -u origin/main main
 
     - name: Setup branch for NX (!main)
       shell: bash
-      if: github.ref != 'refs/head/main'
+      if: github.ref != 'refs/heads/main'
       run: git branch --track main origin/main
 
     - name: Install without scripts 🔧
@@ -43,4 +43,4 @@ runs:
 
     - name: Build 🔨
       shell: bash
-      run: npm run build
+      run: npm run build:ci
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,9 +18,6 @@ jobs:
 
       - uses: ./.github/setup
 
-      - name: Build
-        run: npm run build
-
       - name: Run Tests
         run: npm test
 

diff --git a/package.json b/package.json
@@ -17,6 +17,7 @@
     "test:watch": "nx run-many --target=test:watch",
     "start": "start-storybook -p 6006",
     "build": "nx affected --target=build",
+    "build:ci": "nx run-many --target=build",
     "build:docs": "build-storybook",
     "prepare": "husky install && npm run build",
     "all-upgrade": "npm-upgrade && lerna exec --concurrency 1 -- npm-upgrade"

diff --git a/packages/nx/src/generators/quality/eslintConfig.ts b/packages/nx/src/generators/quality/eslintConfig.ts
@@ -0,0 +1,43 @@
+import * as path from 'path';
+
+import { Tree } from '@nx/devkit';
+import { getNxProjectRoot, outputPrettyFile } from '@tablecheck/frontend-utils';
+import * as fs from 'fs-extra';
+
+function getConfigs(projectRoot: string) {
+  const mapToPath = (filename: string) => path.join(projectRoot, filename);
+  const nxAppConfigs = ['tsconfig.app.json', 'tsconfig.spec.json'].map(
+    mapToPath,
+  );
+  const defaultConfigs = ['tsconfig.base.json', 'tsconfig.json'].map(mapToPath);
+  if (nxAppConfigs.every((config) => fs.existsSync(config))) {
+    return nxAppConfigs;
+  }
+  return defaultConfigs.filter((config) => fs.existsSync(config));
+}
+
+export function generateEslintConfig(tree: Tree, projectName: string) {
+  const { projectRoot } = getNxProjectRoot(tree, projectName);
+  const projectTsConfigs =
+    getConfigs(projectRoot)
+      .map((tsConfig) => path.relative(tree.root, tsConfig))
+      .join(',') ||
+    '/* could not detect tsconfig.json files, manually set them here */';
+  const fileContent = `
+module.exports = {
+    extends: ['@tablecheck/eslint-config'],
+    parserOptions: {
+        project: [${projectTsConfigs}],
+    },
+    settings: {
+      'import/resolver': {
+          typescript: {
+              project: [${projectTsConfigs}],
+            },
+        },
+    },
+    rules: {},
+};
+`;
+  outputPrettyFile(path.join(projectRoot, '.eslintrc.cjs'), fileContent);
+}
diff --git a/packages/nx/src/generators/quality/files/.eslintrc.cjs b/packages/nx/src/generators/quality/files/.eslintrc.cjs
diff --git a/packages/nx/src/generators/quality/generator.ts b/packages/nx/src/generators/quality/generator.ts
@@ -7,12 +7,7 @@ import {
   addDependenciesToPackageJson,
   Tree,
   updateJson,
-  addProjectConfiguration,
-  readProjectConfiguration,
-  updateProjectConfiguration,
 } from '@nx/devkit';
-import { getNxProjectRoot } from '@tablecheck/frontend-utils';
-import merge from 'lodash/merge';
 import { PackageJson } from 'type-fest';
 
 import { getLatestVersions } from '../../utils/dependencies';
@@ -21,53 +16,8 @@ import generateFileTypes from '../ts-file-types/generator';
 import { FileTypesGeneratorSchema } from '../ts-file-types/schema';
 import generateConfig from '../ts-node-config/generator';
 
-function updateProjectConfig(tree: Tree, projectName: string) {
-  const { projectSourceRoot, projectRoot } = getNxProjectRoot(
-    tree,
-    projectName,
-  );
-  const lintTarget = {
-    executor: '@tablecheck/nx:quality',
-    outputs: ['{options.outputFile}'],
-    options: {
-      lintFilePatterns: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'].map(
-        (pattern) =>
-          path.relative(projectRoot, path.join(projectSourceRoot, pattern)),
-      ),
-    },
-  };
-  const lintFormatTarget = merge({}, lintTarget, {
-    options: {
-      fix: true,
-    },
-  });
-  try {
-    const projectConfig = readProjectConfiguration(tree, projectName);
-    updateProjectConfiguration(
-      tree,
-      projectName,
-      merge(projectConfig, {
-        targets: {
-          quality: lintTarget,
-          'quality:format': lintFormatTarget,
-        },
-      }),
-    );
-  } catch (e) {
-    console.error(
-      'Failed to detect existing project config, generating new project.json to run executors',
-      e,
-    );
-    addProjectConfiguration(tree, projectName, {
-      root: '.',
-      sourceRoot: 'src',
-      targets: {
-        quality: lintTarget,
-        'quality:format': lintFormatTarget,
-      },
-    });
-  }
-}
+import { generateEslintConfig } from './eslintConfig';
+import { updateProjectConfig } from './projectConfig';
 
 export async function qualityGenerator(
   tree: Tree,
@@ -85,6 +35,8 @@ export async function qualityGenerator(
       '@tablecheck/commitlint-config',
       '@tablecheck/eslint-config',
       '@tablecheck/prettier-config',
+      '@typescript-eslint/eslint-plugin',
+      '@typescript-eslint/parser',
     ]),
   )();
   updateJson(tree, 'package.json', (json: PackageJson) => {
@@ -105,6 +57,7 @@ export async function qualityGenerator(
     path.relative(process.cwd(), tree.root),
     {},
   );
+  generateEslintConfig(tree, schema.project);
   execSync('npx husky install', {
     cwd: process.cwd(),
     stdio: 'inherit',

diff --git a/packages/nx/src/generators/quality/projectConfig.ts b/packages/nx/src/generators/quality/projectConfig.ts
@@ -0,0 +1,61 @@
+import * as path from 'path';
+
+import {
+  Tree,
+  addProjectConfiguration,
+  readProjectConfiguration,
+  updateProjectConfiguration,
+} from '@nx/devkit';
+import { getNxProjectRoot } from '@tablecheck/frontend-utils';
+import merge from 'lodash/merge';
+
+export function updateProjectConfig(tree: Tree, projectName: string) {
+  const { projectSourceRoot, projectRoot } = getNxProjectRoot(
+    tree,
+    projectName,
+  );
+  const lintTarget = {
+    executor: '@tablecheck/nx:quality',
+    outputs: ['{options.outputFile}'],
+    options: {
+      lintFilePatterns: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'].map(
+        (pattern) =>
+          path.join(
+            '{projectRoot}',
+            path.relative(projectRoot, path.join(projectSourceRoot, pattern)),
+          ),
+      ),
+    },
+  };
+  const lintFormatTarget = merge({}, lintTarget, {
+    options: {
+      fix: true,
+    },
+  });
+  try {
+    const projectConfig = readProjectConfiguration(tree, projectName);
+    updateProjectConfiguration(
+      tree,
+      projectName,
+      merge(projectConfig, {
+        targets: {
+          quality: lintTarget,
+          'quality:format': lintFormatTarget,
+        },
+      }),
+    );
+  } catch (e) {
+    console.error(
+      'Failed to detect existing project config, generating new project.json to run executors',
+      e,
+    );
+    addProjectConfiguration(tree, projectName, {
+      root: '.',
+      sourceRoot: 'src',
+      targets: {
+        quality: lintTarget,
+        'quality:format': lintFormatTarget,
+      },
+    });
+  }
+}