Rename to commitlint

.gitignore

@@ -1,41 +1,9 @@
-# Logs
-logs
-*.log
 npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
+lerna-debug.log
 node_modules
-
-# Optional npm cache directory
 .npm
-
-# Optional REPL history
-.node_repl_history
-
-# jsonlint-cli cache
-.tmp
-
-# transpiled artifacts
-distribution
-
 .nyc_output
+.dockerignore
+.*.dockerfile
+@commitlint/**/lib
+@commitlint/**/package.json.lerna_backup

.travis.yml

@@ -1,12 +1,5 @@
 language: node_js
 node_js:
-  - '7'
+  - '8'
   - '6'
   - '4'
-before_install:
-  - git fetch --unshallow
-before_script:
-  - npm run build
-script:
-  - npm run travis:lint:commits
-  - npm test

.vscode/settings.json

@@ -0,0 +1,4 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+	"xo.enable": true
+}

@commitlint/cli/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+<a name="3.0.1"></a>
+## 3.0.1 (2017-07-11)
+
+
+
+<a name="3.0.0"></a>
+# 3.0.0 (2017-07-10)
+
+
+### Bug Fixes
+
+* **cli:** remove destructuring for node 4 support ([94437e8](https://github.com/marionebl/commitlint/commit/94437e8))
+* ensure node4 compat ([a5e658a](https://github.com/marionebl/commitlint/commit/a5e658a))
+
+
+
+
+<a name="3.0.0"></a>
+# 3.0.0 (2017-07-10)
+
+
+### Bug Fixes
+
+* **cli:** remove destructuring for node 4 support ([94437e8](https://github.com/marionebl/commitlint/commit/94437e8))
+* ensure node4 compat ([a5e658a](https://github.com/marionebl/commitlint/commit/a5e658a))

@commitlint/cli/cli.js

@@ -0,0 +1,118 @@
+#!/usr/bin/env node
+require('babel-polyfill'); // eslint-disable-line import/no-unassigned-import
+
+// npm modules
+const core = require('@commitlint/core');
+const chalk = require('chalk');
+const meow = require('meow');
+const pick = require('lodash').pick;
+const stdin = require('get-stdin');
+
+const pkg = require('./package');
+const help = require('./help');
+
+/**
+ * Behavioural rules
+ */
+const rules = {
+	fromStdin: (input, flags) => input.length === 0 &&
+		typeof flags.from !== 'string' &&
+		typeof flags.to !== 'string' &&
+		!flags.edit
+};
+
+const configuration = {
+	string: ['from', 'to', 'extends'],
+	boolean: ['edit', 'help', 'version', 'quiet', 'color'],
+	alias: {
+		c: 'color',
+		e: 'edit',
+		f: 'from',
+		t: 'to',
+		q: 'quiet',
+		h: 'help',
+		v: 'version',
+		x: 'extends'
+	},
+	description: {
+		color: 'toggle colored output',
+		edit: 'read last commit message found in ./git/COMMIT_EDITMSG',
+		extends: 'array of shareable configurations to extend',
+		from: 'lower end of the commit range to lint; applies if edit=false',
+		to: 'upper end of the commit range to lint; applies if edit=false',
+		quiet: 'toggle console output'
+	},
+	default: {
+		color: true,
+		edit: false,
+		from: null,
+		to: null,
+		quiet: false
+	},
+	unknown(arg) {
+		throw new Error(`unknown flags: ${arg}`);
+	}
+};
+
+const cli = meow({
+	help: `[input] reads from stdin if --edit, --from and --to are omitted\n${help(configuration)}`,
+	description: `${pkg.name}@${pkg.version} - ${pkg.description}`
+}, configuration);
+
+const load = seed => core.load(seed);
+
+function main(options) {
+	const raw = options.input;
+	const flags = options.flags;
+	const fromStdin = rules.fromStdin(raw, flags);
+
+	const range = pick(flags, 'edit', 'from', 'to');
+	const input = fromStdin ? stdin() : core.read(range);
+	const fmt = new chalk.constructor({enabled: flags.color});
+
+	return input
+		.then(raw => Array.isArray(raw) ? raw : [raw])
+		.then(messages => Promise.all(messages.map(commit => {
+			return load(getSeed(flags))
+				.then(opts => core.lint(commit, opts.rules))
+				.then(report => {
+					const formatted = core.format(report, {color: flags.color});
+
+					if (!flags.quiet) {
+						console.log(`${fmt.grey('⧗')}   input: ${fmt.bold(commit.split('\n')[0])}`);
+						console.log(formatted.join('\n'));
+					}
+
+					if (report.errors.length > 0) {
+						const error = new Error(formatted[formatted.length - 1]);
+						error.type = pkg.name;
+						throw error;
+					}
+					return console.log('');
+				});
+		})
+	));
+}
+
+function getSeed(seed) {
+	const e = Array.isArray(seed.extends) ? seed.extends : [seed.extends];
+	const n = e.filter(i => typeof i === 'string');
+	return n.length > 0 ? {extends: n} : {};
+}
+
+// Start the engine
+main(cli)
+	.catch(err =>
+		setTimeout(() => {
+			if (err.type === pkg.name) {
+				process.exit(1);
+			}
+			throw err;
+		})
+	);
+
+// Catch unhandled rejections globally
+process.on('unhandledRejection', (reason, promise) => {
+	console.log('Unhandled Rejection at: Promise ', promise, ' reason: ', reason);
+	throw reason;
+});

@commitlint/cli/cli.test.js

@@ -0,0 +1,71 @@
+import path from 'path';
+import test from 'ava';
+import execa from 'execa';
+import stream from 'string-to-stream';
+
+const here = path.join.bind(null, __dirname);
+
+const SIMPLE = here('fixtures/simple');
+const EXTENDS_ROOT = here('fixtures/extends-root');
+const EMPTY = here('fixtures/empty');
+
+const cli = (input = '', args = [], opts = {}) => {
+	const c = execa(here('cli.js'), args, {
+		capture: ['stdout'],
+		cwd: opts.cwd
+	});
+	stream(input).pipe(c.stdin);
+	return c;
+};
+
+test('should throw when called without [input]', t => {
+	t.throws(cli(), /Expected a raw commit/);
+});
+
+test('should reprint input from stdin', async t => {
+	const actual = await cli('foo: bar', [], {cwd: EMPTY});
+	t.true(actual.stdout.includes('foo: bar'));
+});
+
+test('should produce no success output with --quiet flag', async t => {
+	const actual = await cli('foo: bar', ['--quiet'], {cwd: EMPTY});
+	t.is(actual.stdout, '');
+	t.is(actual.stderr, '');
+});
+
+test('should produce no success output with -q flag', async t => {
+	const actual = await cli('foo: bar', ['-q'], {cwd: EMPTY});
+	t.is(actual.stdout, '');
+	t.is(actual.stderr, '');
+});
+
+test('should succeed for input from stdin without rules', async t => {
+	const actual = await cli('foo: bar', [], {cwd: EMPTY});
+	t.is(actual.code, 0);
+});
+
+test('should fail for input from stdin with rule from rc', async t => {
+	const actual = await t.throws(cli('foo: bar', [], {cwd: SIMPLE}));
+	t.true(actual.stdout.includes('scope must not be one of [foo]'));
+	t.is(actual.code, 1);
+});
+
+test('should fail for input from stdin with rule from js', async t => {
+	const actual = await t.throws(cli('foo: bar', ['--extends', './extended'], {cwd: EXTENDS_ROOT}));
+	t.true(actual.stdout.includes('scope must not be one of [foo]'));
+	t.is(actual.code, 1);
+});
+
+test('should produce no error output with --quiet flag', async t => {
+	const actual = await t.throws(cli('foo: bar', ['--quiet'], {cwd: SIMPLE}));
+	t.is(actual.stdout, '');
+	t.is(actual.stderr, '');
+	t.is(actual.code, 1);
+});
+
+test('should produce no error output with -q flag', async t => {
+	const actual = await t.throws(cli('foo: bar', ['-q'], {cwd: SIMPLE}));
+	t.is(actual.stdout, '');
+	t.is(actual.stderr, '');
+	t.is(actual.code, 1);
+});

@commitlint/cli/fixtures/empty/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {};

@commitlint/cli/fixtures/extends-root/extended.js

@@ -0,0 +1,5 @@
+module.exports = {
+	rules: {
+		'type-enum': [2, 'never', ['foo']]
+	}
+};

@commitlint/cli/fixtures/simple/commitlint.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+	rules: {
+		'type-enum': [2, 'never', ['foo']]
+	}
+};

source/help.js → @commitlint/cli/help.js

@@ -1,7 +1,8 @@
-export default configuration => {
+module.exports = configuration => {
 	const lines = Object.entries(configuration.description)
 		.map(entry => {
-			const [name, desc] = entry;
+			const name = entry[0];
+			const desc = entry[1];
 			const alias = Object.entries(configuration.alias)
 				.find(entry => entry[1] === name)
 				.map(entry => entry[0])[0];
@@ -11,14 +12,16 @@ export default configuration => {
 
 	const longest = lines
 		.map(line => {
-			const [flags] = line;
+			const flags = line[0];
 			return flags.reduce((sum, flag) => sum + flag.length, 0);
 		})
 		.sort(Number)[0];
 
 	return lines
 		.map(line => {
-			const [flags, desc, defaults] = line;
+			const flags = line[0];
+			const desc = line[1];
+			const defaults = line[2];
 			const fs = flags.map(flag => flag.length > 1 ? `--${flag}` : `-${flag}`);
 			const ds = defaults ? `, defaults to: ${defaults}` : '';
 			const length = flags.reduce((sum, flag) => sum + flag.length, 0);

@commitlint/cli/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@commitlint/cli",
+  "version": "3.0.1",
+  "description": "Lint your commit messages",
+  "bin": {
+    "commitlint": "cli.js"
+  },
+  "scripts": {
+    "build": "exit 0",
+    "clean": "exit 0",
+    "pretest": "dep-check",
+    "test": "ava",
+    "prepublish": "npm test"
+  },
+  "ava": {
+    "files": [
+      "cli.test.js"
+    ]
+  },
+  "xo": false,
+  "engines": {
+    "node": ">=4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/marionebl/commitlint.git"
+  },
+  "bugs": {
+    "url": "https://github.com/marionebl/commitlint/issues"
+  },
+  "homepage": "https://github.com/marionebl/commitlint#readme",
+  "keywords": [
+    "conventional-changelog",
+    "commitlint",
+    "cli"
+  ],
+  "author": {
+    "name": "Mario Nebl",
+    "email": "[email protected]"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@commitlint/utils": "^3.0.0",
+    "ava": "^0.18.2",
+    "dependency-check": "^2.9.1",
+    "execa": "^0.7.0",
+    "string-to-stream": "^1.1.0",
+    "xo": "^0.18.2"
+  },
+  "dependencies": {
+    "@commitlint/core": "^3.0.1",
+    "babel-polyfill": "^6.23.0",
+    "chalk": "^2.0.1",
+    "get-stdin": "^5.0.1",
+    "lodash": "^4.17.4",
+    "meow": "^3.7.0"
+  }
+}