nx 19.6.0-canary.20240723-c4f9d89 → 19.6.0-canary.20240725-3890edc

package/src/utils/plugins/output.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listPlugins = listPlugins;
+exports.listAlsoAvailableCorePlugins = listAlsoAvailableCorePlugins;
+exports.listPluginCapabilities = listPluginCapabilities;
+const chalk = require("chalk");
+const output_1 = require("../output");
+const package_manager_1 = require("../package-manager");
+const workspace_root_1 = require("../workspace-root");
+const core_plugins_1 = require("./core-plugins");
+const plugin_capabilities_1 = require("./plugin-capabilities");
+const package_json_1 = require("../package-json");
+function listPlugins(plugins, title) {
+    package_json_1.readModulePackageJson;
+    const bodyLines = [];
+    for (const [, p] of plugins) {
+        const capabilities = [];
+        if (hasElements(p.executors)) {
+            capabilities.push('executors');
+        }
+        if (hasElements(p.generators)) {
+            capabilities.push('generators');
+        }
+        if (p.projectGraphExtension) {
+            capabilities.push('graph-extension');
+        }
+        if (p.projectInference) {
+            capabilities.push('project-inference');
+        }
+        bodyLines.push(`${chalk.bold(p.name)} (${capabilities.join()})`);
+    }
+    output_1.output.log({
+        title: title,
+        bodyLines: bodyLines,
+    });
+}
+function listAlsoAvailableCorePlugins(installedPlugins) {
+    const alsoAvailable = core_plugins_1.CORE_PLUGINS.filter((p) => !installedPlugins.has(p.name));
+    if (alsoAvailable.length) {
+        output_1.output.log({
+            title: `Also available:`,
+            bodyLines: alsoAvailable.map((p) => {
+                return `${chalk.bold(p.name)} (${p.capabilities})`;
+            }),
+        });
+    }
+}
+async function listPluginCapabilities(pluginName, projects) {
+    const plugin = await (0, plugin_capabilities_1.getPluginCapabilities)(workspace_root_1.workspaceRoot, pluginName, projects);
+    if (!plugin) {
+        const pmc = (0, package_manager_1.getPackageManagerCommand)();
+        output_1.output.note({
+            title: `${pluginName} is not currently installed`,
+            bodyLines: [
+                `Use "${pmc.addDev} ${pluginName}" to install the plugin.`,
+                `After that, use "${pmc.exec} nx g ${pluginName}:init" to add the required peer deps and initialize the plugin.`,
+            ],
+        });
+        return;
+    }
+    const hasBuilders = hasElements(plugin.executors);
+    const hasGenerators = hasElements(plugin.generators);
+    const hasProjectGraphExtension = !!plugin.projectGraphExtension;
+    const hasProjectInference = !!plugin.projectInference;
+    if (!hasBuilders &&
+        !hasGenerators &&
+        !hasProjectGraphExtension &&
+        !hasProjectInference) {
+        output_1.output.warn({ title: `No capabilities found in ${pluginName}` });
+        return;
+    }
+    const bodyLines = [];
+    if (hasGenerators) {
+        bodyLines.push(chalk.bold(chalk.green('GENERATORS')));
+        bodyLines.push('');
+        bodyLines.push(...Object.keys(plugin.generators).map((name) => `${chalk.bold(name)} : ${plugin.generators[name].description}`));
+        if (hasBuilders) {
+            bodyLines.push('');
+        }
+    }
+    if (hasBuilders) {
+        bodyLines.push(chalk.bold(chalk.green('EXECUTORS/BUILDERS')));
+        bodyLines.push('');
+        bodyLines.push(...Object.keys(plugin.executors).map((name) => {
+            const definition = plugin.executors[name];
+            return typeof definition === 'string'
+                ? chalk.bold(name)
+                : `${chalk.bold(name)} : ${definition.description}`;
+        }));
+    }
+    if (hasProjectGraphExtension) {
+        bodyLines.push(`✔️  Project Graph Extension`);
+    }
+    if (hasProjectInference) {
+        bodyLines.push(`✔️  Project Inference`);
+    }
+    output_1.output.log({
+        title: `Capabilities in ${plugin.name}:`,
+        bodyLines,
+    });
+}
+function hasElements(obj) {
+    return obj && Object.values(obj).length > 0;
+}

