feat(plugin-eslint): rename eslintConfigFromNxProjects to eslintConfigFromAllNxProjects

DEPRECATION: the old eslintConfigFromNxProjects stays as alias and is now deprecated
Signed-off-by: Vojtech Masek <vojtech@flowup.cz>

Author: vmasek

code-pushup.config.ts

@@ -12,7 +12,7 @@ import coveragePlugin, {
   getNxCoveragePaths,
 } from './dist/packages/plugin-coverage';
 import eslintPlugin, {
-  eslintConfigFromNxProjects,
+  eslintConfigFromAllNxProjects,
 } from './dist/packages/plugin-eslint';
 import jsPackagesPlugin from './dist/packages/plugin-js-packages';
 import {
@@ -46,7 +46,7 @@ const config: CoreConfig = {
     }),
 
   plugins: [
-    await eslintPlugin(await eslintConfigFromNxProjects()),
+    await eslintPlugin(await eslintConfigFromAllNxProjects()),
 
     await coveragePlugin({
       coverageToolCommand: {

packages/plugin-eslint/README.md

@@ -59,15 +59,15 @@ 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()),
        ],
      };
      ```

packages/plugin-eslint/src/index.ts

@@ -7,4 +7,5 @@ export type { ESLintPluginConfig } from './lib/config';
 export {
   eslintConfigFromNxProject,
   eslintConfigFromNxProjects,
+  eslintConfigFromAllNxProjects,
 } from './lib/nx';

packages/plugin-eslint/src/lib/nx.integration.test.ts

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url';
 import { setWorkspaceRoot, workspaceRoot } from 'nx/src/utils/workspace-root';
 import type { MockInstance } from 'vitest';
 import { type ESLintTarget } from './config';
-import { eslintConfigFromNxProject, eslintConfigFromNxProjects } from './nx';
+import { eslintConfigFromAllNxProjects, eslintConfigFromNxProject } from './nx';
 
 describe('Nx helpers', () => {
   let cwdSpy: MockInstance<[], string>;
@@ -33,7 +33,7 @@ describe('Nx helpers', () => {
 
   describe('create config from all Nx projects', () => {
     it('should include eslintrc and patterns of each project', async () => {
-      await expect(eslintConfigFromNxProjects()).resolves.toEqual([
+      await expect(eslintConfigFromAllNxProjects()).resolves.toEqual([
         {
           eslintrc: './packages/cli/.eslintrc.json',
           patterns: [

packages/plugin-eslint/src/lib/nx/find-all-projects.ts

@@ -9,21 +9,27 @@ import { nxProjectsToConfig } from './projects-to-config';
  *
  * @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 async function eslintConfigFromNxProjects(): Promise<ESLintTarget[]> {
+export async function eslintConfigFromAllNxProjects(): Promise<ESLintTarget[]> {
   const { createProjectGraphAsync } = await import('@nx/devkit');
   const projectGraph = await createProjectGraphAsync({ exitOnError: false });
   return nxProjectsToConfig(projectGraph);
 }
+
+/**
+ * @deprecated
+ * Helper is renamed, please use `eslintConfigFromAllNxProjects` function instead.
+ */
+export const eslintConfigFromNxProjects = eslintConfigFromAllNxProjects;

packages/plugin-eslint/src/lib/nx/find-project-with-deps.ts

@@ -5,8 +5,8 @@ import { findAllDependencies } from './traverse-graph';
 /**
  * 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.
  *
  * @example
  * import eslintPlugin, {

packages/plugin-eslint/src/lib/nx/index.ts

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