Skip to content

Commit

Permalink
refactor: improve output messages
Browse files Browse the repository at this point in the history
'Remove -check option to avoid this error' is a little ambiguous (e.g.,
will it just supress the error). Updated to let the user know what will
happen if they remove it.

Added message for when --check is successful, rather than telling the
user the file was created, which should not happen by that command.

Changed message for when new generated rules change the CO file, rather
than saying a file was created, let them know the generated rules have
changed. A CO file being created should be incredibly rare (i.e., maybe
the first time this tool is run in a project).
  • Loading branch information
jaredmcateer committed Oct 7, 2024
1 parent 64d7089 commit c962b56
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/commands/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,14 @@ export const command = async (options: Options, command: Command): Promise<void>
if (check) {
if (originalContent.trimEnd() !== newContent) {
throw new Error(
'We found differences between the existing codeowners file and the generated. Remove --check option to avoid this error'
'We found differences between the existing codeowners file and the generated rules. Remove --check option to fix this.'
);
}
} else {
fs.writeFileSync(output, newContent);
}
loader.stopAndPersist({ text: `CODEOWNERS file was created! location: ${output}`, symbol: SUCCESS_SYMBOL });
const message = check ? `up to date` : 'updated with the generated rules';
loader.stopAndPersist({ text: `CODEOWNERS file ${message}! location: ${output}`, symbol: SUCCESS_SYMBOL });
} else {
const includes = globalOptions.includes?.length ? globalOptions.includes : INCLUDES;
loader.stopAndPersist({
Expand Down

0 comments on commit c962b56

Please sign in to comment.