fix(repo): lookup for installed plugins in package.json

In addition, we refactor the plugin capabilities and installed plugin methods to avoid references to `node_modules`.
nrwl · Sep 25, 2020 · 341cc6b · 341cc6b
1 parent c3334d0
commit 341cc6b
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 46 deletions.
diff --git a/packages/workspace/src/command-line/list.ts b/packages/workspace/src/command-line/list.ts
@@ -4,7 +4,7 @@ import { output } from '../utils/output';
 import {
   fetchCommunityPlugins,
   fetchCorePlugins,
-  getInstalledPluginsFromNodeModules,
+  getInstalledPluginsFromPackageJson,
   listCommunityPlugins,
   listCorePlugins,
   listInstalledPlugins,
@@ -43,7 +43,7 @@ async function listHandler(args: YargsListArgs) {
   } else {
     const corePlugins = await fetchCorePlugins();
     const communityPlugins = await fetchCommunityPlugins();
-    const installedPlugins = getInstalledPluginsFromNodeModules(
+    const installedPlugins = getInstalledPluginsFromPackageJson(
       appRootPath,
       corePlugins,
       communityPlugins

diff --git a/packages/workspace/src/utils/plugins/index.ts b/packages/workspace/src/utils/plugins/index.ts
@@ -4,7 +4,7 @@ export {
 } from './community-plugins';
 export { fetchCorePlugins, listCorePlugins } from './core-plugins';
 export {
-  getInstalledPluginsFromNodeModules,
+  getInstalledPluginsFromPackageJson,
   listInstalledPlugins,
 } from './installed-plugins';
 export {

diff --git a/packages/workspace/src/utils/plugins/installed-plugins.ts b/packages/workspace/src/utils/plugins/installed-plugins.ts
@@ -1,50 +1,36 @@
 import { terminal } from '@angular-devkit/core';
-import { readdirSync } from 'fs';
-import * as path from 'path';
+import { readJsonFile } from '../fileutils';
 import { output } from '../output';
 import { CommunityPlugin, CorePlugin, PluginCapabilities } from './models';
 import { getPluginCapabilities } from './plugin-capabilities';
 import { hasElements } from './shared';
 
-function getPackagesFromNodeModules(
-  workspaceRoot: string,
-  requery: boolean = false
-): string[] {
-  let packageList: string[] = [];
-
-  if (!requery && packageList.length > 0) {
-    return packageList;
-  }
-
-  const nodeModulesDir = path.join(workspaceRoot, 'node_modules');
-  readdirSync(nodeModulesDir).forEach((npmPackageOrScope) => {
-    if (npmPackageOrScope.startsWith('@')) {
-      readdirSync(path.join(nodeModulesDir, npmPackageOrScope)).forEach((p) => {
-        packageList.push(`${npmPackageOrScope}/${p}`);
-      });
-    } else {
-      packageList.push(npmPackageOrScope);
-    }
-  });
-
-  return packageList;
-}
-
-export function getInstalledPluginsFromNodeModules(
+export function getInstalledPluginsFromPackageJson(
   workspaceRoot: string,
   corePlugins: CorePlugin[],
   communityPlugins: CommunityPlugin[]
 ): Array<PluginCapabilities> {
-  const corePluginNames = corePlugins.map((p) => p.name);
-  const communityPluginNames = communityPlugins.map((p) => p.name);
-  const packages = getPackagesFromNodeModules(workspaceRoot);
+  const packageJson = readJsonFile(`${workspaceRoot}/package.json`);
 
-  return packages
-    .filter(
-      (name) =>
-        corePluginNames.indexOf(name) > -1 ||
-        communityPluginNames.indexOf(name) > -1
-    )
+  const plugins = new Set([
+    ...corePlugins.map((p) => p.name),
+    ...communityPlugins.map((p) => p.name),
+    ...Object.keys(packageJson.dependencies || {}),
+    ...Object.keys(packageJson.devDependencies || {}),
+  ]);
+
+  return [...plugins]
+    .filter((name) => {
+      try {
+        // Check for `package.json` existence instead of requiring the module itself
+        // because malformed entries like `main`, may throw false exceptions.
+        require.resolve(`${name}/package.json`, { paths: [workspaceRoot] });
+        return true;
+      } catch {
+        return false;
+      }
+    })
+    .sort()
     .map((name) => getPluginCapabilities(workspaceRoot, name))
     .filter((x) => x && !!(x.schematics || x.builders));
 }

diff --git a/packages/workspace/src/utils/plugins/plugin-capabilities.ts b/packages/workspace/src/utils/plugins/plugin-capabilities.ts
@@ -1,5 +1,4 @@
 import { terminal } from '@angular-devkit/core';
-import * as path from 'path';
 import { appRootPath } from '../app-root';
 import { detectPackageManager } from '../detect-package-manager';
 import { readJsonFile } from '../fileutils';
@@ -23,7 +22,8 @@ function getPackageManagerInstallCommand(): string {
 }
 
 function tryGetCollection<T>(
-  pluginPath: string,
+  workspaceRoot: string,
+  pluginName: string,
   jsonFile: string,
   propName: string
 ): T {
@@ -32,7 +32,10 @@ function tryGetCollection<T>(
   }
 
   try {
-    return readJsonFile<T>(path.join(pluginPath, jsonFile))[propName];
+    const jsonFilePath = require.resolve(`${pluginName}/${jsonFile}`, {
+      paths: [workspaceRoot],
+    });
+    return readJsonFile<T>(jsonFilePath)[propName];
   } catch {
     return null;
   }
@@ -43,16 +46,24 @@ export function getPluginCapabilities(
   pluginName: string
 ): PluginCapabilities {
   try {
-    const pluginPath = path.join(workspaceRoot, 'node_modules', pluginName);
-    const packageJson = readJsonFile(path.join(pluginPath, 'package.json'));
+    const packageJsonPath = require.resolve(`${pluginName}/package.json`, {
+      paths: [workspaceRoot],
+    });
+    const packageJson = readJsonFile(packageJsonPath);
     return {
       name: pluginName,
       schematics: tryGetCollection(
-        pluginPath,
+        workspaceRoot,
+        pluginName,
         packageJson.schematics,
         'schematics'
       ),
-      builders: tryGetCollection(pluginPath, packageJson.builders, 'builders'),
+      builders: tryGetCollection(
+        workspaceRoot,
+        pluginName,
+        packageJson.builders,
+        'builders'
+      ),
     };
   } catch {
     return null;