package/src/utils/plugins/plugin-capabilities.d.ts

@@ -1,4 +1,14 @@
+import { ExecutorsJsonEntry, GeneratorsJsonEntry } from '../../config/misc-interfaces';
 import { ProjectConfiguration } from '../../config/workspace-json-project-json';
-import type { PluginCapabilities } from './models';
+export interface PluginCapabilities {
+    name: string;
+    executors?: {
+        [name: string]: ExecutorsJsonEntry;
+    };
+    generators?: {
+        [name: string]: GeneratorsJsonEntry;
+    };
+    projectInference?: boolean;
+    projectGraphExtension?: boolean;
+}
 export declare function getPluginCapabilities(workspaceRoot: string, pluginName: string, projects: Record<string, ProjectConfiguration>, includeRuntimeCapabilities?: boolean): Promise<PluginCapabilities | null>;
-export declare function listPluginCapabilities(pluginName: string, projects: Record<string, ProjectConfiguration>): Promise<void>;

package/src/utils/plugins/plugin-capabilities.js

@@ -1,17 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPluginCapabilities = getPluginCapabilities;
-exports.listPluginCapabilities = listPluginCapabilities;
-const chalk = require("chalk");
 const path_1 = require("path");
-const plugins_1 = require("../../project-graph/plugins");
-const loader_1 = require("../../project-graph/plugins/loader");
 const fileutils_1 = require("../fileutils");
 const installation_directory_1 = require("../installation-directory");
