106 lines
3.6 KiB
TypeScript
106 lines
3.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {parseCommitMessage, ParsedCommitMessage} from './parse';
|
|
|
|
|
|
const commitValues = {
|
|
prefix: '',
|
|
type: 'fix',
|
|
scope: 'changed-area',
|
|
summary: 'This is a short summary of the change',
|
|
body: 'This is a longer description of the change Closes #1',
|
|
};
|
|
|
|
function buildCommitMessage(params = {}) {
|
|
const {prefix, type, scope, summary, body} = {...commitValues, ...params};
|
|
return `${prefix}${type}${scope ? '(' + scope + ')' : ''}: ${summary}\n\n${body}`;
|
|
}
|
|
|
|
|
|
describe('commit message parsing:', () => {
|
|
it('parses the scope', () => {
|
|
const message = buildCommitMessage();
|
|
expect(parseCommitMessage(message).scope).toBe(commitValues.scope);
|
|
});
|
|
|
|
it('parses the type', () => {
|
|
const message = buildCommitMessage();
|
|
expect(parseCommitMessage(message).type).toBe(commitValues.type);
|
|
});
|
|
|
|
it('parses the header', () => {
|
|
const message = buildCommitMessage();
|
|
expect(parseCommitMessage(message).header)
|
|
.toBe(`${commitValues.type}(${commitValues.scope}): ${commitValues.summary}`);
|
|
});
|
|
|
|
it('parses the body', () => {
|
|
const message = buildCommitMessage();
|
|
expect(parseCommitMessage(message).body).toBe(commitValues.body);
|
|
});
|
|
|
|
it('parses the body without Github linking', () => {
|
|
const body = 'This has linking\nCloses #1';
|
|
const message = buildCommitMessage({body});
|
|
expect(parseCommitMessage(message).bodyWithoutLinking).toBe('This has linking\n');
|
|
});
|
|
|
|
it('parses the subject', () => {
|
|
const message = buildCommitMessage();
|
|
expect(parseCommitMessage(message).subject).toBe(commitValues.summary);
|
|
});
|
|
|
|
it('identifies if a commit is a fixup', () => {
|
|
const message1 = buildCommitMessage();
|
|
expect(parseCommitMessage(message1).isFixup).toBe(false);
|
|
|
|
const message2 = buildCommitMessage({prefix: 'fixup! '});
|
|
expect(parseCommitMessage(message2).isFixup).toBe(true);
|
|
});
|
|
|
|
it('identifies if a commit is a revert', () => {
|
|
const message1 = buildCommitMessage();
|
|
expect(parseCommitMessage(message1).isRevert).toBe(false);
|
|
|
|
const message2 = buildCommitMessage({prefix: 'revert: '});
|
|
expect(parseCommitMessage(message2).isRevert).toBe(true);
|
|
|
|
const message3 = buildCommitMessage({prefix: 'revert '});
|
|
expect(parseCommitMessage(message3).isRevert).toBe(true);
|
|
});
|
|
|
|
it('identifies if a commit is a squash', () => {
|
|
const message1 = buildCommitMessage();
|
|
expect(parseCommitMessage(message1).isSquash).toBe(false);
|
|
|
|
const message2 = buildCommitMessage({prefix: 'squash! '});
|
|
expect(parseCommitMessage(message2).isSquash).toBe(true);
|
|
});
|
|
|
|
it('ignores comment lines', () => {
|
|
const message = buildCommitMessage({
|
|
prefix: '# This is a comment line before the header.\n' +
|
|
'## This is another comment line before the headers.\n',
|
|
body: '# This is a comment line befor the body.\n' +
|
|
'This is line 1 of the actual body.\n' +
|
|
'## This is another comment line inside the body.\n' +
|
|
'This is line 2 of the actual body (and it also contains a # but it not a comment).\n' +
|
|
'### This is yet another comment line after the body.\n',
|
|
});
|
|
const parsedMessage = parseCommitMessage(message);
|
|
|
|
expect(parsedMessage.header)
|
|
.toBe(`${commitValues.type}(${commitValues.scope}): ${commitValues.summary}`);
|
|
expect(parsedMessage.body)
|
|
.toBe(
|
|
'This is line 1 of the actual body.\n' +
|
|
'This is line 2 of the actual body (and it also contains a # but it not a comment).\n');
|
|
});
|
|
});
|