feat: standalone version of this lib

ISSUES CLOSED: #89

README.md

@@ -1,67 +1,102 @@
 # cz-customizable
 
-The customizable Commitizen plugin to help achieve consistent commit messages like the [AngularJS team](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).
+The customizable Commitizen plugin (or standalone utility) to help achieve consistent commit messages like the [AngularJS team](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).
 
 ![screenshot](screenshot.png)
 
-Suitable for large teams working with multiple projects with their own commit scopes. When you specify the scopes in your `.cz-config.js`, `cz-customizable` allows you to **select** the pre-defined scopes. No more spelling mistakes embarrassing you when generating the changelog file.
+Suitable for large teams working with multiple projects with their own commit scopes. It allows you to **select** the pre-defined scopes or commit types. It works perfectly with https://github.com/semantic-release/semantic-release.
+
 
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Build Status](https://travis-ci.org/leonardoanalista/cz-customizable.svg)](https://travis-ci.org/leonardoanalista/cz-customizable) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![codecov.io](https://codecov.io/github/leonardoanalista/cz-customizable/coverage.svg?branch=master)](https://codecov.io/github/leonardoanalista/cz-customizable?branch=master) [![npm monthly downloads](https://img.shields.io/npm/dm/cz-customizable.svg?style=flat-square)](https://www.npmjs.com/package/cz-customizable)
 
-## Steps
+
+### Option 1 - cz-customizable in standalone usage
+
+Use `cz-customizable` without `commitzen`.
+
+* npm install `npm install cz-customizable --save-dev`
+* add a new script to your `package.json`:
+
+```
+"scripts" : {
+  ...
+  "commit": "./node_modules/cz-customizable/standalone.js"
+}
+```
+
+* See options below where you could put your `.cz-config.js` file.
+
+
+## Option 2 - cz-customizable as commitizen plugin
+
 * install commitizen in case you don't have it: `npm install -g commitizen`. Make sure you have the latest version of commitizen installed globally.
-* install the cz-customizable: `npm install cz-customizable --save-dev`
+
 * configure `commitizen` to use `cz-customizable` as plugin. Add those lines to your `package.json`:
 
-  ```
-  ...
-  "config": {
-    "commitizen": {
-      "path": "node_modules/cz-customizable"
-    }
+```
+...
+"config": {
+  "commitizen": {
+    "path": "node_modules/cz-customizable"
   }
-  ```
+}
+```
+
+
+## Configuration
 
-## Configure
+* Copy contents of `https://github.com/leonardoanalista/cz-customizable/blob/master/cz-config-EXAMPLE.js` and paste into a new file `.cz-config.js`
 
-### Options 1
+### Option 1
 Changes to your git repository, file `package.json`.
 
-* `cz-customizable` will first look for a file called `.cz-config.js`
-* alternatively add a config block in your `package.json`:
-  ```
-  ...
-  "config": {
-    "commitizen": {
-      "path": "node_modules/cz-customizable"
-    },
-    "cz-customizable": {
-      "config": "config/path/to/my/config.js"
-    }
+* `cz-customizable` will first look for a file called `.cz-config.js` in the project root, near your `package.json`
+* If no config found, it will look for `.cz-config.js` your home directory
+* alternatively add the config location in your `package.json`:
+```
+...
+"config": {
+  "commitizen": { // not needed for standlone usage
+    "path": "node_modules/cz-customizable"
+  },
+  "cz-customizable": {
+    "config": "config/path/to/my/config.js"
   }
-  ```
-Note: option one allows you to have your config away from root directory. It also gives you a change to define any name to your `cz-config.js`.
+}
+```
+
+Note: option one allows you to have your config away from root directory. It also gives you a change to define any name to your `.cz-config.js`.
 
-### Options 2
-Standalne - No Changes to your git repository*. This is suitable when your team is not ready to roll `cz-customizable` across all teams but you still would like to use it for your own commits, no matter the project.
+
+### Option 2 - No Changes to your git repository*.
+
+This is suitable when your team is not ready to roll `cz-customizable` across all teams but you still would like to use it for your own commits, no matter the project.
 
 Steps:
 * create config file:
   * create a file called `.cz-config.js` in your git repository root (*Asumptions: you do a global git ignore on `~/.gitignore_global` for `.cz-config.js`). Or;
   * create a file called `.cz-config.js` your home directory.
+
+#### Additional steps when used as commitizen plugin
+
 * npm install -g commitizen
 * npm install -g cz-customizable. Make sure you have version `>v5.6.x`
 * create global commitizen config file `.czrc`: `echo '{ "path": "cz-customizable" }' > ~/.czrc`
 * now run: `npx git-cz` or `git cz`.
 
+
+
 **Notes:**
-* you should commit your `.cz-config.js` file to your git.
+* you should commit your `.cz-config.js` file to your git when applicable.
 
 
 From now on, instead of `git commit` you type `git cz` and let the tool do the work for you.
 
 Hopefully this will help you to have consistent commit messages and have a fully automated deployment without any human intervention.
 
+
+
+---
 ## Options
 
 Here are the options you can set in your `.cz-config.js`:
@@ -91,7 +126,7 @@ Here are the options you can set in your `.cz-config.js`:
 * **breakingPrefix**: {string, default 'BREAKING CHANGE:'}: Set a custom prefix for the breaking change block in commit messages.
 * **footerPrefix**: {string, default 'ISSUES CLOSED:'}: Set a custom prefix for the footer block in commit messages. Set to empty string to remove prefix.
 * **breaklineChar**: {string, default '|'}: It gets replaced with \n to create the breakline in your commit message. This is supported for fields `body` and `footer` at the moment.
-* **upperCaseSubject**: { boolean, default false }: Capitalizes first subject letter if set to `true` 
+* **upperCaseSubject**: { boolean, default false }: Capitalizes first subject letter if set to `true`
 
 ## Related tools
 - (https://github.com/commitizen/cz-cli)

cz-config-EXAMPLE.js

@@ -61,7 +61,7 @@ module.exports = {
   allowCustomScopes: true,
   allowBreakingChanges: ['feat', 'fix'],
   // skip any questions you want
-  skipQuestions: ['body', 'footer'],
+  skipQuestions: ['body'],
 
   // limit subject length
   subjectLimit: 100,

package.json

@@ -13,6 +13,7 @@
     "report-coverage": "cat ./coverage/lcov.info | codecov",
     "semantic-release": "semantic-release",
     "prettier": "prettier --single-quote --trailing-comma es5 --write '*.js' 'spec/**/*.js'",
+    "commit": "./standalone.js",
     "travis-deploy-once": "travis-deploy-once"
   },
   "homepage": "https://github.com/leonardoanalista/cz-customizable",

standalone.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const inquirer = require('inquirer');
+
+const app = require('./index');
+const log = require('./logger');
+
+log.info('cz-customizable standalone version');
+
+const commit = commitMessage => {
+  try {
+    execSync(`git commit -m "${commitMessage}"`, { stdio: [0, 1, 2] });
+  } catch (error) {
+    log.error('>>> ERROR', error.error);
+  }
+};
+
+app.prompter(inquirer, commit);