gitmoji-cli - npm Package Compare versions

Comparing version 1.3.1 to 1.4.0

cli.js

@@ -17,2 +17,3 @@ #!/usr/bin/env node
 		--init, -i	Initialize gitmoji as a commit hook
+		--config, -g Setup gitmoji-cli preferences.
 		--commit, -c Interactively commit using the prompts
@@ -34,3 +35,4 @@ --list, -l  List all the available gitmojis
 		v: 'version',
-		u: 'update'
+		u: 'update',
+		g: 'config'
 	}
@@ -50,2 +52,3 @@ });
 	list: () => gitmojiCli.list(),
+	config: () => gitmojiCli.config(),
 	search: () => cli.input.map(element => gitmojiCli.search(element)),
@@ -52,0 +55,0 @@ init: () => gitmojiCli.init(),

package.json

 {
   "name": "gitmoji-cli",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "A gitmoji client for using emojis on commit messages.",
@@ -45,2 +45,3 @@ "engines": {
     "chalk": "^1.1.3",
+    "conf": "^0.12.0",
     "execa": "^0.6.0",
@@ -50,3 +51,3 @@ "inquirer": "^3.0.1",
     "path-exists": "^3.0.0",
-    "update-notifier": "^1.0.2"
+    "update-notifier": "^2.0.0"
   },
@@ -53,0 +54,0 @@ "devDependencies": {

README.md

@@ -37,2 +37,3 @@ # gitmoji-cli
   	--init, -i	Initialize gitmoji as a commit hook
+	--config, -g 	Setup gitmoji-cli preferences
   	--commit, -c Interactively commit using the prompts
@@ -97,1 +98,7 @@ --list, -l  List all the available gitmojis
 ```
+
+### Config
+
+Run `gitmoji -g` to setup some gitmoji-cli preferences, such as the auto `git add .` feature.
+
+![gitmoji config](https://cloud.githubusercontent.com/assets/7629661/23577826/82e8745e-00c9-11e7-9d7e-623a0a51bff9.png)

src/gitmoji.js

@@ -9,3 +9,6 @@ 'use strict';
 const pathExists = require('path-exists');
+const Conf = require('conf');
 
+const config = new Conf();
+
 class GitmojiCli {
@@ -18,2 +21,16 @@
 
+	config() {
+		const questions = [
+			{
+				name: 'add',
+				message: 'Enable automatic "git add ."',
+				type: 'confirm'
+			}
+		];
+
+		inquirer.prompt(questions).then(answers => {
+			config.set('autoadd', answers.add);
+		});
+	}
+
 	init() {
@@ -27,3 +44,3 @@ const hookFile = 'prepare-commit-msg';
 				if (err) {
-					console.error(chalk.red(`ERROR: ${err}`));
+					this._errorMessage(err);
 				}
@@ -47,3 +64,3 @@ console.log(`${chalk.yellow('gitmoji')} commit hook created succesfully.`);
 			.then(gitmojis => this._parseGitmojis(gitmojis))
-			.catch(err => console.error(chalk.red(`ERROR: gitmoji list not found - ${err.code}`)));
+			.catch(err => this._errorMessage(`gitmoji list not found - ${err.code}`));
 	}
@@ -55,3 +72,3 @@
 			.then(gitmojisFiltered => this._parseGitmojis(gitmojisFiltered))
-		.catch(err => console.error(chalk.red(`ERROR: ${err.code}`)));
+		.catch(err => this._errorMessage(err.code));
 	}
@@ -75,9 +92,9 @@
 							default:
-								console.error(chalk.red(`ERROR: unexpected mode [${mode}]`));
+								this._errorMessage(`Unexpected mode [${mode}]`);
 						}
 					});
 				})
-			.catch(err => console.error(chalk.red(`ERROR: ${err.code}`)));
+			.catch(err => this._errorMessage(err.code));
 		}
-		console.error(chalk.red('ERROR: This directory is not a git repository.'));
+		this._errorMessage('This directory is not a git repository.');
 	}
@@ -90,26 +107,33 @@
 
+	_errorMessage(message) {
+		console.error(chalk.red(`ERROR: ${message}`));
+	}
+
 	_hook(answers) {
-		const commitTitle = `${answers.gitmoji} ${answers.title}`;
+		const title = `${answers.gitmoji} ${answers.title}`;
 		const reference = (answers.reference) ? `#${answers.reference}` : '';
-		const commitBody = `${answers.message} ${reference}`;
+		const body = `${answers.message} ${reference}`;
 
-		fs.writeFileSync(process.argv[3], `${commitTitle}\n${commitBody}`);
+		fs.writeFileSync(process.argv[3], `${title}\n${body}`);
 	}
 
 	_commit(answers) {
-		const commitTitle = `${answers.gitmoji} ${answers.title}`;
+		const title = `${answers.gitmoji} ${answers.title}`;
 		const reference = (answers.reference) ? `#${answers.reference}` : '';
 		const signed = this._isCommitSigned(answers.signed);
-		const commitBody = `${answers.message} ${reference}`;
+		const body = `${answers.message} ${reference}`;
+		const commit = `git commit ${signed} -m "${title}" -m "${body}"`;
 
 		if (this._isAGitRepo('.git')) {
-			execa.stdout('git', ['add', '.'])
-				.then(res => console.log(chalk.blue(res)))
-				.catch(err => console.error(chalk.red(`ERROR: ${err.stderr}`)));
-			execa.shell(`git commit ${signed} -m "${commitTitle}" -m "${commitBody}"`)
+			if (config.get('autoadd')) {
+				execa.stdout('git', ['add', '.'])
+					.then(res => console.log(chalk.blue(res)))
+					.catch(err => this._errorMessage(err.stderr));
+			}
+			execa.shell(commit)
 				.then(res => console.log(chalk.blue(res.stdout)))
-				.catch(err => console.error(chalk.red(`ERROR: ${err.stderr}`)));
+				.catch(err => this._errorMessage(err.stderr));
 		}
 
-		return `git commit ${signed} -m "${commitTitle}" -m "${commitBody}"`;
+		return commit;
 	}
@@ -220,3 +244,3 @@
 		})
-		.catch(err => console.error(chalk.red(`ERROR: Network connection not found - ${err.code}`)));
+		.catch(err => this._errorMessage(`Network connection not found - ${err.code}`));
 	}
@@ -223,0 +247,0 @@

No alert changes

Improved metrics

Total package byte prevSize

89946

6.75%

Lines of code

343

7.19%

Number of lines in readme file

103

7.29%

Worsened metrics

Dependency count

8

14.29%

Dependency changes

• + Added

  conf@^0.12.0

• + Added

  ansi-align@2.0.0
  (transitive)

• + Added

  boxen@1.3.0
  (transitive)

• + Added

  camelcase@4.1.0
  (transitive)

• + Added

  ci-info@1.6.0
  (transitive)

• + Added

  conf@0.12.0
  (transitive)

• + Added

  configstore@3.1.5
  (transitive)

• + Added

  crypto-random-string@1.0.0
  (transitive)

• + Added

  dot-prop@4.2.1
  (transitive)

• + Added

  duplexer3@0.1.5
  (transitive)

• + Added

  env-paths@1.0.0
  (transitive)

• + Added

  execa@0.7.0
  (transitive)

• + Added

  global-dirs@0.1.1
  (transitive)

• + Added

  got@6.7.1
  (transitive)

• + Added

  import-lazy@2.1.0
  (transitive)

• + Added

  is-ci@1.2.1
  (transitive)

• + Added

  is-installed-globally@0.1.0
  (transitive)

• + Added

  is-path-inside@1.0.1
  (transitive)

• + Added

  latest-version@3.1.0
  (transitive)

• + Added

  make-dir@1.3.0
  (transitive)

• + Added

  package-json@4.0.1
  (transitive)

• + Added

  path-is-inside@1.0.2
  (transitive)

• + Added

  pify@3.0.0
  (transitive)

• + Added

  pkg-up@1.0.0
  (transitive)

• + Added

  safe-buffer@5.2.1
  (transitive)

• + Added

  term-size@1.2.0
  (transitive)

• + Added

  timed-out@4.0.1
  (transitive)

• + Added

  unique-string@1.0.0
  (transitive)

• + Added

  unzip-response@2.0.1
  (transitive)

• + Added

  update-notifier@2.5.0
  (transitive)

• + Added

  widest-line@2.0.1
  (transitive)

• + Added

  write-file-atomic@2.4.3
  (transitive)

• + Added

  xdg-basedir@3.0.0
  (transitive)

• - Removed

  ansi-align@1.1.0
  (transitive)

• - Removed

  boxen@0.6.0
  (transitive)

• - Removed

  code-point-at@1.1.0
  (transitive)

• - Removed

  configstore@2.1.0
  (transitive)

• - Removed

  core-util-is@1.0.3
  (transitive)

• - Removed

  dot-prop@3.0.0
  (transitive)

• - Removed

  duplexer2@0.1.4
  (transitive)

• - Removed

  filled-array@1.1.0
  (transitive)

• - Removed

  got@5.7.1
  (transitive)

• - Removed

  inherits@2.0.4
  (transitive)

• - Removed

  is-fullwidth-code-point@1.0.0
  (transitive)

• - Removed

  isarray@1.0.0
  (transitive)

• - Removed

  latest-version@2.0.0
  (transitive)

• - Removed

  lazy-req@1.1.0
  (transitive)

• - Removed

  node-status-codes@1.0.0
  (transitive)

• - Removed

  number-is-nan@1.0.1
  (transitive)

• - Removed

  os-homedir@1.0.2
  (transitive)

• - Removed

  osenv@0.1.5
  (transitive)

• - Removed

  package-json@2.4.0
  (transitive)

• - Removed

  process-nextick-args@2.0.1
  (transitive)

• - Removed

  read-all-stream@3.1.0
  (transitive)

• - Removed

  readable-stream@2.3.8
  (transitive)

• - Removed

  safe-buffer@5.1.2
  (transitive)

• - Removed

  slide@1.1.6
  (transitive)

• - Removed

  string-width@1.0.2
  (transitive)

• - Removed

  string_decoder@1.1.1
  (transitive)

• - Removed

  timed-out@3.1.3
  (transitive)

• - Removed

  unzip-response@1.0.2
  (transitive)

• - Removed

  update-notifier@1.0.3
  (transitive)

• - Removed

  util-deprecate@1.0.2
  (transitive)

• - Removed

  uuid@2.0.3
  (transitive)

• - Removed

  widest-line@1.0.0
  (transitive)

• - Removed

  write-file-atomic@1.3.4
  (transitive)

• - Removed

  xdg-basedir@2.0.0
  (transitive)

• Updated

  update-notifier@^2.0.0