fix(linter): enable analyzeSourceFile as needed when generating new l…

…int project Fixes #18704
nrwl · Aug 22, 2023 · c5753b4 · c5753b4
1 parent a25cc29
commit c5753b4
Show file tree

Hide file tree

Showing 2 changed files with 93 additions and 14 deletions.
diff --git a/packages/linter/src/generators/lint-project/lint-project.spec.ts b/packages/linter/src/generators/lint-project/lint-project.spec.ts
@@ -1,7 +1,9 @@
 import {
   addProjectConfiguration,
   readProjectConfiguration,
+  updateJson,
   Tree,
+  readJson,
 } from '@nx/devkit';
 
 import { Linter } from '../utils/linter';
@@ -175,4 +177,48 @@ describe('@nx/linter:lint-project', () => {
       "
     `);
   });
+
+  it('should update nx.json to enable source analysis when using npm.json preset', async () => {
+    updateJson(tree, 'nx.json', (json) => {
+      // npm preset disables source analysis
+      json.extends = 'nx/presets/npm.json';
+      return json;
+    });
+
+    await lintProjectGenerator(tree, {
+      ...defaultOptions,
+      linter: Linter.EsLint,
+      eslintFilePatterns: ['libs/buildable-lib/**/*.ts'],
+      project: 'buildable-lib',
+      setParserOptionsProject: false,
+    });
+
+    expect(readJson(tree, 'nx.json').pluginsConfig['@nx/js']).toEqual({
+      analyzeSourceFiles: true,
+    });
+  });
+
+  it('should update nx.json to enable source analysis when it is disabled', async () => {
+    updateJson(tree, 'nx.json', (json) => {
+      // npm preset disables source analysis
+      json.pluginsConfig = {
+        '@nx/js': {
+          analyzeSourceFiles: false,
+        },
+      };
+      return json;
+    });
+
+    await lintProjectGenerator(tree, {
+      ...defaultOptions,
+      linter: Linter.EsLint,
+      eslintFilePatterns: ['libs/buildable-lib/**/*.ts'],
+      project: 'buildable-lib',
+      setParserOptionsProject: false,
+    });
+
+    expect(readJson(tree, 'nx.json').pluginsConfig['@nx/js']).toEqual({
+      analyzeSourceFiles: true,
+    });
+  });
 });
diff --git a/packages/linter/src/generators/lint-project/lint-project.ts b/packages/linter/src/generators/lint-project/lint-project.ts
@@ -1,8 +1,14 @@
-import type { ProjectConfiguration, Tree } from '@nx/devkit';
+import type {
+  NxJsonConfiguration,
+  ProjectConfiguration,
+  Tree,
+} from '@nx/devkit';
 import {
   formatFiles,
   offsetFromRoot,
+  readJson,
   readProjectConfiguration,
+  updateJson,
   updateProjectConfiguration,
   writeJson,
 } from '@nx/devkit';
@@ -96,6 +102,19 @@ export async function lintProjectGenerator(
     );
   }
 
+  // Buildable libs need source analysis enabled for linting `package.json`.
+  if (
+    isBuildableLibraryProject(projectConfig) &&
+    !isJsAnalyzeSourceFilesEnabled(tree)
+  ) {
+    updateJson(tree, 'nx.json', (json) => {
+      json.pluginsConfig ??= {};
+      json.pluginsConfig['@nx/js'] ??= {};
+      json.pluginsConfig['@nx/js'].analyzeSourceFiles = true;
+      return json;
+    });
+  }
+
   updateProjectConfiguration(tree, options.project, projectConfig);
 
   if (!options.skipFormat) {
@@ -111,7 +130,7 @@ function createEsLintConfiguration(
   setParserOptionsProject: boolean
 ) {
   const eslintConfig = findEslintFile(tree);
-  writeJson(tree, join(projectConfig.root, `.eslintrc.json`), {
+  const eslintRc: any = {
     extends: eslintConfig
       ? [`${offsetFromRoot(projectConfig.root)}${eslintConfig}`]
       : undefined,
@@ -152,19 +171,18 @@ function createEsLintConfiguration(
         files: ['*.js', '*.jsx'],
         rules: {},
       },
-      ...(isBuildableLibraryProject(projectConfig)
-        ? [
-            {
-              files: ['*.json'],
-              parser: 'jsonc-eslint-parser',
-              rules: {
-                '@nx/dependency-checks': 'error',
-              },
-            },
-          ]
-        : []),
     ],
-  });
+  };
+  if (isBuildableLibraryProject(projectConfig)) {
+    eslintRc.overrides.push({
+      files: ['*.json'],
+      parser: 'jsonc-eslint-parser',
+      rules: {
+        '@nx/dependency-checks': 'error',
+      },
+    });
+  }
+  writeJson(tree, join(projectConfig.root, `.eslintrc.json`), eslintRc);
 }
 
 function isBuildableLibraryProject(
@@ -177,6 +195,21 @@ function isBuildableLibraryProject(
   );
 }
 
+function isJsAnalyzeSourceFilesEnabled(tree: Tree): boolean {
+  const nxJson = readJson<NxJsonConfiguration>(tree, 'nx.json');
+  const jsPluginConfig = nxJson.pluginsConfig?.['@nx/js'] as {
+    analyzeSourceFiles?: boolean;
+  };
+
+  if (nxJson.extends === 'nx/presets/npm.json') {
+    // npm preset turns off analyzeSourceFiles, but check if user has overridden it.
+    return jsPluginConfig?.analyzeSourceFiles ?? false;
+  }
+
+  // By default the JS plugin enables analyzeSourceFiles as long as user did not override it.
+  return jsPluginConfig?.analyzeSourceFiles ?? true;
+}
+
 /**
  * Detect based on the state of lint target configuration of the root project
  * if we should migrate eslint configs to monorepo style