refactor: add eslint rules (#470)

Author: BioPhoton

packages/nx-plugin/.eslintrc.json

@@ -1,15 +1,35 @@
 {
-  "extends": ["./code-pushup.eslintrc.json"],
-  // temporarily disable failing rules so `nx lint` passes
-  // number of errors/warnings per rule recorded at Tue Nov 28 2023 15:38:26 GMT+0100 (Central European Standard Time)
-  "rules": {
-    "no-param-reassign": "off", // 4 errors
-    "@typescript-eslint/no-unsafe-assignment": "off", // 14 errors
-    "@typescript-eslint/no-unsafe-member-access": "off", // 16 errors
-    "@typescript-eslint/no-unsafe-return": "off", // 2 errors
-    "@typescript-eslint/require-await": "off", // 1 error
-    "n/no-sync": "off", // 3 warnings
-    "sonarjs/no-duplicate-string": "off", // 1 warning
-    "unicorn/prefer-module": "off" // 3 warnings
-  }
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": ["packages/nx-plugin/tsconfig.*?.json"]
+      },
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    },
+    {
+      "files": ["./package.json", "./generators.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/nx-plugin-checks": "error"
+      }
+    }
+  ]
 }

packages/nx-plugin/code-pushup.eslintrc.json

@@ -4,7 +4,9 @@
   "license": "MIT",
   "dependencies": {
     "@nx/devkit": "^17.1.3",
-    "tslib": "2.6.2"
+    "tslib": "2.6.2",
+    "@code-pushup/utils": "*",
+    "nx": "17.1.3"
   },
   "type": "commonjs",
   "main": "./src/index.js",

packages/nx-plugin/package.json

@@ -5,7 +5,8 @@ import {
   readProjectConfiguration,
   updateProjectConfiguration,
 } from '@nx/devkit';
