cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(dev-infra): migrate to unified commit message types in commit message linting (#38430)

Browse Source 
Previously commit message types were provided as part of the ng-dev config in the repository
using the ng-dev toolset.  This change removes this configuration expectation and instead
predefines the valid types for commit messages.

Additionally, with this new unified set of types requirements around providing a scope have
been put in place.  Scopes are either required, optional or forbidden for a given commit
type.

PR Close #38430
This commit is contained in:
Joey Perrott
2020-08-12 09:36:59 -07:00
committed by Andrew Scott
parent 773f7908c0
commit 9f7a37b4e9
3 changed files with 76 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
dev-infra/commit-message/validate.ts
View File

@ -7,7 +7,7 @@
*/
import {error} from '../utils/console';
import {getCommitMessageConfig} from './config';
import {COMMIT_TYPES, getCommitMessageConfig, ScopeRequirement} from './config';
import {parseCommitMessage} from './parse';
/** Options for commit message validation. */
@ -86,8 +86,26 @@ export function validateCommitMessage(
return false;
}
if (!config.types.includes(commit.type)) {
printError(`'${commit.type}' is not an allowed type.\n => TYPES: ${config.types.join(', ')}`);
if (COMMIT_TYPES[commit.type] === undefined) {
printError(`'${commit.type}' is not an allowed type.\n => TYPES: ${
Object.keys(COMMIT_TYPES).join(', ')}`);
return false;
}
/** The scope requirement level for the provided type of the commit message. */
const scopeRequirementForType = COMMIT_TYPES[commit.type].scope;
if (scopeRequirementForType === ScopeRequirement.Forbidden && commit.scope) {
printError(`Scopes are forbidden for commits with type '${commit.type}', but a scope of '${
commit.scope}' was provided.`);
return false;
}
if (scopeRequirementForType === ScopeRequirement.Required && !commit.scope) {
printError(
`Scopes are required for commits with type '${commit.type}', but no scope was provided.`);
return false;
}