Skip to content

Commit 5d193ac

Browse files
authored
refactor: improve output messages (#404)
`Remove --check option to avoid this error` is a little ambiguous (e.g., will it just suppress the error). Updated to let the user know what will happen if they remove it. ```sh $ npx codeowners-generator generate --check Custom configuration found in /Users/jared.mcateer/Projects/test/package.json ✖ We encountered an error: We found differences between the existing codeowners file and the generated rules. Remove --check option to fix this. ``` Added message for when `--check` is successful, rather than telling the user the file was created, which should not happen with that command. ```sh $ npx codeowners-generator generate --check Custom configuration found in /Users/jared.mcateer/Projects/test/package.json CODEOWNERS file up to date! location: .github/CODEOWNERS ``` 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). ```sh $ npx codeowners-generator generate Custom configuration found in /Users/jared.mcateer/Projects/test/package.json CODEOWNERS file updated with the generated rules! location: .github/CODEOWNERS ````
1 parent 03bf4f5 commit 5d193ac

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/commands/generate.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,13 +157,14 @@ export const command = async (options: Options, command: Command): Promise<void>
157157
if (check) {
158158
if (originalContent.trimEnd() !== newContent) {
159159
throw new Error(
160-
'We found differences between the existing codeowners file and the generated. Remove --check option to avoid this error'
160+
'We found differences between the existing codeowners file and the generated rules. Remove --check option to fix this.'
161161
);
162162
}
163163
} else {
164164
fs.writeFileSync(output, newContent);
165165
}
166-
loader.stopAndPersist({ text: `CODEOWNERS file was created! location: ${output}`, symbol: SUCCESS_SYMBOL });
166+
const message = check ? `up to date` : 'updated with the generated rules';
167+
loader.stopAndPersist({ text: `CODEOWNERS file ${message}! location: ${output}`, symbol: SUCCESS_SYMBOL });
167168
} else {
168169
const includes = globalOptions.includes?.length ? globalOptions.includes : INCLUDES;
169170
loader.stopAndPersist({

0 commit comments

Comments
 (0)