-const output_1 = require("../output");
-const package_manager_1 = require("../package-manager");
-const workspace_root_1 = require("../workspace-root");
-const shared_1 = require("./shared");
+const plugins_1 = require("../../project-graph/plugins");
+const loader_1 = require("../../project-graph/plugins/loader");
 function tryGetCollection(packageJsonPath, collectionFile, propName) {
     if (!collectionFile) {
         return null;
@@ -78,82 +72,3 @@ async function tryGetModule(packageJson, workspaceRoot) {
         return null;
     }
 }
-async function listPluginCapabilities(pluginName, projects) {
-    const plugin = await getPluginCapabilities(workspace_root_1.workspaceRoot, pluginName, projects);
-    if (!plugin) {
-        const pmc = (0, package_manager_1.getPackageManagerCommand)();
-        output_1.output.note({
-            title: `${pluginName} is not currently installed`,
-            bodyLines: [
-                `Use "${pmc.addDev} ${pluginName}" to install the plugin.`,
-                `After that, use "${pmc.exec} nx g ${pluginName}:init" to add the required peer deps and initialize the plugin.`,
-            ],
-        });
-        return;
-    }
-    const hasBuilders = (0, shared_1.hasElements)(plugin.executors);
-    const hasGenerators = (0, shared_1.hasElements)(plugin.generators);
-    const hasProjectGraphExtension = !!plugin.projectGraphExtension;
-    const hasProjectInference = !!plugin.projectInference;
-    if (!hasBuilders &&
-        !hasGenerators &&
-        !hasProjectGraphExtension &&
-        !hasProjectInference) {
-        output_1.output.warn({ title: `No capabilities found in ${pluginName}` });
-        return;
-    }
-    const bodyLines = [];
-    if (hasGenerators) {
-        bodyLines.push(chalk.bold(chalk.green('GENERATORS')));
-        bodyLines.push('');
-        bodyLines.push(...Object.keys(plugin.generators).map((name) => `${chalk.bold(name)} : ${plugin.generators[name].description}`));
-        if (hasBuilders) {
-            bodyLines.push('');
-        }
-    }
-    if (hasBuilders) {
-        bodyLines.push(chalk.bold(chalk.green('EXECUTORS/BUILDERS')));
-        bodyLines.push('');
-        bodyLines.push(...Object.keys(plugin.executors).map((name) => `${chalk.bold(name)} : ${resolveExecutorDescription(pluginName, plugin.executors[name], projects)}`));
-    }
-    if (hasProjectGraphExtension) {
-        bodyLines.push(`✔️  Project Graph Extension`);
-    }
-    if (hasProjectInference) {
-        bodyLines.push(`✔️  Project Inference`);
-    }
-    output_1.output.log({
-        title: `Capabilities in ${plugin.name}:`,
-        bodyLines,
-    });
-}
-function resolveExecutorDescription(pluginName, executorJsonEntry, projects, requirePaths = (0, installation_directory_1.getNxRequirePaths)(workspace_root_1.workspaceRoot)) {
-    try {
-        if (typeof executorJsonEntry === 'string') {
-            // it points to another executor, resolve it
-            const [pkgName, executor] = executorJsonEntry.split(':');
-            // read the package.json of the parent plugin
-            const { path: packageJsonPath } = (0, plugins_1.readPluginPackageJson)(pluginName, projects, requirePaths);
-            // accumulate the require paths to resolve nested packages
-            const cummulativeRequirePaths = [
-                ...requirePaths,
-                (0, path_1.dirname)(packageJsonPath),
-            ];
-            const collection = loadExecutorsCollection(pkgName, projects, cummulativeRequirePaths);
-            return resolveExecutorDescription(pkgName, collection[executor], projects, cummulativeRequirePaths);
-        }
-        return executorJsonEntry.description;
-    }
-    catch {
-        return 'No description available';
-    }
-}
-function loadExecutorsCollection(pluginName, projects, requirePaths) {
-    const { json: packageJson, path: packageJsonPath } = (0, plugins_1.readPluginPackageJson)(pluginName, projects, requirePaths);
-    return {
-        ...tryGetCollection(packageJsonPath, packageJson.builders, 'builders'),
-        ...tryGetCollection(packageJsonPath, packageJson.executors, 'builders'),
-        ...tryGetCollection(packageJsonPath, packageJson.builders, 'executors'),
-        ...tryGetCollection(packageJsonPath, packageJson.executors, 'executors'),
-    };
-}

package/src/utils/plugins/community-plugins.d.ts

@@ -1,2 +0,0 @@
-import type { CommunityPlugin } from './models';
-export declare function fetchCommunityPlugins(): Promise<CommunityPlugin[]>;

package/src/utils/plugins/community-plugins.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchCommunityPlugins = fetchCommunityPlugins;
-const https_1 = require("https");
-const COMMUNITY_PLUGINS_JSON_URL = 'https://raw.githubusercontent.com/nrwl/nx/master/community/approved-plugins.json';
-async function fetchCommunityPlugins() {
-    return new Promise((resolve, reject) => {
-        const req = (0, https_1.get)(COMMUNITY_PLUGINS_JSON_URL, (res) => {
-            if (res.statusCode < 200 || res.statusCode >= 300) {
-                reject(new Error(`Request failed with status code ${res.statusCode}`));
-            }
-            const data = [];
-            res.on('data', (chunk) => {
-                data.push(chunk);
-            });
-            res.on('end', () => {
-                try {
-                    resolve(JSON.parse(Buffer.concat(data).toString('utf-8')));
-                }
-                catch (e) {
-                    reject(e);
-                }
-            });
-        });
-        req.on('error', reject);
-        req.end();
-    });
-}

package/src/utils/plugins/models.d.ts

@@ -1,22 +0,0 @@
-import { ExecutorsJsonEntry, GeneratorsJsonEntry } from '../../config/misc-interfaces';
-export interface PluginCapabilities {
-    name: string;
-    executors?: {
-        [name: string]: ExecutorsJsonEntry;
-    };
-    generators?: {
-        [name: string]: GeneratorsJsonEntry;
-    };
-    projectInference?: boolean;
-    projectGraphExtension?: boolean;
-}
-export interface CorePlugin {
-    name: string;
-    capabilities: 'executors' | 'generators' | 'executors,generators';
-    link?: string;
-}
-export interface CommunityPlugin {
-    name: string;
-    url: string;
-    description: string;
-}

package/src/utils/plugins/models.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/utils/plugins/shared.d.ts

@@ -1 +0,0 @@
-export declare function hasElements(obj: any): boolean;

package/src/utils/plugins/shared.js

@@ -1,7 +0,0 @@
-"use strict";
-// Lifted in part from https://github.com/nrwl/angular-console
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasElements = hasElements;
-function hasElements(obj) {
-    return obj && Object.values(obj).length > 0;
-}