381ea9d7d4
Check a range of commits by retrieving the log files to be parsed with the expected format for the parser. This change is in part of a larger set of changes making the process for obtaining and parsing commits for release note creation and message validation consistent. This consistency will make it easier to debug as well as ease the design of tooling which is built on top of these processes. PR Close #41341
63 lines
1.8 KiB
TypeScript
63 lines
1.8 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 {Arguments, Argv, CommandModule} from 'yargs';
|
|
|
|
import {getUserConfig} from '../../utils/config';
|
|
|
|
import {validateFile} from './validate-file';
|
|
|
|
|
|
export interface ValidateFileOptions {
|
|
file?: string;
|
|
fileEnvVariable?: string;
|
|
error: boolean;
|
|
}
|
|
|
|
/** Builds the command. */
|
|
function builder(yargs: Argv) {
|
|
return yargs
|
|
.option('file', {
|
|
type: 'string',
|
|
conflicts: ['file-env-variable'],
|
|
description: 'The path of the commit message file.',
|
|
})
|
|
.option('file-env-variable' as 'fileEnvVariable', {
|
|
type: 'string',
|
|
conflicts: ['file'],
|
|
description: 'The key of the environment variable for the path of the commit message file.',
|
|
coerce: (arg: string) => {
|
|
const file = process.env[arg];
|
|
if (!file) {
|
|
throw new Error(`Provided environment variable "${arg}" was not found.`);
|
|
}
|
|
return file;
|
|
},
|
|
})
|
|
.option('error', {
|
|
type: 'boolean',
|
|
description:
|
|
'Whether invalid commit messages should be treated as failures rather than a warning',
|
|
default: !!getUserConfig().commitMessage?.errorOnInvalidMessage || !!process.env['CI']
|
|
});
|
|
}
|
|
|
|
/** Handles the command. */
|
|
async function handler({error, file, fileEnvVariable}: Arguments<ValidateFileOptions>) {
|
|
const filePath = file || fileEnvVariable || '.git/COMMIT_EDITMSG';
|
|
validateFile(filePath, error);
|
|
}
|
|
|
|
/** yargs command module describing the command. */
|
|
export const ValidateFileModule: CommandModule<{}, ValidateFileOptions> = {
|
|
handler,
|
|
builder,
|
|
command: 'pre-commit-validate',
|
|
describe: 'Validate the most recent commit message',
|
|
};
|