feat: add pnpm as optional package manager (#1020)

Author: GeoffreyBooth

CONTRIBUTING.md

@@ -52,7 +52,8 @@ This is for adding a module to be included in the default `citgm-all` runs.
 - Module source code must be on Github.
 - Published versions must include a tag on Github
 - The test process must be executable with only the commands
-  `npm install && npm test` or (`yarn install && yarn test`) using the tarball
+  `npm install && npm test` or (`yarn install && yarn test`
+  or `pnpm install && pnpm test`) using the tarball
   downloaded from the Github tag mentioned above
 - The tests pass on supported major release lines
 - The maintainers of the module remain responsive when there are problems

README.md

@@ -109,6 +109,7 @@ Options:
   --excludeTags tag1 tag2     Specify which tags to skip from the lookup (takes priority over includeTags)
                               Module names are automatically added as tags.
   -y, --yarn                  Install and test the project using yarn instead of npm
+  --pnpm                      Install and test the project using pnpm instead of npm
 ```
 
 When using a JSON config file, the properties need to be the same as the
@@ -134,13 +135,14 @@ For syntax, see [lookup.json](./lib/lookup.json), the available attributes are:
 "stripAnsi": true            Strip ansi data from output stream of npm
 "sha": "<git-commit-sha>"    Test against a specific commit
 "envVar"                     Pass an environment variable before running
-"install": ["install", "--param1", "--param2"] - Array of command line parameters passed to 'npm' or 'yarn' as install arguments
+"install": ["install", "--param1", "--param2"] - Array of command line parameters passed to `npm` or `yarn` or `pnpm` as install arguments
 "maintainers": ["user1", "user2"] - List of module maintainers to be contacted with issues
 "scripts": ["script1", "script2"] - List of scripts from package.json to run instead of 'test'
 "tags": ["tag1", "tag2"]     Specify which tags apply to the module
 "useGitClone": true          Use a shallow git clone instead of downloading the module
 "ignoreGitHead":             Ignore the gitHead field if it exists and fallback to using github tags
 "yarn":                      Install and test the project using yarn instead of npm
+"pnpm":                      Install and test the project using pnpm instead of npm
 "timeout":                   Number of milliseconds before timeout. Applies separately to `install` and `test`
 ```
 

lib/bin/citgm-all.js

@@ -69,6 +69,7 @@ const options = {
   tmpDir: app.tmpDir,
   customTest: app.customTest,
   yarn: app.yarn,
+  pnpm: app.pnpm,
   includeTags: app.includeTags || [],
   excludeTags: app.excludeTags || []
 };

lib/bin/citgm.js

@@ -45,7 +45,8 @@ const options = {
   sha: app.sha,
   tmpDir: app.tmpDir,
   customTest: app.customTest,
-  yarn: app.yarn
+  yarn: app.yarn,
+  pnpm: app.pnpm
 };
 
 if (!windows) {

lib/citgm.js

@@ -89,9 +89,10 @@ export class Tester extends EventEmitter {
       init(this);
       await findNode(this);
 
-      const { npm, yarn } = await getPackageManagers();
+      const { npm, yarn, pnpm } = await getPackageManagers();
       this.npmPath = npm;
       this.yarnPath = yarn;
+      this.pnpmPath = pnpm;
 
       await tempDirectory.create(this);
       await grabModuleData(this);

lib/common-args.js

@@ -82,6 +82,11 @@ export function commonArgs() {
       description: 'Install and test the project using yarn instead of npm',
       default: false
     })
+    .option('pnpm', {
+      type: 'boolean',
+      description: 'Install and test the project using pnpm instead of npm',
+      default: false
+    })
     .example(
       'citgm-all --customTest /path/to/customTest.js',
       'Runs a custom node test script instead of "npm test"'

lib/grab-project.js

@@ -17,8 +17,12 @@ export async function grabProject(context) {
   }
 
   return new Promise((resolve, reject) => {
-    const packageManager =
-      context.options.yarn || context.module.useYarn ? 'yarn' : 'npm';
+    let packageManager = 'npm';
+    if (context.options.yarn || context.module.useYarn) {
+      packageManager = 'yarn';
+    } else if (context.options.pnpm || context.module.usePnpm) {
+      packageManager = 'pnpm';
+    }
     let packageName = context.module.raw;
     if (context.module.type === 'directory') {
       context.module.raw = context.module.name = path.basename(packageName);

lib/lookup.js

@@ -183,6 +183,9 @@ export function lookup(context) {
       if (rep.yarn) {
         context.module.useYarn = true;
       }
+      if (rep.pnpm) {
+        context.module.usePnpm = true;
+      }
       if (rep.timeout) {
         context.module.timeout = rep.timeout;
       }

lib/package-manager/get-executable.js

@@ -10,8 +10,8 @@ const npmWhich = promisify(
 );
 
 export function getExecutable(binaryName) {
-  if (binaryName === 'yarn') {
-    // Use `npm-which` for yarn to get the local version
+  if (binaryName === 'yarn' || binaryName === 'pnpm') {
+    // Use `npm-which` for yarn or pnpm to get the local version
     return npmWhich(binaryName);
   } else {
     return which(binaryName);

lib/package-manager/index.js

@@ -5,6 +5,8 @@ import { getExecutable } from './get-executable.js';
 export function pkgInstall(context) {
   if (context.options.yarn || context.module.useYarn) {
     return install('yarn', context);
+  } else if (context.options.pnpm || context.module.usePnpm) {
+    return install('pnpm', context);
   } else {
     return install('npm', context);
   }
@@ -13,15 +15,18 @@ export function pkgInstall(context) {
 export function pkgTest(context) {
   if (context.options.yarn || context.module.useYarn) {
     return test('yarn', context);
+  } else if (context.options.pnpm || context.module.usePnpm) {
+    return test('pnpm', context);
   } else {
     return test('npm', context);
   }
 }
 
 export async function getPackageManagers() {
-  const [npm, yarn] = await Promise.all([
+  const [npm, yarn, pnpm] = await Promise.all([
     getExecutable('npm'),
-    getExecutable('yarn')
+    getExecutable('yarn'),
+    getExecutable('pnpm')
   ]);
-  return { npm, yarn };
+  return { npm, yarn, pnpm };
 }