ci: simplified commitlint script

.editorconfig

@@ -4,7 +4,7 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 indent_style = tab
 
-[{.*rc,*.yml,*.md,package.json,*.svg}]
+[{.*rc,*.yml,*.md,package.json,lerna.json,*.svg}]
 indent_style = space
 
 [*.md]

.travis.yml

@@ -12,6 +12,8 @@ install:
   - npx --version
 script:
   - npx yarn build --since $TRAVIS_BRANCH --include-filtered-dependencies --stream
+  - npx lerna link
+  - commitlint-travis
   - npx yarn lint --since $TRAVIS_BRANCH --include-filtered-dependencies --stream
   - npx yarn deps --since $TRAVIS_BRANCH --include-filtered-dependencies --stream
   - npx yarn test --since $TRAVIS_BRANCH --include-filtered-dependencies --stream

@commitlint/cli/index.js

@@ -0,0 +1 @@
+module.exports = require.resolve('./src/cli.js');

@commitlint/travis-cli/README.md

@@ -0,0 +1,19 @@
+> Lint all relevant commits for a change or PR on Travis CI
+
+# @commitlint/travis-cli
+
+This package is a convenience wrapper around `commitlint`, 
+providing zero-configuration linting of all relevant commits
+for a given change/build combination.
+
+## Getting started
+
+```
+npm install --save-dev @commitlint/travis-cli
+```
+
+```yml
+# .travis.yml
+script
+  - commitlint-travis
+```

@commitlint/travis-cli/cli.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+const execa = require('execa');
+const isTravis = require('is-travis');
+
+// Allow to override used bins for testing purposes
+const GIT = process.env.TRAVIS_COMMITLINT_GIT_BIN || 'git';
+const COMMITLINT =
+	process.env.TRAVIS_COMMITLINT_BIN || require('@commitlint/cli'); // eslint-disable-line import/newline-after-import
+const REQUIRED = ['TRAVIS_COMMIT', 'TRAVIS_BRANCH'];
+
+main().catch(err => {
+	console.log({err});
+	setTimeout(() => {
+		console.log({err});
+		throw err;
+	}, 0);
+});
+
+function main() {
+	return new Promise((resolve, reject) => {
+		if (!isTravis) {
+			return reject(
+				new Error(`@commitlint/travis-cli is inteded of usage on Travis CI`)
+			);
+		}
+
+		const missing = REQUIRED.filter(envVar => !(envVar in process.env));
+
+		if (missing.length > 0) {
+			const stanza = missing.length > 1 ? 'they were not' : 'it was not';
+			return reject(
+				new Error(
+					`Expected ${missing.join(', ')} to be defined globally, ${stanza}.`
+				)
+			);
+		}
+
+		return execa(
+			GIT,
+			['remote', 'set-branches', 'origin', process.env.TRAVIS_BRANCH],
+			{stdio: 'inherit'}
+		)
+			.then(() => execa(GIT, ['fetch', '--unshallow'], {stdio: 'inherit'}))
+			.then(() =>
+				execa(GIT, ['checkout', process.env.TRAVIS_BRANCH], {stdio: 'inherit'})
+			)
+			.then(() => execa(GIT, ['checkout', '-'], {stdio: 'inherit'}))
+			.then(() =>
+				execa(
+					COMMITLINT,
+					[
+						'--from',
+						process.env.TRAVIS_BRANCH,
+						'--to',
+						process.env.TRAVIS_COMMIT
+					],
+					{stdio: 'inherit'}
+				)
+			);
+	});
+}

@commitlint/travis-cli/cli.test.js

