Use NodeJS require module to resolve packages and files/folders in it

Author: ringods

packages/cli/bin/install-edition.js

@@ -10,6 +10,8 @@ const {
   wrapAsync,
   writeJsonAsync,
   getJSONKey,
+  resolveFileInPackage,
+  resolveDirInPackage,
 } = require('./utils');
 
 // https://github.com/TehShrike/deepmerge#overwrite-array
@@ -31,7 +33,7 @@ const installEdition = (edition, config, projectDir) => {
     const sourceDir = config.paths.source.root;
     yield checkAndInstallPackage(edition); // 1
     yield copyAsync(
-      path.resolve('./node_modules', edition, 'source', '_meta'),
+      resolveDirInPackage(edition, 'source', '_meta'),
       path.resolve(sourceDir, '_meta')
     ); // 2
     pkg.dependencies = Object.assign(
@@ -45,16 +47,15 @@ const installEdition = (edition, config, projectDir) => {
       // 4.1
       case '@pattern-lab/edition-node-gulp': {
         yield copyAsync(
-          path.resolve('./node_modules', edition, 'gulpfile.js'),
+          resolveFileInPackage(edition, 'gulpfile.js'),
           path.resolve(sourceDir, '../', 'gulpfile.js')
         );
         break;
       }
       // 4.2
       case '@pattern-lab/edition-node': {
-        const editionPath = path.resolve('./node_modules', edition);
-        const editionConfigPath = path.resolve(
-          editionPath,
+        const editionConfigPath = resolveFileInPackage(
+          edition,
           'patternlab-config.json'
         );
 
@@ -67,7 +68,7 @@ const installEdition = (edition, config, projectDir) => {
         );
 
         yield copyAsync(
-          path.join(editionPath, path.sep, 'helpers', path.sep, 'test.js'),
+          resolveFileInPackage(edition, 'helpers', 'test.js'),
           path.resolve(sourceDir, '../', 'helpers/test.js')
         );
 
@@ -76,9 +77,8 @@ const installEdition = (edition, config, projectDir) => {
       }
       // 4.3
       case '@pattern-lab/edition-twig': {
-        const editionPath = path.resolve('./node_modules', edition);
-        const editionConfigPath = path.resolve(
-          editionPath,
+        const editionConfigPath = resolveFileInPackage(
+          edition,
           'patternlab-config.json'
         );
         const editionConfig = require(editionConfigPath);
@@ -90,7 +90,7 @@ const installEdition = (edition, config, projectDir) => {
         );
 
         yield copyAsync(
-          path.resolve(editionPath, 'alter-twig.php'),
+          resolveFileInPackage(edition, 'alter-twig.php'),
           path.resolve(sourceDir, '../', 'alter-twig.php')
         );
 

packages/cli/bin/install-plugin.js

@@ -1,11 +1,12 @@
 'use strict';
 
-const path = require('path');
-
 const _ = require('lodash');
 
-const checkAndInstallPackage = require('./utils').checkAndInstallPackage;
-const wrapAsync = require('./utils').wrapAsync;
+const {
+  checkAndInstallPackage,
+  wrapAsync,
+  resolveFileInPackage,
+} = require('./utils');
 
 const installPlugin = (plugin, config) =>
   wrapAsync(function*() {
@@ -16,9 +17,7 @@ const installPlugin = (plugin, config) =>
     _.set(config, `plugins[${name}]['initialized']`, false);
 
     // Get the options from the plugin, if any
-    const pluginPathConfig = path.resolve(
-      path.join(process.cwd(), 'node_modules', name, 'config.json')
-    );
+    const pluginPathConfig = resolveFileInPackage(name, 'config.json');
     try {
       const pluginConfigJSON = require(pluginPathConfig);
       if (!_.has(config.plugins[name].options)) {

packages/cli/bin/install-starterkit.js

@@ -6,17 +6,18 @@ const {
   wrapAsync,
   checkAndInstallPackage,
   readJsonAsync,
+  resolveFileInPackage,
+  resolveDirInPackage,
 } = require('./utils');
 
 const installStarterkit = (starterkit, config) =>
   wrapAsync(function*() {
     const sourceDir = config.paths.source.root;
     const name = starterkit.value || starterkit;
     yield checkAndInstallPackage(name);
-    const kitPath = path.resolve('./node_modules', name);
-    yield copyAsync(path.resolve(kitPath, 'dist'), path.resolve(sourceDir));
+    yield copyAsync(resolveDirInPackage(name, 'dist'), path.resolve(sourceDir));
     let kitConfig;
-    const kitConfigPath = path.resolve(kitPath, 'patternlab-config.json');
+    const kitConfigPath = resolveFileInPackage(name, 'patternlab-config.json');
     if (fs.existsSync(kitConfigPath)) {
       kitConfig = yield readJsonAsync(kitConfigPath);
     }

packages/cli/bin/utils.js

@@ -124,7 +124,7 @@ const copyWithPattern = (cwd, pattern, dest) =>
 
 /**
  * @func fetchPackage
- * @desc Fetches and saves packages from npm into node_modules and adds a reference in the package.json under dependencies
+ * @desc Fetches packages from an npm package registry and adds a reference in the package.json under dependencies
  * @param {string} packageName - The package name
  */
 const fetchPackage = packageName =>
@@ -182,6 +182,30 @@ const writeJsonAsync = (filePath, data) =>
     yield fs.outputJSON(filePath, data, { spaces: 2 });
   });
 
+/**
+ * @func resolveFileInPackage
+ * Resolves a file inside a package
+ */
+const resolveFileInPackage = (packageName, ...pathElements) => {
+  return require.resolve(path.join(packageName, ...pathElements));
+};
+
+/**
+ * @func resolveDirInPackage
+ * Resolves a file inside a package
+ */
+const resolveDirInPackage = (packageName, ...pathElements) => {
+  return path.dirname(resolveFileInPackage(packageName, pathElements));
+};
+
+/**
+ * @func resolvePackageFolder
+ * Resolves the location of a package on disc
+ */
+const resolvePackageFolder = packageName => {
+  return path.dirname(resolveDirInPackage(packageName, 'package.json'));
+};
+
 /**
  * @func getJSONKey
  * Installs package, then returns the value for the given JSON file's key within
@@ -193,7 +217,7 @@ const getJSONKey = (packageName, key, fileName = 'package.json') =>
   wrapAsync(function*() {
     yield checkAndInstallPackage(packageName);
     const jsonData = yield fs.readJson(
-      path.resolve('node_modules', packageName, fileName)
+      resolveFileInPackage(packageName, fileName)
     );
     return jsonData[key];
   });
@@ -213,4 +237,7 @@ module.exports = {
   checkAndInstallPackage,
   noop,
   getJSONKey,
+  resolveFileInPackage,
+  resolveDirInPackage,
+  resolvePackageFolder,
 };

packages/core/src/index.js

@@ -205,7 +205,7 @@ const patternlab_module = function(config) {
     },
 
     /**
-     * Installs plugin already available via `node_modules/`
+     * Installs plugin already available as a package dependency
      *
      * @memberof patternlab
      * @name installplugin
@@ -215,7 +215,6 @@ const patternlab_module = function(config) {
      */
     installplugin: function(pluginName) {
       //get the config
-      const configPath = path.resolve(process.cwd(), 'patternlab-config.json');
       const plugin_manager = new pm();
 
       plugin_manager.install_plugin(pluginName);
@@ -234,7 +233,7 @@ const patternlab_module = function(config) {
     },
 
     /**
-     * Loads starterkit already available via `node_modules/`
+     * Loads starterkit already available as a package dependency
      *
      * @memberof patternlab
      * @name loadstarterkit