📣 [just] add compliance check #3
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a compliance check target into the justfile to ensure that key repository files are present, promoting standardization.
- Adds a new compliance check group under the "Compliance" target.
- Checks for the presence of key files such as README.md, LICENSE, and various GitHub support files.
| #!/usr/bin/env bash | ||
| set -euo pipefail # strict mode without tracing | ||
|
|
||
| echo "{{BLUE}}Chicks' repo compliance check...{{NORMAL}}" |
There was a problem hiding this comment.
[nitpick] Consider revising the message tone to be more neutral and professional; the phrase may be interpreted as unprofessional in some contexts.
| echo "{{BLUE}}Chicks' repo compliance check...{{NORMAL}}" | |
| echo "{{BLUE}}Repository compliance check...{{NORMAL}}" |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
True, but that's fine with me.
| fi | ||
|
|
||
| if [[ $(gh repo view --json description | jq -r '.description' | wc -c) -gt 16 ]]; then | ||
| echo "{{GREEN}}[gh] You have a repo description, more evidence that you are undescribable.{{NORMAL}}" |
There was a problem hiding this comment.
[nitpick] Consider a more straightforward status message; the current wording has a whimsical tone that might not be ideal for professional compliance checks.
| echo "{{GREEN}}[gh] You have a repo description, more evidence that you are undescribable.{{NORMAL}}" | |
| echo "{{GREEN}}[gh] You have a repository description, which is a good practice.{{NORMAL}}" |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Fair, but the brand is all about being a professional with whimsy.
| if [[ -e .gitignore ]]; then | ||
| echo "{{GREEN}}You have a .gitignore file, so there will be less debris in your future.{{NORMAL}}" | ||
| else | ||
| echo "{{RED}}You do NOT have a .gitignore file. I expect you to keep ignoring my advice!{{NORMAL}}" |
There was a problem hiding this comment.
[nitpick] Consider modifying the tone of this message to be more neutral; humorous admonishments may not be received positively by all users.
| echo "{{RED}}You do NOT have a .gitignore file. I expect you to keep ignoring my advice!{{NORMAL}}" | |
| echo "{{RED}}You do NOT have a .gitignore file. Please consider adding one to manage ignored files effectively.{{NORMAL}}" |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
I'm sticking with humor here.
| echo "{{RED}}You do NOT have a justfile. Feeling the FOMO yet?{{NORMAL}}" | ||
| echo "{{RED}}And this should not be possible. Tell me how you got here.{{NORMAL}}" |
There was a problem hiding this comment.
[nitpick] Revise this message to remove the playful tone and adopt a neutral, informative tone for error reporting.
| echo "{{RED}}You do NOT have a justfile. Feeling the FOMO yet?{{NORMAL}}" | |
| echo "{{RED}}And this should not be possible. Tell me how you got here.{{NORMAL}}" | |
| echo "{{RED}}You do NOT have a justfile.{{NORMAL}}" | |
| echo "{{RED}}Error: The justfile is missing. This script requires a justfile to function correctly.{{NORMAL}}" |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
What if I want to be less neutral and more playful?
Done:
(Automated in
justfile.)