@code-pushup/eslint-plugin 0.42.1 → 0.44.1

package/README.md

@@ -59,28 +59,28 @@ Detected ESLint rules are mapped to Code PushUp audits. Audit reports are calcul
 
    If you're using an Nx monorepo, additional helper functions are provided to simplify your configuration:
 
-   - If you wish to combine all projects in your workspace into one report, use the `eslintConfigFromNxProjects` helper:
+   - If you wish to combine all projects in your workspace into one report, use the `eslintConfigFromAllNxProjects` helper:
 
      ```js
-     import eslintPlugin, { eslintConfigFromNxProjects } from '@code-pushup/eslint-plugin';
+     import eslintPlugin, { eslintConfigFromAllNxProjects } from '@code-pushup/eslint-plugin';
 
      export default {
        plugins: [
          // ...
-         await eslintPlugin(await eslintConfigFromNxProjects()),
+         await eslintPlugin(await eslintConfigFromAllNxProjects()),
        ],
      };
      ```
 
-   - If you wish to target a specific project along with other projects it depends on, use the `eslintConfigFromNxProject` helper and pass in in your project name:
+   - 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
-     import eslintPlugin, { eslintConfigFromNxProject } from '@code-pushup/eslint-plugin';
+     import eslintPlugin, { eslintConfigFromNxProjectAndDeps } from '@code-pushup/eslint-plugin';
 
      export default {
        plugins: [
          // ...
-         await eslintPlugin(await eslintConfigFromNxProject('<PROJECT-NAME>')),
+         await eslintPlugin(await eslintConfigFromNxProjectAndDeps('<PROJECT-NAME>')),
        ],
      };
      ```

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.42.1";
+var version = "0.44.1";
 
 // packages/plugin-eslint/src/lib/config.ts
 import { z as z16 } from "zod";
@@ -1427,11 +1427,26 @@ async function nxProjectsToConfig(projectGraph, predicate = () => true) {
 }
 
 // packages/plugin-eslint/src/lib/nx/find-all-projects.ts
-async function eslintConfigFromNxProjects() {
+async function eslintConfigFromAllNxProjects() {
   const { createProjectGraphAsync } = await import("@nx/devkit");
   const projectGraph = await createProjectGraphAsync({ exitOnError: false });
   return nxProjectsToConfig(projectGraph);
 }
+var eslintConfigFromNxProjects = eslintConfigFromAllNxProjects;
+
+// packages/plugin-eslint/src/lib/nx/find-project-without-deps.ts
+async function eslintConfigFromNxProject(projectName) {
+  const { createProjectGraphAsync } = await import("@nx/devkit");
+  const projectGraph = await createProjectGraphAsync({ exitOnError: false });
+  const [project] = await nxProjectsToConfig(
+    projectGraph,
+    ({ name: name2 }) => !!name2 && name2 === projectName
+  );
+  if (!project) {
+    throw new Error(`Couldn't find Nx project named "${projectName}"`);
+  }
+  return project;
+}
 
 // packages/plugin-eslint/src/lib/nx/traverse-graph.ts
 function findAllDependencies(entry, projectGraph) {
@@ -1451,7 +1466,7 @@ function findAllDependencies(entry, projectGraph) {
 }
 
 // packages/plugin-eslint/src/lib/nx/find-project-with-deps.ts
-async function eslintConfigFromNxProject(projectName) {
+async function eslintConfigFromNxProjectAndDeps(projectName) {
   const { createProjectGraphAsync } = await import("@nx/devkit");
   const projectGraph = await createProjectGraphAsync({ exitOnError: false });
   const dependencies = findAllDependencies(projectName, projectGraph);
@@ -1465,6 +1480,8 @@ async function eslintConfigFromNxProject(projectName) {
 var src_default = eslintPlugin;
 export {
   src_default as default,
+  eslintConfigFromAllNxProjects,
   eslintConfigFromNxProject,
+  eslintConfigFromNxProjectAndDeps,
   eslintConfigFromNxProjects
 };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.42.1",
+  "version": "0.44.1",
   "license": "MIT",
   "dependencies": {
-    "@code-pushup/utils": "0.42.1",
-    "@code-pushup/models": "0.42.1",
+    "@code-pushup/utils": "0.44.1",
+    "@code-pushup/models": "0.44.1",
     "eslint": "^8.46.0",
     "zod": "^3.22.4"
   },

package/src/index.d.ts

@@ -1,4 +1,4 @@
 import { eslintPlugin } from './lib/eslint-plugin';
 export default eslintPlugin;
 export type { ESLintPluginConfig } from './lib/config';
-export { eslintConfigFromNxProject, eslintConfigFromNxProjects, } from './lib/nx';
+export { eslintConfigFromNxProjectAndDeps, eslintConfigFromNxProjects, eslintConfigFromAllNxProjects, eslintConfigFromNxProject, } from './lib/nx';

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

@@ -3,21 +3,26 @@ import type { ESLintTarget } from '../config';
  * Finds all Nx projects in workspace and converts their lint configurations to Code PushUp ESLint plugin parameters.
  *
  * 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 eslintConfigFromNxProject} instead.
+ * If you prefer to only include a subset of your Nx monorepo, refer to {@link eslintConfigFromNxProjectAndDeps} instead.
  *
  * @example
  * import eslintPlugin, {
- *   eslintConfigFromNxProjects,
+ *   eslintConfigFromAllNxProjects,
  * } from '@code-pushup/eslint-plugin';
  *
  * export default {
  *   plugins: [
  *     await eslintPlugin(
- *       await eslintConfigFromNxProjects()
+ *       await eslintConfigFromAllNxProjects()
  *     )
  *   ]
  * }
  *
  * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin}
  */
-export declare function eslintConfigFromNxProjects(): Promise<ESLintTarget[]>;
+export declare function eslintConfigFromAllNxProjects(): Promise<ESLintTarget[]>;
+/**
+ * @deprecated
+ * Helper is renamed, please use `eslintConfigFromAllNxProjects` function instead.
+ */
+export declare const eslintConfigFromNxProjects: typeof eslintConfigFromAllNxProjects;

package/src/lib/nx/find-project-with-deps.d.ts

@@ -2,12 +2,13 @@ import type { ESLintTarget } from '../config';
 /**
  * Accepts a target Nx projects, finds projects it depends on, and converts lint configurations to Code PushUp ESLint plugin parameters.
  *
- * Use when you wish to include a targetted subset of your Nx monorepo in your Code PushUp project.
- * If you prefer to include all Nx projects, refer to {@link eslintConfigFromNxProjects} instead.
+ * Use when you wish to include a targeted subset of your Nx monorepo in your Code PushUp project.
+ * If you prefer to include all Nx projects, refer to {@link eslintConfigFromAllNxProjects} instead.
+ * if you'd like to skip dependencies of the provided target project use {@link eslintConfigFromNxProject} instead.
  *
  * @example
  * import eslintPlugin, {
- *   eslintConfigFromNxProject,
+ *   eslintConfigFromNxProjectAndDeps,
  * } from '@code-pushup/eslint-plugin';
  *
  * const projectName = 'backoffice'; // <-- name from project.json
@@ -15,7 +16,7 @@ import type { ESLintTarget } from '../config';
  * export default {
  *   plugins: [
  *     await eslintPlugin(
- *       await eslintConfigFromNxProject(projectName)
+ *       await eslintConfigFromNxProjectAndDeps(projectName)
  *     )
  *   ]
  * }
@@ -23,4 +24,4 @@ import type { ESLintTarget } from '../config';
  * @param projectName Nx project serving as main entry point
  * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin}
  */
-export declare function eslintConfigFromNxProject(projectName: string): Promise<ESLintTarget[]>;
+export declare function eslintConfigFromNxProjectAndDeps(projectName: string): Promise<ESLintTarget[]>;

package/src/lib/nx/find-project-without-deps.d.ts

@@ -0,0 +1,27 @@
+import type { ESLintTarget } from '../config';
+/**
+ * Accepts a target Nx project, converts its lint configuration to Code PushUp ESLint plugin parameters.
+ *
+ * Use when you wish to only have a single Nx project as your Code PushUp project, without any other dependencies.
+ * If you prefer to include all Nx projects, refer to {@link eslintConfigFromAllNxProjects} instead.
+ * If you'd like to auto include all dependencies of the provided target project use {@link eslintConfigFromNxProjectAndDeps} instead.
+ *
+ * @example
+ * import eslintPlugin, {
+ *   eslintConfigFromNxProject,
+ * } from '@code-pushup/eslint-plugin';
+ *
+ * const projectName = 'backoffice'; // <-- name from project.json
+ *
+ * export default {
+ *   plugins: [
+ *     await eslintPlugin(
+ *       await eslintConfigFromNxProject(projectName)
+ *     )
+ *   ]
+ * }
+ *
+ * @param projectName Nx project name
+ * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin}
+ */
+export declare function eslintConfigFromNxProject(projectName: string): Promise<ESLintTarget>;

package/src/lib/nx/index.d.ts

@@ -1,2 +1,3 @@
-export { eslintConfigFromNxProjects } from './find-all-projects';
-export { eslintConfigFromNxProject } from './find-project-with-deps';
+export { eslintConfigFromNxProjects, eslintConfigFromAllNxProjects, } from './find-all-projects';
+export { eslintConfigFromNxProject } from './find-project-without-deps';
+export { eslintConfigFromNxProjectAndDeps } from './find-project-with-deps';