Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: improve output messages #404

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jaredmcateer
Copy link

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.

$ 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.

$ 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).

$ 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

'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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant