feat(dev-infra): standard CLI commands using yargs (#36326)
Creates a standard model for CLI commands provided by ng-dev. Allows for us to have any of the tools/scripts extend to be included in the ng-dev command, or be standalone using the same yargs parser. PR Close #36326
This commit is contained in:

committed by
Kara Erickson

parent
cb0a2a055d
commit
8ea30b662f
@ -4,15 +4,19 @@ load("@npm_bazel_typescript//:index.bzl", "ts_library")
|
||||
ts_library(
|
||||
name = "commit-message",
|
||||
srcs = [
|
||||
"cli.ts",
|
||||
"config.ts",
|
||||
"validate.ts",
|
||||
"validate-file.ts",
|
||||
],
|
||||
module_name = "@angular/dev-infra-private/commit-message",
|
||||
visibility = ["//dev-infra:__subpackages__"],
|
||||
deps = [
|
||||
"//dev-infra/utils:config",
|
||||
"@npm//@types/node",
|
||||
"@npm//@types/yargs",
|
||||
"@npm//tslib",
|
||||
"@npm//yargs",
|
||||
],
|
||||
)
|
||||
|
||||
|
20
dev-infra/commit-message/cli.ts
Normal file
20
dev-infra/commit-message/cli.ts
Normal file
@ -0,0 +1,20 @@
|
||||
/**
|
||||
* @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 * as yargs from 'yargs';
|
||||
import {validateFile} from './validate-file';
|
||||
|
||||
/** Build the parser for the commit-message commands. */
|
||||
export function buildCommitMessageParser(localYargs: yargs.Argv) {
|
||||
return localYargs.help().strict().command(
|
||||
'pre-commit-validate', 'Validate the most recent commit message', {},
|
||||
() => { validateFile('.git/COMMIT_EDITMSG'); });
|
||||
}
|
||||
|
||||
if (require.main == module) {
|
||||
buildCommitMessageParser(yargs).parse();
|
||||
}
|
21
dev-infra/commit-message/validate-file.ts
Normal file
21
dev-infra/commit-message/validate-file.ts
Normal file
@ -0,0 +1,21 @@
|
||||
/**
|
||||
* @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 {readFileSync} from 'fs';
|
||||
import {join} from 'path';
|
||||
|
||||
import {getRepoBaseDir} from '../utils/config';
|
||||
|
||||
import {validateCommitMessage} from './validate';
|
||||
|
||||
/** Validate commit message at the provided file path. */
|
||||
export function validateFile(filePath: string) {
|
||||
const commitMessage = readFileSync(join(getRepoBaseDir(), filePath), 'utf8');
|
||||
if (validateCommitMessage(commitMessage)) {
|
||||
console.info('√ Valid commit message');
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user