honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/dev-infra/commit-message/validate.ts

159 lines
5.0 KiB
TypeScript
Raw Normal View History

feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
/**
* @license
* Copyright Google Inc. 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 {getAngularDevConfig} from '../utils/config';
import {CommitMessageConfig} from './config';
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
/** Options for commit message validation. */
export interface ValidateCommitMessageOptions {
disallowSquash?: boolean;
nonFixupCommitHeaders?: string[];
}
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
const FIXUP_PREFIX_RE = /^fixup! /i;
const GITHUB_LINKING_RE = /((closed?s?)|(fix(es)?(ed)?)|(resolved?s?))\s\#(\d+)/ig;
const SQUASH_PREFIX_RE = /^squash! /i;
const REVERT_PREFIX_RE = /^revert:? /i;
const TYPE_SCOPE_RE = /^(\w+)(?:\(([^)]+)\))?\:\s(.+)$/;
const COMMIT_HEADER_RE = /^(.*)/i;
fix(dev-infra): properly handle multiline regex of commit body (#36632) Previously, the commit message body regex only matched the first line of the body. This change corrects the regex to match the entire line. PR Close #36632
2020-04-14 18:25:05 -04:00
const COMMIT_BODY_RE = /^.*\n\n([\s\S]*)$/;
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
/** Parse a full commit message into its composite parts. */
export function parseCommitMessage(commitMsg: string) {
let header = '';
let body = '';
let bodyWithoutLinking = '';
let type = '';
let scope = '';
let subject = '';
if (COMMIT_HEADER_RE.test(commitMsg)) {
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
header = COMMIT_HEADER_RE.exec(commitMsg)![1]
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
.replace(FIXUP_PREFIX_RE, '')
.replace(SQUASH_PREFIX_RE, '');
}
if (COMMIT_BODY_RE.test(commitMsg)) {
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
body = COMMIT_BODY_RE.exec(commitMsg)![1];
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
bodyWithoutLinking = body.replace(GITHUB_LINKING_RE, '');
}
if (TYPE_SCOPE_RE.test(header)) {
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
const parsedCommitHeader = TYPE_SCOPE_RE.exec(header)!;
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
type = parsedCommitHeader[1];
scope = parsedCommitHeader[2];
subject = parsedCommitHeader[3];
}
return {
header,
body,
bodyWithoutLinking,
type,
scope,
subject,
isFixup: FIXUP_PREFIX_RE.test(commitMsg),
isSquash: SQUASH_PREFIX_RE.test(commitMsg),
isRevert: REVERT_PREFIX_RE.test(commitMsg),
};
}
/** Validate a commit message against using the local repo's config. */
export function validateCommitMessage(
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
commitMsg: string, options: ValidateCommitMessageOptions = {}) {
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
function error(errorMessage: string) {
console.error(
`INVALID COMMIT MSG: \n` +
`${'─'.repeat(40)}\n` +
`${commitMsg}\n` +
`${'─'.repeat(40)}\n` +
`ERROR: \n` +
` ${errorMessage}` +
`\n\n` +
`The expected format for a commit is: \n` +
`<type>(<scope>): <subject>\n\n<body>`);
}
const config = getAngularDevConfig<'commitMessage', CommitMessageConfig>().commitMessage;
const commit = parseCommitMessage(commitMsg);
fix(dev-infra): properly handle multiline regex of commit body (#36632) Previously, the commit message body regex only matched the first line of the body. This change corrects the regex to match the entire line. PR Close #36632
2020-04-14 18:25:05 -04:00
////////////////////////////////////
// Checking revert, squash, fixup //
////////////////////////////////////
build: require a commit body in commit messages (#36632) Enforces a requirement that all PR commit messages contain a body of at least 100 characters. This is meant to encourage commits within the repo to be more descriptive of each change. PR Close #36632
2020-04-06 16:18:59 -04:00
// All revert commits are considered valid.
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
if (commit.isRevert) {
return true;
}
build: require a commit body in commit messages (#36632) Enforces a requirement that all PR commit messages contain a body of at least 100 characters. This is meant to encourage commits within the repo to be more descriptive of each change. PR Close #36632
2020-04-06 16:18:59 -04:00
// All squashes are considered valid, as the commit will be squashed into another in
// the git history anyway, unless the options provided to not allow squash commits.
if (commit.isSquash) {
if (options.disallowSquash) {
error('The commit must be manually squashed into the target commit');
return false;
}
return true;
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
}
build: require a commit body in commit messages (#36632) Enforces a requirement that all PR commit messages contain a body of at least 100 characters. This is meant to encourage commits within the repo to be more descriptive of each change. PR Close #36632
2020-04-06 16:18:59 -04:00
// Fixups commits are considered valid, unless nonFixupCommitHeaders are provided to check
// against. If `nonFixupCommitHeaders` is not empty, we check whether there is a corresponding
// non-fixup commit (i.e. a commit whose header is identical to this commit's header after
// stripping the `fixup! ` prefix), otherwise we assume this verification will happen in another
// check.
if (commit.isFixup) {
if (options.nonFixupCommitHeaders && !options.nonFixupCommitHeaders.includes(commit.header)) {
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
error(
'Unable to find match for fixup commit among prior commits: ' +
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
(options.nonFixupCommitHeaders.map(x => `\n ${x}`).join('') || '-'));
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
return false;
}
return true;
}
fix(dev-infra): properly handle multiline regex of commit body (#36632) Previously, the commit message body regex only matched the first line of the body. This change corrects the regex to match the entire line. PR Close #36632
2020-04-14 18:25:05 -04:00
////////////////////////////
// Checking commit header //
////////////////////////////
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
if (commit.header.length > config.maxLineLength) {
error(`The commit message header is longer than ${config.maxLineLength} characters`);
return false;
}
if (!commit.type) {
error(`The commit message header does not match the expected format.`);
return false;
}
if (!config.types.includes(commit.type)) {
error(`'${commit.type}' is not an allowed type.\n => TYPES: ${config.types.join(', ')}`);
return false;
}
if (commit.scope && !config.scopes.includes(commit.scope)) {
error(`'${commit.scope}' is not an allowed scope.\n => SCOPES: ${config.scopes.join(', ')}`);
return false;
}
fix(dev-infra): properly handle multiline regex of commit body (#36632) Previously, the commit message body regex only matched the first line of the body. This change corrects the regex to match the entire line. PR Close #36632
2020-04-14 18:25:05 -04:00
//////////////////////////
// Checking commit body //
//////////////////////////
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
if (commit.bodyWithoutLinking.trim().length < config.minBodyLength) {
fix(dev-infra): use commit message validation from @angular/dev-infra-private (#36172) Prior to this change we manage a local version of commit message validation in addition to the commit message validation tool contained in the ng-dev tooling. By adding the ability to validate a range of commit messages together, the remaining piece of commit message validation that is in the local version is replicated. We use both commands provided by the `ng-dev commit-message` tooling: - pre-commit-validate: Set to automatically run on an git hook to validate commits as they are created locally. - validate-range: Run by CI for every PR, testing that all of the commits added by the PR are valid when considered together. Ensuring that all fixups are matched to another commit in the change. PR Close #36172
2020-03-20 15:24:12 -04:00
error(`The commit message body does not meet the minimum length of ${
config.minBodyLength} characters`);
feat(dev-infra): create commit-message validation script/tooling (#36117) PR Close #36117
2020-03-10 13:29:44 -04:00
return false;
}
const bodyByLine = commit.body.split('\n');
if (bodyByLine.some(line => line.length > config.maxLineLength)) {
error(
`The commit messsage body contains lines greater than ${config.maxLineLength} characters`);
return false;
}
return true;
}