feat(build): add support for semantic-releasing and tests

Brett Uglow · Brett Uglow · commit 38ba08e02ac4 · 2016-05-13T09:23:59.000+10:00
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,42 @@
+sudo: false
+language: node_js
+node_js:
+  - 5.11.0
+
+# Need to specify a GCC compiler now!
+# https://docs.travis-ci.com/user/languages/javascript-with-nodejs#Node.js-v4-(or-io.js-v3)-compiler-requirements
+env:
+  - CXX=g++-4.8
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
+
+before_install:
+  - npm prune
+  - npm set progress=false
+
+install:
+  - npm install --quiet
+  - npm link
+
+before_script:
+
+script:
+  - npm test
+
+after_success:
+  - npm run semantic-release
+
+branches:
+  except:
+    - "/^v\\d+\\.\\d+\\.\\d+$/"
+
+notifications:
+  email:
+    recipients:
+      - u_glow@hotmail.com
+
diff --git a/README.md b/README.md
@@ -1,2 +1,34 @@
 # cz-customizable-ghooks
-Integrate cz-customizable config with ghooks
+
+Integrate cz-customizable config with ghooks to use a single configuration for commit message generation AND commit message hooks.
+
+## Prerequisites
+
+- git
+- Node >= 4.x
+- cz-customizable
+- ghooks
+
+Make sure you have a git repository (`git init`) BEFORE installing ghooks, otherwise you have to take extra steps if you install ghooks before running `git init`.
+
+## Usage
+
+```
+npm i cz-customizable ghooks cz-customizable-ghooks
+```
+
+Then configure your package.json:
+
+```
+// inside package.json
+...
+  "config": {
+    "cz-customizable": {
+      "config": "path/to/your/cz-customizable-rules.js"
+    },
+    "ghooks": {
+      "commit-msg": "./node_modules/cz-customizable-ghooks/index.js $2"
+    }
+  }
+...
+```
diff --git a/config/emptyConfig.js b/config/emptyConfig.js
@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+
+};
diff --git a/config/fullCommitMessageConfig.js b/config/fullCommitMessageConfig.js
@@ -16,24 +16,24 @@ module.exports = {
   ],
 
   scopes: [
-    {name: 'accounts'},
-    {name: 'admin'},
-    {name: 'exampleScope'},
-    {name: 'changeMe'}
+    {name: 'a'},
+    {name: 'bb'},
+    {name: 'ccc'},
+    {name: 'dddd'}
   ],
 
   // it needs to match the value for field type. Eg.: 'fix'
-  /*
-   scopeOverrides: {
-   fix: [
-
-   {name: 'merge'},
-   {name: 'style'},
-   {name: 'e2eTest'},
-   {name: 'unitTest'}
-   ]
-   },
-   */
+  
+  scopeOverrides: {
+    fix: [
+      {name: 'merge'},
+      {name: 'style'},
+      {name: 'e2eTest'},
+      {name: 'unitTest'}
+    ]
+  },
+
+
 
   allowCustomScopes: true,
   allowBreakingChanges: ['feat', 'fix']
diff --git a/index.js b/index.js
@@ -50,17 +50,16 @@ try {
   process.exit(1);
 }
 
-const TYPES = czConfig.types.map(item => item.value);
+// These are mandatory in czConfig, but guard anyway
+const TYPES = (czConfig.types || []).map(item => item.value);
 
 // Feature scopes are optional
-let FEAT_SCOPES = [];
-if (czConfig.scopes && czConfig.scopes.length !== 0) {
-  FEAT_SCOPES = czConfig.scopes.map(item => item.name);
-}
+const FEAT_SCOPES = (czConfig.scopes || []).map(item => item.name);
 
+// Fix-specific scopes are optional too
 let FIX_SCOPES = [];
-if (czConfig.scopeOverrides && czConfig.scopeOverrides.fix && czConfig.scopeOverrides.fix.length !== 0) {
-  FIX_SCOPES = czConfig.scopes.map(item => item.name);
+if (czConfig.scopeOverrides && czConfig.scopeOverrides.fix && czConfig.scopeOverrides.fix.length) {
+  FIX_SCOPES = czConfig.scopeOverrides.fix.map(item => item.name);
 }
 
 function commitError() {
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "cz-customizable-ghooks",
-  "version": "1.0.1",
-  "description": "integrates ghook with cz-customizable",
+  "version": "0.0.0-semantically-released",
+  "description": "integrate ghooks with cz-customizable configuration",
   "main": "index.js",
   "repository": {
     "type": "git",
@@ -17,13 +17,24 @@
     "url": "https://github.com/uglow/cz-customizable-ghooks/issues"
   },
   "homepage": "https://github.com/uglow/cz-customizable-ghooks#readme",
+  "scripts": {
+    "test": "node_modules/jasmine-node/bin/jasmine-node test/",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+  },
   "config": {
     "cz-customizable": {
-      "config": "config/commitMessageConfig.js"
+      "config": "config/fullCommitMessageConfig.js"
     }
   },
   "dependencies": {
     "app-root-path": "1.0.0",
     "chalk": "1.1.3"
+  },
+  "engines": {
+    "node": ">=4.x"
+  },
+  "devDependencies": {
+    "jasmine-node": "1.14.5",
+    "semantic-release-cli": "1.4.1"
   }
 }
diff --git a/test/ccg.spec.js b/test/ccg.spec.js
@@ -0,0 +1,28 @@
+'use strict';
+
+describe('cz-customizable-ghooks', () => {
+  const rules = require('../index');
+  
+
+  it('should have a validationMessage function', () => {
+  	expect(typeof rules.validateMessage).toEqual('function');
+  });
+
+
+  describe('with complete config', () => {
+  	//const fullConfig = require('../config/commitMessageConfig');
+
+  	const testData = [
+  	  {msg: 'feat(a): valid type', expectedResult: true},
+  	  {msg: 'fe(bb): incorrect type', expectedResult: false},
+  	  {msg: 'fix(ccc): valid type', expectedResult: true}
+  	];
+
+  	it('should accept commit messages which match the rules in the config', () => {
+  	  testData.forEach(test => {
+  	  	expect(rules.validateMessage(test.msg)).toEqual(test.expectedResult);
+  	  });
+  	});
+
+  });
+});

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +'use strict';
++
 +module.exports = {
++
 +};