67f65a9d25
Currently the `GitClient` accepts a generic parameter for determining
whether the `githubToken` should be set or not. This worked fine so far
in terms of distinguishing between an authenticated and
non-authenticated git client instance, but if we intend to conditionally
show methods only for authenticated instances, the generic parameter
is not suitable.
This commit splits up the `GitClient` into two classes. One for
the base logic without any authorization, and a second class that
extends the base logic with authentication logic. i.e. the
`AuthenticatedGitClient`. This allows us to have specific methods only
for the authenticated instance. e.g.
* `hasOauthScopes` has been moved to only exist for authenticated
instances.
* the GraphQL functionality within `gitClient.github` is not
accessible for non-authenticated instances. GraphQL API requires
authentication as per Github.
The initial motiviation for this was that we want to throw if
`hasOAuthScopes` is called without the Octokit instance having
a token configured. This should help avoiding issues as within
3b434ed94d
that prevented the caretaker process momentarily.
Additionally, the Git client has moved from `index.ts` to
`git-client.ts` for better discoverability in the codebase.
PR Close #42468
53 lines
2.0 KiB
TypeScript
53 lines
2.0 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 * as yargs from 'yargs';
|
|
import {GitClient} from '../utils/git/git-client';
|
|
|
|
import {checkFiles, formatFiles} from './format';
|
|
|
|
/** Build the parser for the format commands. */
|
|
export function buildFormatParser(localYargs: yargs.Argv) {
|
|
return localYargs.help()
|
|
.strict()
|
|
.demandCommand()
|
|
.option('check', {
|
|
type: 'boolean',
|
|
default: process.env['CI'] ? true : false,
|
|
description: 'Run the formatter to check formatting rather than updating code format'
|
|
})
|
|
.command(
|
|
'all', 'Run the formatter on all files in the repository', args => args,
|
|
({check}) => {
|
|
const executionCmd = check ? checkFiles : formatFiles;
|
|
const allFiles = GitClient.get().allFiles();
|
|
executionCmd(allFiles);
|
|
})
|
|
.command(
|
|
'changed [shaOrRef]', 'Run the formatter on files changed since the provided sha/ref',
|
|
args => args.positional('shaOrRef', {type: 'string'}),
|
|
({shaOrRef, check}) => {
|
|
const sha = shaOrRef || 'master';
|
|
const executionCmd = check ? checkFiles : formatFiles;
|
|
const allChangedFilesSince = GitClient.get().allChangesFilesSince(sha);
|
|
executionCmd(allChangedFilesSince);
|
|
})
|
|
.command(
|
|
'staged', 'Run the formatter on all staged files', args => args,
|
|
({check}) => {
|
|
const executionCmd = check ? checkFiles : formatFiles;
|
|
const allStagedFiles = GitClient.get().allStagedFiles();
|
|
executionCmd(allStagedFiles);
|
|
})
|
|
.command(
|
|
'files <files..>', 'Run the formatter on provided files',
|
|
args => args.positional('files', {array: true, type: 'string'}), ({check, files}) => {
|
|
const executionCmd = check ? checkFiles : formatFiles;
|
|
executionCmd(files!);
|
|
});
|
|
}
|