c0d5684078
While `fixup! ` is fine, `squash! ` means that the commit message needs
tweaking, which cannot be done automatically during merging (i.e. it
should be done by the PR author).
Previously, `validate-commit-message` would always allow
`squash! `-prefixed commits, which would cause problems during merging.
This commit changes `validate-commit-message` to make it configurable
whether such commits are allowed and configures the
`gulp validate-commit-message` task, which is run as part of the `lint`
job on CI, to not allow them.
NOTE: This new check is disabled in the pre-commit git hook that is used
to validate commit messages, because these commits might still be
useful during development.
PR Close #32023
85 lines
2.2 KiB
JavaScript
85 lines
2.2 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
/**
|
|
* @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
|
|
*/
|
|
|
|
/**
|
|
* GIT commit message format enforcement
|
|
*
|
|
* Note: this script was originally written by Vojta for AngularJS :-)
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const config = require('./commit-message.json');
|
|
const FIXUP_PREFIX_RE = /^fixup! /i;
|
|
const SQUASH_PREFIX_RE = /^squash! /i;
|
|
const REVERT_PREFIX_RE = /^revert:? /i;
|
|
|
|
module.exports = (commitHeader, disallowSquash) => {
|
|
if (REVERT_PREFIX_RE.test(commitHeader)) {
|
|
return true;
|
|
}
|
|
|
|
const {header, type, scope, isSquash} = parseCommitHeader(commitHeader);
|
|
|
|
if (isSquash && disallowSquash) {
|
|
error('The commit must be manually squashed into the target commit', commitHeader);
|
|
return false;
|
|
}
|
|
|
|
if (header.length > config.maxLength) {
|
|
error(`The commit message header is longer than ${config.maxLength} characters`, commitHeader);
|
|
return false;
|
|
}
|
|
|
|
if (!type) {
|
|
const format = '<type>(<scope>): <subject>';
|
|
error(
|
|
`The commit message header does not match the format of '${format}' or 'Revert: "${format}"'`,
|
|
commitHeader);
|
|
return false;
|
|
}
|
|
|
|
if (!config.types.includes(type)) {
|
|
error(`'${type}' is not an allowed type.\n => TYPES: ${config.types.join(', ')}`, commitHeader);
|
|
return false;
|
|
}
|
|
|
|
if (scope && !config.scopes.includes(scope)) {
|
|
error(
|
|
`'${scope}' is not an allowed scope.\n => SCOPES: ${config.scopes.join(', ')}`,
|
|
commitHeader);
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
module.exports.config = config;
|
|
|
|
// Helpers
|
|
function error(errorMessage, commitHeader) {
|
|
console.error(`INVALID COMMIT MSG: ${commitHeader}\n => ERROR: ${errorMessage}`);
|
|
}
|
|
|
|
function parseCommitHeader(header) {
|
|
const isFixup = FIXUP_PREFIX_RE.test(header);
|
|
const isSquash = SQUASH_PREFIX_RE.test(header);
|
|
header = header.replace(FIXUP_PREFIX_RE, '').replace(SQUASH_PREFIX_RE, '');
|
|
|
|
const match = /^(\w+)(?:\(([^)]+)\))?\: (.+)$/.exec(header) || [];
|
|
|
|
return {
|
|
header,
|
|
type: match[1],
|
|
scope: match[2],
|
|
subject: match[3], isFixup, isSquash,
|
|
};
|
|
}
|