@code-pushup/eslint-plugin 0.53.0 → 0.54.0

package/README.md

@@ -72,6 +72,12 @@ Detected ESLint rules are mapped to Code PushUp audits. Audit reports are calcul
      };
      ```
 
+     You can also exclude specific projects if needed by passing their names in the `exclude` option:
+
+     ```js
+     await eslintConfigFromAllNxProjects({ exclude: ['server'] });
+     ```
+
    - If you wish to target a specific project along with other projects it depends on, use the `eslintConfigFromNxProjectAndDeps` helper and pass in in your project name:
 
      ```js

package/bin.js

@@ -16,7 +16,7 @@ var MAX_ISSUE_MESSAGE_LENGTH = 1024;
 var slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
 function hasDuplicateStrings(strings) {
-  const sortedStrings = [...strings].sort();
+  const sortedStrings = strings.toSorted();
   const duplStrings = sortedStrings.filter(
     (item, index) => index !== 0 && item === sortedStrings[index - 1]
   );
@@ -110,7 +110,6 @@ var fileNameSchema = z.string().trim().regex(filenameRegex, {
   message: `The filename has to be valid`
 }).min(1, { message: "file name is invalid" });
 var positiveIntSchema = z.number().int().positive();
-var nonnegativeIntSchema = z.number().int().nonnegative();
 var nonnegativeNumberSchema = z.number().nonnegative();
 function packageVersionSchema(options) {
   const { versionDescription = "NPM version of the package", required } = options ?? {};
@@ -654,7 +653,7 @@ var auditDiffSchema = scorableWithPluginDiffSchema.merge(
   z16.object({
     values: makeComparisonSchema(auditValueSchema).merge(
       z16.object({
-        diff: z16.number().int().describe("Value change (`values.after - values.before`)")
+        diff: z16.number().describe("Value change (`values.after - values.before`)")
       })
     ).describe("Audit `value` comparison"),
     displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
@@ -747,6 +746,7 @@ function executeProcess(cfg) {
   return new Promise((resolve, reject) => {
     const spawnedProcess = spawn(command, args ?? [], {
       shell: true,
+      windowsHide: true,
       ...options
     });
     let stdout = "";
@@ -1079,7 +1079,7 @@ function toAudit(slug, issues) {
     auditIssues.map(({ severity }) => severity)
   );
   const severities = objectToEntries(severityCounts);
-  const summaryText = [...severities].sort((a, b) => -compareIssueSeverity(a[0], b[0])).map(([severity, count = 0]) => pluralizeToken(severity, count)).join(", ");
+  const summaryText = severities.toSorted((a, b) => -compareIssueSeverity(a[0], b[0])).map(([severity, count = 0]) => pluralizeToken(severity, count)).join(", ");
   return {
     slug,
     score: Number(auditIssues.length === 0),
@@ -1129,9 +1129,7 @@ var PLUGIN_CONFIG_PATH = join3(
   "plugin-config.json"
 );
 async function executeRunner() {
-  const { slugs, targets } = await readJsonFile(
-    PLUGIN_CONFIG_PATH
-  );
+  const { slugs, targets } = await readJsonFile(PLUGIN_CONFIG_PATH);
   const linterOutputs = await targets.reduce(
     async (acc, target) => [...await acc, await lint(target)],
     Promise.resolve([])

package/index.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
 
 // packages/plugin-eslint/package.json
 var name = "@code-pushup/eslint-plugin";
-var version = "0.53.0";
+var version = "0.54.0";
 
 // packages/plugin-eslint/src/lib/config.ts
 import { z as z17 } from "zod";
@@ -23,7 +23,7 @@ var MAX_ISSUE_MESSAGE_LENGTH = 1024;
 var slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
 function hasDuplicateStrings(strings) {
-  const sortedStrings = [...strings].sort();
+  const sortedStrings = strings.toSorted();
   const duplStrings = sortedStrings.filter(
     (item, index) => index !== 0 && item === sortedStrings[index - 1]
   );
@@ -117,7 +117,6 @@ var fileNameSchema = z.string().trim().regex(filenameRegex, {
   message: `The filename has to be valid`
 }).min(1, { message: "file name is invalid" });
 var positiveIntSchema = z.number().int().positive();
-var nonnegativeIntSchema = z.number().int().nonnegative();
 var nonnegativeNumberSchema = z.number().nonnegative();
 function packageVersionSchema(options) {
   const { versionDescription = "NPM version of the package", required } = options ?? {};
@@ -661,7 +660,7 @@ var auditDiffSchema = scorableWithPluginDiffSchema.merge(
   z16.object({
     values: makeComparisonSchema(auditValueSchema).merge(
       z16.object({
-        diff: z16.number().int().describe("Value change (`values.after - values.before`)")
+        diff: z16.number().describe("Value change (`values.after - values.before`)")
       })
     ).describe("Audit `value` comparison"),
     displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
@@ -1051,7 +1050,7 @@ function groupsFromRuleCategories(rules) {
       })
     )
   );
-  return [...groups].sort((a, b) => a.slug.localeCompare(b.slug));
+  return groups.toSorted((a, b) => a.slug.localeCompare(b.slug));
 }
 
 // packages/plugin-eslint/src/lib/meta/transform.ts
@@ -1133,6 +1132,25 @@ async function eslintPlugin(config) {
   };
 }
 
+// packages/plugin-eslint/src/lib/nx/filter-project-graph.ts
+function filterProjectGraph(projectGraph, exclude = []) {
+  const filteredNodes = Object.entries(
+    projectGraph.nodes
+  ).reduce(
+    (acc, [projectName, projectNode]) => exclude.includes(projectName) ? acc : { ...acc, [projectName]: projectNode },
+    {}
+  );
+  const filteredDependencies = Object.entries(projectGraph.dependencies).reduce(
+    (acc, [key, deps]) => exclude.includes(key) ? acc : { ...acc, [key]: deps },
+    {}
+  );
+  return {
+    nodes: filteredNodes,
+    dependencies: filteredDependencies,
+    version: projectGraph.version
+  };
+}
+
 // packages/plugin-eslint/src/lib/nx/utils.ts
 import { join as join4 } from "node:path";
 async function findCodePushupEslintrc(project) {
@@ -1184,10 +1202,14 @@ async function nxProjectsToConfig(projectGraph, predicate = () => true) {
 }
 
 // packages/plugin-eslint/src/lib/nx/find-all-projects.ts
-async function eslintConfigFromAllNxProjects() {
+async function eslintConfigFromAllNxProjects(options = {}) {
   const { createProjectGraphAsync } = await import("@nx/devkit");
   const projectGraph = await createProjectGraphAsync({ exitOnError: false });
-  return nxProjectsToConfig(projectGraph);
+  const filteredProjectGraph = filterProjectGraph(
+    projectGraph,
+    options.exclude
+  );
+  return nxProjectsToConfig(filteredProjectGraph);
 }
 var eslintConfigFromNxProjects = eslintConfigFromAllNxProjects;
 

package/package.json

@@ -1,35 +1,56 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "license": "MIT",
   "description": "Code PushUp plugin for detecting problems in source code using ESLint.📋",
-  "dependencies": {
-    "@code-pushup/utils": "0.53.0",
-    "@code-pushup/models": "0.53.0",
-    "eslint": "^8.46.0",
-    "zod": "^3.22.4"
-  },
-  "peerDependencies": {
-    "@nx/devkit": "^17.0.0 || ^18.0.0 || ^19.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@nx/devkit": {
-      "optional": true
-    }
-  },
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-eslint#readme",
   "bugs": {
-    "url": "https://github.com/code-pushup/cli/issues"
+    "url": "https://github.com/code-pushup/cli/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20label%3A\"🧩%20eslint-plugin\""
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/plugin-eslint"
   },
+  "keywords": [
+    "CLI",
+    "Code PushUp",
+    "ESLint",
+    "JavaScript",
+    "TypeScript",
+    "plugin",
+    "static analysis",
+    "linting",
+    "audit",
+    "performance",
+    "score monitoring",
+    "code quality",
+    "conformance",
+    "KPI tracking",
+    "tech debt",
+    "automated feedback",
+    "regression guard",
+    "actionable feedback",
+    "trend analysis"
+  ],
   "publishConfig": {
     "access": "public"
   },
   "type": "module",
   "main": "./index.js",
-  "types": "./src/index.d.ts"
-}
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@code-pushup/utils": "0.54.0",
+    "@code-pushup/models": "0.54.0",
+    "eslint": "^8.46.0",
+    "zod": "^3.22.4"
+  },
+  "peerDependencies": {
+    "@nx/devkit": ">=17.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nx/devkit": {
+      "optional": true
+    }
+  }
+}

package/src/lib/nx/filter-project-graph.d.ts

@@ -0,0 +1,2 @@
+import type { ProjectGraph } from '@nx/devkit';
+export declare function filterProjectGraph(projectGraph: ProjectGraph, exclude?: string[]): ProjectGraph;

package/src/lib/nx/find-all-projects.d.ts

@@ -2,8 +2,11 @@ import type { ESLintTarget } from '../config';
 /**
  * Finds all Nx projects in workspace and converts their lint configurations to Code PushUp ESLint plugin parameters.
  *
+ * Allows excluding certain projects from the configuration using the `options.exclude` parameter.
+ *
  * Use when you wish to automatically include every Nx project in a single Code PushUp project.
- * If you prefer to only include a subset of your Nx monorepo, refer to {@link eslintConfigFromNxProjectAndDeps} instead.
+ * If you prefer to include only a subset of your Nx monorepo, specify projects to exclude using the `exclude` option
+ * or consider using {@link eslintConfigFromNxProjectAndDeps} for finer control.
  *
  * @example
  * import eslintPlugin, {
@@ -13,14 +16,18 @@ import type { ESLintTarget } from '../config';
  * export default {
  *   plugins: [
  *     await eslintPlugin(
- *       await eslintConfigFromAllNxProjects()
+ *       await eslintConfigFromAllNxProjects({ exclude: ['server'] })
  *     )
  *   ]
  * }
  *
+ * @param options - Configuration options to filter projects
+ * @param options.exclude - Array of project names to exclude from the ESLint configuration
  * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin}
  */
-export declare function eslintConfigFromAllNxProjects(): Promise<ESLintTarget[]>;
+export declare function eslintConfigFromAllNxProjects(options?: {
+    exclude?: string[];
+}): Promise<ESLintTarget[]>;
 /**
  * @deprecated
  * Helper is renamed, please use `eslintConfigFromAllNxProjects` function instead.