-import { join } from 'node:path';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { AddToProjectGeneratorSchema } from './schema';
 
 export async function addToProjectGenerator(
@@ -21,7 +22,12 @@ export async function addToProjectGenerator(
     return;
   }
 
-  generateFiles(tree, join(__dirname, 'files'), root, options);
+  generateFiles(
+    tree,
+    join(fileURLToPath(dirname(import.meta.url)), 'files'),
+    root,
+    options,
+  );
 
   updateProjectConfiguration(tree, options.project, {
     ...projectConfiguration,

packages/nx-plugin/src/generators/configuration/generator.ts

@@ -25,8 +25,8 @@ describe('init generator', () => {
     tree = createTreeWithEmptyWorkspace();
   });
 
-  it('should run successfully', async () => {
-    await initGenerator(tree, options);
+  it('should run successfully', () => {
+    initGenerator(tree, options);
     // nx.json
     const targetDefaults = readNxJson(tree)!.targetDefaults!;
     expect(targetDefaults).toHaveProperty(cpTargetName);
@@ -43,8 +43,8 @@ describe('init generator', () => {
     ).toHaveLength(devDependencyNames.length);
   });
 
-  it('should skip packageJson', async () => {
-    await initGenerator(tree, { ...options, skipPackageJson: true });
+  it('should skip packageJson', () => {
+    initGenerator(tree, { ...options, skipPackageJson: true });
     // nx.json
     const targetDefaults = readNxJson(tree)!.targetDefaults!;
     expect(targetDefaults).toHaveProperty(cpTargetName);

packages/nx-plugin/src/generators/init/generator.integration.test.ts

@@ -10,42 +10,54 @@ import {
   updateJson,
   updateNxJson,
 } from '@nx/devkit';
+import { PackageJson } from 'nx/src/utils/package-json';
 import {
-  cpuCliVersion,
-  cpuModelVersion,
-  cpuNxPluginVersion,
-  cpuUtilsVersion,
+  cpCliVersion,
+  cpModelVersion,
+  cpNxPluginVersion,
+  cpUtilsVersion,
 } from '../../utils/versions';
 import { InitGeneratorSchema } from './schema';
 
+const nxPluginPackageName = '@code-pushup/nx-plugin';
+
 function checkDependenciesInstalled(host: Tree) {
-  const packageJson = readJson(host, 'package.json');
+  const packageJson = readJson<PackageJson>(host, 'package.json');
   const devDependencies: Record<string, string> = {};
   const dependencies = {};
-  packageJson.dependencies = packageJson.dependencies || {};
-  packageJson.devDependencies = packageJson.devDependencies || {};
+  packageJson.dependencies = packageJson.dependencies ?? {};
+  packageJson.devDependencies = packageJson.devDependencies ?? {};
 
   // base deps
-  devDependencies['@code-pushup/nx-plugin'] = cpuNxPluginVersion;
-  devDependencies['@code-pushup/models'] = cpuModelVersion;
-  devDependencies['@code-pushup/utils'] = cpuUtilsVersion;
-  devDependencies['@code-pushup/cli'] = cpuCliVersion;
+  devDependencies[nxPluginPackageName] = cpNxPluginVersion;
+  devDependencies['@code-pushup/models'] = cpModelVersion;
+  devDependencies['@code-pushup/utils'] = cpUtilsVersion;
+  devDependencies['@code-pushup/cli'] = cpCliVersion;
 
   return addDependenciesToPackageJson(host, dependencies, devDependencies);
 }
 
 function moveToDevDependencies(tree: Tree) {
-  updateJson(tree, 'package.json', packageJson => {
-    packageJson.dependencies = packageJson.dependencies || {};
-    packageJson.devDependencies = packageJson.devDependencies || {};
+  updateJson(tree, 'package.json', (packageJson: PackageJson) => {
+    const newPackageJson: PackageJson = {
+      dependencies: {},
+      devDependencies: {},
+      ...packageJson,
+    };
 
-    if (packageJson.dependencies['@code-pushup/nx-plugin']) {
-      packageJson.devDependencies['@code-pushup/nx-plugin'] =
-        packageJson.dependencies['@code-pushup/nx-plugin'];
-      delete packageJson.dependencies['@code-pushup/nx-plugin'];
+    if (newPackageJson.dependencies?.[nxPluginPackageName] !== undefined) {
+      const { [nxPluginPackageName]: version, ...dependencies } =
+        newPackageJson.dependencies;
+      return {
+        ...newPackageJson,
+        dependencies,
+        devDependencies: {
+          ...newPackageJson.devDependencies,
+          [nxPluginPackageName]: version,
+        },
+      };
     }
-
-    return packageJson;
+    return newPackageJson;
   });
 }
 
@@ -63,7 +75,7 @@ function updateNxJsonConfig(tree: Tree) {
   updateNxJson(tree, nxJson);
 }
 
-export async function initGenerator(tree: Tree, schema: InitGeneratorSchema) {
+export function initGenerator(tree: Tree, schema: InitGeneratorSchema) {
   if (!schema.skipPackageJson) {
     moveToDevDependencies(tree);
   }

packages/nx-plugin/src/generators/init/generator.ts

@@ -1,3 +1,3 @@
 export * from './utils/versions';
 export { type InitGeneratorSchema } from './generators/init/schema';
-export { initGenerator } from './generators/init/generator';
+export { initGenerator, initSchematic } from './generators/init/generator';

packages/nx-plugin/src/index.ts

@@ -1,20 +1,25 @@
-import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import type { PackageJson } from 'nx/src/utils/package-json';
+import { readJsonFile } from '@code-pushup/utils';
 
-const workspaceRoot = join(__dirname, '../../');
-const projectsFolder = join(__dirname, '../../../');
+const workspaceRoot = join(fileURLToPath(dirname(import.meta.url)), '../../');
+const projectsFolder = join(
+  fileURLToPath(dirname(import.meta.url)),
+  '../../../',
+);
 
-export const cpuNxPluginVersion = loadPackageJson(workspaceRoot).version;
-export const cpuModelVersion = loadPackageJson(
-  join(projectsFolder, 'cli'),
+export const cpNxPluginVersion = (await loadPackageJson(workspaceRoot)).version;
+export const cpModelVersion = (
+  await loadPackageJson(join(projectsFolder, 'cli'))
 ).version;
-export const cpuUtilsVersion = loadPackageJson(
-  join(projectsFolder, 'utils'),
+export const cpUtilsVersion = (
+  await loadPackageJson(join(projectsFolder, 'utils'))
 ).version;
-export const cpuCliVersion = loadPackageJson(
-  join(projectsFolder, 'models'),
+export const cpCliVersion = (
+  await loadPackageJson(join(projectsFolder, 'models'))
 ).version;
 
-function loadPackageJson(folderPath: string) {
-  return JSON.parse(readFileSync(join(folderPath, 'package.json')).toString());
+async function loadPackageJson(folderPath: string): Promise<PackageJson> {
+  return readJsonFile<PackageJson>(join(folderPath, 'package.json'));
 }

packages/nx-plugin/src/utils/versions.ts

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "module": "commonjs"
+    "module": "ESNext"
   },
   "files": [],
   "include": [],