feat(init): add pnpm support (#915)

chenaski · web-flow · commit c1f4142bc484 · 2023-01-19T14:45:31.000-06:00
pnpm reuses options available for npm, except `force` re: #893, re #858
diff --git a/README.md b/README.md
@@ -58,13 +58,14 @@ npm install commitizen -g
 Next, initialize your project to use the cz-conventional-changelog adapter by typing:
 
 ```sh
+# npm
 commitizen init cz-conventional-changelog --save-dev --save-exact
-```
-
-Or if you are using Yarn:
 
-```sh
+# yarn
 commitizen init cz-conventional-changelog --yarn --dev --exact
+
+# pnpm
+commitizen init cz-conventional-changelog --pnpm --save-dev --save-exact
 ```
 
 Note that if you want to force install over the top of an old adapter, you can apply the `--force` argument. For more information on this, just run `commitizen help`.
diff --git a/src/commitizen/adapter.js b/src/commitizen/adapter.js
@@ -11,12 +11,10 @@ export {
   addPathToAdapterConfig,
   getNearestNodeModulesDirectory,
   getNearestProjectRootDirectory,
-  getNpmInstallStringMappings,
+  getInstallStringMappings,
   getPrompter,
-  generateNpmInstallAdapterCommand,
+  generateInstallAdapterCommand,
   resolveAdapterPath,
-  getYarnAddStringMappings,
-  generateYarnAddAdapterCommand,
   getGitRootPath,
 };
 
@@ -55,40 +53,32 @@ function addPathToAdapterConfig (cliPath, repoPath, adapterNpmName) {
   fs.writeFileSync(packageJsonPath, JSON.stringify(newPackageJsonContent, null, indent) + '\n');
 }
 
-/**
- * Generates an npm install command given a map of strings and a package name
+/*
+ * Get additional options for install command
  */
-function generateNpmInstallAdapterCommand (stringMappings, adapterNpmName) {
-
-  // Start with an initial npm install command
-  let installAdapterCommand = `npm install ${adapterNpmName}`;
+function getInstallOptions(stringMappings) {
+  return Array.from(stringMappings.values()).filter(Boolean).join(" ")
+}
 
-  // Append the neccesary arguments to it based on user preferences
-  for (let value of stringMappings.values()) {
-    if (value) {
-      installAdapterCommand = installAdapterCommand + ' ' + value;
-    }
-  }
+/*
+ * Get specific install command for passed package manager
+ */
+function getInstallCommand(packageManager) {
+  const fallbackCommand = 'install';
+  const commandByPackageManager = {
+    npm: 'install',
+    yarn: 'add',
+    pnpm: 'add',
+  };
 
-  return installAdapterCommand;
+  return commandByPackageManager[packageManager] || fallbackCommand;
 }
 
 /**
- * Generates an yarn add command given a map of strings and a package name
+ * Generates an npm install command given a map of strings and a package name
  */
-function generateYarnAddAdapterCommand (stringMappings, adapterNpmName) {
-
-  // Start with an initial yarn add command
-  let installAdapterCommand = `yarn add ${adapterNpmName}`;
-
-  // Append the necessary arguments to it based on user preferences
-  for (let value of stringMappings.values()) {
-    if (value) {
-      installAdapterCommand = installAdapterCommand + ' ' + value;
-    }
-  }
-
-  return installAdapterCommand;
+function generateInstallAdapterCommand(stringMappings, adapterNpmName, packageManager = "npm") {
+  return `${packageManager} ${getInstallCommand(packageManager)} ${adapterNpmName} ${getInstallOptions(stringMappings)}`;
 }
 
 /**
@@ -117,24 +107,28 @@ function getNearestProjectRootDirectory (repoPath, options) {
 }
 
 /**
- * Gets a map of arguments where the value is the corresponding npm strings
+ * Gets a map of arguments where the value is the corresponding (to passed package manager) string
  */
-function getNpmInstallStringMappings (save, saveDev, saveExact, force) {
-  return new Map()
-    .set('save', (save && !saveDev) ? '--save' : undefined)
+function getInstallStringMappings({ save, dev, saveDev, exact, saveExact, force }, packageManager) {
+  const npm = new Map()
+    .set('save', save && !saveDev ? '--save' : undefined)
     .set('saveDev', saveDev ? '--save-dev' : undefined)
     .set('saveExact', saveExact ? '--save-exact' : undefined)
     .set('force', force ? '--force' : undefined);
-}
 
-/**
- * Gets a map of arguments where the value is the corresponding yarn strings
- */
-function getYarnAddStringMappings (dev, exact, force) {
-  return new Map()
+  const yarn = new Map()
     .set('dev', dev ? '--dev' : undefined)
     .set('exact', exact ? '--exact' : undefined)
     .set('force', force ? '--force' : undefined);
+
+  const pnpm = new Map()
+    .set('save', save && !saveDev ? '--save-prod' : undefined)
+    .set('dev', saveDev ? '--save-dev' : undefined)
+    .set('exact', saveExact ? '--save-exact' : undefined);
+
+  const map = { npm, yarn, pnpm };
+
+  return map[packageManager] || npm;
 }
 
 /**
diff --git a/src/commitizen/init.js b/src/commitizen/init.js
@@ -5,10 +5,8 @@ import * as adapter from './adapter';
 
 let {
   addPathToAdapterConfig,
-  generateNpmInstallAdapterCommand,
-  getNpmInstallStringMappings,
-  generateYarnAddAdapterCommand,
-  getYarnAddStringMappings,
+  generateInstallAdapterCommand,
+  getInstallStringMappings,
 } = adapter;
 
 export default init;
@@ -43,6 +41,8 @@ const defaultInitOptions = {
   yarn: false,
   dev: true,
   exact: false, // should add trailing comma, thus next developer doesn't got blamed for this line
+
+  pnpm: false, // reuses `save`, `saveDev`, `saveExact`
 };
 
 /**
@@ -56,6 +56,7 @@ function init (repoPath, adapterNpmName, {
   yarn = false,
   dev = false,
   exact = false,
+  pnpm = false,
   includeCommitizen = false
 } = defaultInitOptions) {
 
@@ -65,13 +66,15 @@ function init (repoPath, adapterNpmName, {
   // Load the current adapter config
   let adapterConfig = loadAdapterConfig(repoPath);
 
+  const packageManager = yarn ? 'yarn' : pnpm ? 'pnpm' : 'npm';
+
   // Get the npm string mappings based on the arguments provided
-  let stringMappings = yarn ? getYarnAddStringMappings(dev, exact, force) : getNpmInstallStringMappings(save, saveDev, saveExact, force);
+  const stringMappings = getInstallStringMappings({ save, dev, saveDev, saveExact, force }, packageManager);
 
   // Generate a string that represents the npm install command
-  let installAdapterCommand = yarn ? generateYarnAddAdapterCommand(stringMappings, adapterNpmName) : generateNpmInstallAdapterCommand(stringMappings, adapterNpmName);
+  const installAdapterCommand = generateInstallAdapterCommand(stringMappings, adapterNpmName, packageManager);
 
-  let installCommitizenCommand = yarn ? generateYarnAddAdapterCommand(stringMappings, "commitizen") : generateNpmInstallAdapterCommand(stringMappings, "commitizen");
+  const installCommitizenCommand = generateInstallAdapterCommand(stringMappings, 'commitizen', packageManager);
 
   // Check for previously installed adapters
   if (adapterConfig && adapterConfig.path && adapterConfig.path.length > 0 && !force) {
diff --git a/test/tests/init.js b/test/tests/init.js
