index.test.js

import lint from '@commitlint/lint';
import {rules, parserPreset} from '.';

export const testCommit = async ({message, valid, error, warning}) => {
	const m = message.replace(/^\s+/, '').trim();
	test(m.split('\n')[0], async () => {
		const parserOpts = parserPreset.parserOpts;
		const result = await lint(m, rules, {parserOpts});

		expect(result.valid).toBe(valid);

		if (result.errors.length > 1) {
			console.log(errors);
			fail(
				'Commit test should only have one error message to validate against'
			);
		} else if (result.errors.length) {
			expect(result.errors[0].message).toBe(error);
		}

		if (result.warnings.length > 1) {
			fail(
				'Commit test should only have one warning message to validate against'
			);
		} else if (result.warnings.length) {
			expect(result.warnings[0].message).toBe(warning);
		}
	});
};

testCommit({
	message: `test: a valid angular commit`,
	valid: true,
});

testCommit({
	message: `test(scope): a valid angular commit with a scope`,
	valid: true,
});

testCommit({
	message: `
		test(scope): a valid angular commit with a scope

		Some content in the body
	`,
	valid: true,
});

testCommit({
	message: `
		test(scope): a valid angular commit with a scope
		Some content in the body
	`,
	valid: true,
	warning: 'body must have leading blank line',
});

testCommit({
	message: `no: no is not not an invalid commit type`,
	valid: false,
	error:
		'type must be one of [build, ci, docs, feat, fix, perf, refactor, revert, style, test]',
});

testCommit({
	message: `test: that its an error when there is ia realllllllllllllllllllllly long header`,
	valid: false,
	error: 'header must not be longer than 72 characters, current length is 79',
});

testCommit({
	message: `test!: with a breaking change in the type`,
	valid: false,
	error:
		'subject must not have an exclamation mark in the subject to identify a breaking change',
});

testCommit({
	message: `test(scope)!: with a breaking change in the type with scope`,
	valid: false,
	error:
		'subject must not have an exclamation mark in the subject to identify a breaking change',
});