@@ -0,0 +1,119 @@
+const os = require('os');
+const test = require('ava');
+const execa = require('execa');
+const which = require('which');
+
+const NODE_BIN = which.sync('node');
+const BIN = require.resolve('./cli.js');
+
+const TRAVIS_COMMITLINT_BIN = require.resolve('./fixtures/commitlint');
+const TRAVIS_COMMITLINT_GIT_BIN = require.resolve('./fixtures/git');
+const TRAVIS_BRANCH = 'TRAVIS_BRANCH';
+const TRAVIS_COMMIT = 'TRAVIS_COMMIT';
+
+const bin = async (env = {}) => {
+	try {
+		return await execa(BIN, {env, extendEnv: false});
+	} catch (err) {
+		throw new Error([err.stdout, err.stderr].join('\n'));
+	}
+};
+
+test('should throw when not on travis ci', async t => {
+	await t.throws(
+		bin(),
+		/@commitlint\/travis-cli is inteded of usage on Travis CI/
+	);
+});
+
+test('should throw when on travis ci, but env vars are missing', async t => {
+	const env = {
+		TRAVIS: true,
+		CI: true
+	};
+
+	await t.throws(bin(env), /TRAVIS_COMMIT, TRAVIS_BRANCH/);
+});
+
+test('should throw when on travis ci, but TRAVIS_COMMIT is missing', async t => {
+	const env = {
+		TRAVIS: true,
+		CI: true
+	};
+
+	await t.throws(bin(env), /TRAVIS_COMMIT/);
+});
+
+test('should throw when on travis ci, but TRAVIS_BRANCH is missing', async t => {
+	const env = {
+		TRAVIS: true,
+		CI: true
+	};
+
+	await t.throws(bin(env), /TRAVIS_BRANCH/);
+});
+
+test('should call git with expected args if requirements are fulfilled', async t => {
+	if (os.platform() === 'win32') {
+		t.pass();
+		return;
+	}
+
+	const env = {
+		TRAVIS: true,
+		CI: true,
+		TRAVIS_BRANCH,
+		TRAVIS_COMMIT,
+		TRAVIS_COMMITLINT_BIN,
+		TRAVIS_COMMITLINT_GIT_BIN
+	};
+
+	const result = await bin(env);
+	const invocations = await getInvocations(result.stdout);
+	t.is(invocations.length, 5);
+
+	const [branches, unshallow, checkout, back, commilint] = invocations;
+
+	t.deepEqual(branches, [
+		NODE_BIN,
+		TRAVIS_COMMITLINT_GIT_BIN,
+		'remote',
+		'set-branches',
+		'origin',
+		TRAVIS_BRANCH
+	]);
+	t.deepEqual(unshallow, [
+		NODE_BIN,
+		TRAVIS_COMMITLINT_GIT_BIN,
+		'fetch',
+		'--unshallow'
+	]);
+	t.deepEqual(checkout, [
+		NODE_BIN,
+		TRAVIS_COMMITLINT_GIT_BIN,
+		'checkout',
+		TRAVIS_BRANCH
+	]);
+	t.deepEqual(back, [NODE_BIN, TRAVIS_COMMITLINT_GIT_BIN, 'checkout', '-']);
+	t.deepEqual(commilint, [
+		NODE_BIN,
+		TRAVIS_COMMITLINT_BIN,
+		'--from',
+		TRAVIS_BRANCH,
+		'--to',
+		TRAVIS_COMMIT
+	]);
+});
+
+function getInvocations(stdout) {
+	const matches = stdout.match(/[^[\]]+/g);
+	const raw = Array.isArray(matches) ? matches : [];
+
+	return raw.filter(invocation => invocation !== '\n').map(invocation =>
+		invocation
+			.split(',')
+			.map(fragment => fragment.trim())
+			.map(fragment => fragment.substring(1, fragment.length - 1))
+			.filter(Boolean)
+	);
+}

@commitlint/travis-cli/fixtures/commitlint.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+console.log(process.argv);

@commitlint/travis-cli/fixtures/git.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+console.log(process.argv);

@commitlint/travis-cli/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@commitlint/travis-cli",
+  "version": "5.0.1",
+  "description": "Lint all relevant commits for a change or PR on Travis CI",
+  "bin": {
+    "commitlint-travis": "./cli.js"
+  },
+  "scripts": {
+    "deps": "dep-check",
+    "lint": "npx xo",
+    "start": "npx ava -c 4 --verbose --watch",
+    "test": "npx ava -c 4 --verbose"
+  },
+  "ava": {
+    "files": [
+      "*.test.js"
+    ],
+    "source": [
+      "*.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": "^5.0.1",
+    "ava": "0.18.2",
+    "which": "^1.3.0"
+  },
+  "dependencies": {
+    "@commitlint/cli": "^5.0.1",
+    "execa": "^0.8.0",
+    "is-travis": "^1.0.0"
+  }
+}

lerna.json

@@ -2,5 +2,6 @@
   "lerna": "2.5.1",
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "5.0.1"
+  "version": "5.0.1",
+  "mode": "independent"
 }

package.json

@@ -81,6 +81,7 @@
     "@marionebl/sander": "0.6.1"
   },
   "devDependencies": {
+    "@commitlint/travis-cli": "file:./@commitlint/travis-cli",
     "docsify-cli": "4.1.12",
     "eslint": "4.11.0",
     "eslint-config-prettier": "2.8.0",

yarn.lock

@@ -53,6 +53,14 @@
     imurmurhash "^0.1.4"
     slide "^1.1.5"
 
+"@commitlint/travis-cli@file:./@commitlint/travis-cli":
+  version "5.0.1"
+  dependencies:
+    "@commitlint/cli" "^5.0.1"
+    execa "^0.8.0"
+    is-travis "^1.0.0"
+    meow "3.7.0"
+
 "@concordance/react@^1.0.0":
   version "1.0.0"
   resolved "https://registry.npmjs.org/@concordance/react/-/react-1.0.0.tgz#fcf3cad020e5121bfd1c61d05bc3516aac25f734"
@@ -3955,6 +3963,10 @@ is-text-path@^1.0.0:
   dependencies:
     text-extensions "^1.0.0"
 
+is-travis@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.npmjs.org/is-travis/-/is-travis-1.0.0.tgz#89d40ed56d9b8f8c36dfbe5811ba7e5e14944df9"
+
 is-typedarray@~1.0.0:
   version "1.0.0"
   resolved "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a"