feature: avoid dependning on shelljs

Author: LinusU

package-lock.json

@@ -68,6 +68,7 @@
     "proxyquire": "^2.1.0",
     "semantic-release": "15.13.18",
     "semver": "6.2.0",
+    "shelljs": "0.7.6",
     "sinon": "^6.3.4",
     "uuid": "3.3.2"
   },
@@ -84,7 +85,6 @@
     "is-utf8": "^0.2.1",
     "lodash": "4.17.15",
     "minimist": "1.2.5",
-    "shelljs": "0.7.6",
     "strip-bom": "4.0.0",
     "strip-json-comments": "3.0.1"
   },

package.json

@@ -1,6 +1,5 @@
 import { init } from '../commitizen';
 import { commitizen as commitizenParser } from './parsers';
-import * as sh from 'shelljs';
 
 let { parse } = commitizenParser;
 
@@ -27,7 +26,7 @@ function bootstrap (environment = {}, argv = process.argv) {
     if (adapterNpmName) {
       console.log(`Attempting to initialize using the npm package ${adapterNpmName}`);
       try {
-        init(sh, process.cwd(), adapterNpmName, parsedArgs);
+        init(process.cwd(), adapterNpmName, parsedArgs);
       } catch (e) {
         console.error(`Error: ${e}`);
       }

src/cli/commitizen.js

@@ -1,4 +1,3 @@
-import sh from 'shelljs';
 import inquirer from 'inquirer';
 import findRoot from 'find-root';
 import { getParsedPackageJsonFromPath } from '../../common/util';
@@ -56,7 +55,7 @@ function gitCz (rawGitArgs, environment, adapterConfig) {
     let adapterPackageJson = getParsedPackageJsonFromPath(resolvedAdapterRootPath);
     let cliPackageJson = getParsedPackageJsonFromPath(environment.cliPath);
     console.log(`cz-cli@${cliPackageJson.version}, ${adapterPackageJson.name}@${adapterPackageJson.version}\n`);
-    commit(sh, inquirer, process.cwd(), prompter, {
+    commit(inquirer, process.cwd(), prompter, {
       args: parsedGitCzArgs,
       disableAppendPaths: true,
       emitData: true,

src/cli/strategies/git-cz.js

@@ -1,9 +1,9 @@
+import childProcess from 'child_process';
 import path from 'path';
 import fs from 'fs';
 import findNodeModules from 'find-node-modules';
 import _ from 'lodash';
 import detectIndent from 'detect-indent';
-import sh from 'shelljs';
 
 import { isFunction } from '../common/util';
 
@@ -32,7 +32,7 @@ export {
  * Modifies the package.json, sets config.commitizen.path to the path of the adapter
  * Must be passed an absolute path to the cli's root
  */
-function addPathToAdapterConfig (sh, cliPath, repoPath, adapterNpmName) {
+function addPathToAdapterConfig (cliPath, repoPath, adapterNpmName) {
 
   let commitizenAdapterConfig = {
     config: {
@@ -180,5 +180,5 @@ function resolveAdapterPath (inboundAdapterPath) {
 }
 
 function getGitRootPath () {
-  return sh.exec('git rev-parse --show-toplevel', { silent: true }).stdout.trim();
+  return childProcess.spawnSync('git', ['rev-parse', '--show-toplevel'], { encoding: 'utf8' }).stdout.trim();
 }

src/commitizen/adapter.js

@@ -10,17 +10,17 @@ export default commit;
 /**
  * Takes all of the final inputs needed in order to make dispatch a git commit
  */
-function dispatchGitCommit (sh, repoPath, template, options, overrideOptions, done) {
+function dispatchGitCommit (repoPath, template, options, overrideOptions, done) {
     // Commit the user input -- side effect that we'll test
-    gitCommit(sh, repoPath, template, { ...options, ...overrideOptions }, function (error) {
+    gitCommit(repoPath, template, { ...options, ...overrideOptions }, function (error) {
       done(error, template);
     });
 }
 
  /**
   * Asynchronously commits files using commitizen
   */
-function commit (sh, inquirer, repoPath, prompter, options, done) {
+function commit (inquirer, repoPath, prompter, options, done) {
   var cacheDirectory = cacheDir('commitizen');
   var cachePath = path.join(cacheDirectory, 'commitizen.json');
 
@@ -40,7 +40,7 @@ function commit (sh, inquirer, repoPath, prompter, options, done) {
           overrideOptions: retryOverrideOptions,
           template: retryTemplate
         } = cache.getCacheValueSync(cachePath, repoPath);
-        dispatchGitCommit(sh, repoPath, retryTemplate, retryOptions, retryOverrideOptions, done);
+        dispatchGitCommit(repoPath, retryTemplate, retryOptions, retryOverrideOptions, done);
 
       } else {
         // Get user input -- side effect that is hard to test
@@ -59,7 +59,7 @@ function commit (sh, inquirer, repoPath, prompter, options, done) {
 
           // We don't want to add retries to the cache, only actual commands
           cache.setCacheValueSync(cachePath, repoPath, { template, options, overrideOptions });
-          dispatchGitCommit(sh, repoPath, template, options, overrideOptions, done);
+          dispatchGitCommit(repoPath, template, options, overrideOptions, done);
         });
       }
     }

src/commitizen/commit.js

@@ -1,6 +1,6 @@
+import childProcess from 'child_process';
 import path from 'path';
 import * as configLoader from './configLoader';
-import { executeShellCommand } from '../common/util';
 import * as adapter from './adapter';
 
 let {
@@ -48,7 +48,7 @@ const defaultInitOptions = {
 /**
  * Runs npm install for the adapter then modifies the config.commitizen as needed
  */
-function init (sh, repoPath, adapterNpmName, {
+function init (repoPath, adapterNpmName, {
   save = false,
   saveDev = true,
   saveExact = false,
@@ -60,10 +60,7 @@ function init (sh, repoPath, adapterNpmName, {
 } = defaultInitOptions) {
 
   // Don't let things move forward if required args are missing
-  checkRequiredArguments(sh, repoPath, adapterNpmName);
-
-  // Move to the correct directory so we can run commands
-  sh.cd(repoPath);
+  checkRequiredArguments(repoPath, adapterNpmName);
 
   // Load the current adapter config
   let adapterConfig = loadAdapterConfig();
@@ -88,11 +85,11 @@ function init (sh, repoPath, adapterNpmName, {
   }
 
   try {
-    executeShellCommand(sh, repoPath, installAdapterCommand);
+    childProcess.execSync(installAdapterCommand, { cwd: repoPath });
     if(includeCommitizen) {
-      executeShellCommand(sh, repoPath, installCommitizenCommand);
+      childProcess.execSync(installCommitizenCommand, { cwd: repoPath });
     }
-    addPathToAdapterConfig(sh, CLI_PATH, repoPath, adapterNpmName);
+    addPathToAdapterConfig(CLI_PATH, repoPath, adapterNpmName);
   } catch (e) {
     console.error(e);
   }
@@ -102,10 +99,7 @@ function init (sh, repoPath, adapterNpmName, {
  * Checks to make sure that the required arguments are passed
  * Throws an exception if any are not.
  */
-function checkRequiredArguments (sh, path, adapterNpmName) {
-  if (!sh) {
-    throw new Error("You must pass an instance of shelljs when running init.");
-  }
+function checkRequiredArguments (path, adapterNpmName) {
   if (!path) {
     throw new Error("Path is required when running init.");
   }

src/commitizen/init.js

@@ -2,7 +2,6 @@ import fs from 'fs';
 import path from 'path';
 
 export {
-  executeShellCommand,
   getParsedJsonFromFile,
   getParsedPackageJsonFromPath,
   isArray,
@@ -11,15 +10,6 @@ export {
   isInTest
 }
 
-/**
- * Executes the command passed to it at the path requested
- * using the instance of shelljs passed in
- */
-function executeShellCommand (sh, path, installCommand) {
-  sh.cd(path);
-  sh.exec(installCommand);
-}
-
 /**
  * Gets the parsed contents of a json file
  */

src/common/util.js

@@ -1,3 +1,5 @@
+import childProcess from 'child_process';
+
 export {
   addPath,
   addFile
@@ -6,15 +8,13 @@ export {
 /**
  * Synchronously adds a path to git staging
  */
-function addPath (sh, repoPath) {
-  sh.cd(repoPath);
-  sh.exec('git add .');
+function addPath (repoPath) {
+  childProcess.spawnSync('git', ['add', '.'], { cwd: repoPath });
 }
 
 /**
  * Synchronously adds a file to git staging
  */
-function addFile (sh, repoPath, filename) {
-  sh.cd(repoPath);
-  sh.exec('git add ' + filename)
+function addFile (repoPath, filename) {
+  childProcess.spawnSync('git', ['add', filename], { cwd: repoPath });
 }

src/git/add.js

@@ -11,7 +11,7 @@ export { commit };
 /**
  * Asynchronously git commit at a given path with a message
  */
-function commit (sh, repoPath, message, options, done) {
+function commit (repoPath, message, options, done) {
   let called = false;
 
   // commit the file by spawning a git process, unless the --hook
@@ -39,7 +39,7 @@ function commit (sh, repoPath, message, options, done) {
         if (code === 128) {
           console.warn(`
             Git exited with code 128. Did you forget to run:
-    
+
               git config --global user.email "you@example.com"
               git config --global user.name "Your Name"
             `)

src/git/commit.js

@@ -1,9 +1,10 @@
+import childProcess from 'child_process';
+
 export { init };
 
 /**
  * Synchronously creates a new git repo at a path
  */
-function init (sh, repoPath) {
-  sh.cd(repoPath);
-  sh.exec('git init');
+function init (repoPath) {
+  childProcess.spawnSync('git', ['init'], { cwd: repoPath });
 }

src/git/init.js

@@ -54,7 +54,7 @@ describe('adapter', function () {
     };
 
     // Install an adapter
-    commitizenInit(sh, config.paths.endUserRepo, 'cz-conventional-changelog');
+    commitizenInit(config.paths.endUserRepo, 'cz-conventional-changelog');
 
     // TEST
     expect(function () { adapter.resolveAdapterPath('IAMANIMPOSSIBLEPATH'); }).to.throw(Error);
@@ -95,7 +95,7 @@ describe('adapter', function () {
     };
 
     // Install an adapter
-    commitizenInit(sh, config.paths.endUserRepo, '@commitizen/cz-conventional-changelog');
+    commitizenInit(config.paths.endUserRepo, '@commitizen/cz-conventional-changelog');
 
     // TEST
     expect(function () { adapter.resolveAdapterPath('IAMANIMPOSSIBLEPATH'); }).to.throw(Error);
@@ -131,7 +131,7 @@ describe('adapter', function () {
     };
 
     // Install an adapter
-    commitizenInit(sh, config.paths.endUserRepo, 'cz-conventional-changelog', {includeCommitizen: true});
+    commitizenInit(config.paths.endUserRepo, 'cz-conventional-changelog', {includeCommitizen: true});
 
     // TEST
     expect(function () { adapter.getPrompter('IAMANIMPOSSIBLEPATH'); }).to.throw(Error);
@@ -167,7 +167,7 @@ describe('adapter', function () {
     };
 
     // Install an adapter
-    commitizenInit(sh, config.paths.endUserRepo, 'cz-conventional-changelog-default-export');
+    commitizenInit(config.paths.endUserRepo, 'cz-conventional-changelog-default-export');
 
     // TEST
     expect(function () { adapter.getPrompter('IAMANIMPOSSIBLEPATH'); }).to.throw(Error);