Cursor rule

1---
2description: Enforce general Bash scripting standards with enhanced logging
3globs: 
4---
5# Enhanced Bash Scripting Standard with Colorized Logging
6 
7This rule enforces best practices for writing Bash scripts, with an emphasis on using colorized logging for better output readability.
8 
9## Rule Details
10 
11- **Name:** enhanced_bash_style
12 
13- **Description:** Enforce Bash scripting standards with colorized logging
14 
15## Filters
16- file extension pattern: `\\.sh$`
17 
18## Enforcement Checks
19- Conditions:
20  - pattern `^#!/usr/bin/env bash$` – All scripts should start with the shebang '#!/usr/bin/env bash'.
21  - pattern `^set -eu$` – Enable 'set -eu' for script robustness.
22  - pattern `^set -x$` – negated `^\\[ \"\\${DEBUG-}\" = \"1\" ] && set -x$` – Use conditional 'set -x' based on debug flag.
23  - pattern `^# @formatter:off$` – Start of formatting block for log functions.
24  - pattern `note\\(\\) { printf \"       %s\\n\" \"\\${1}\"; }$` – Include 'note' function for plain messages.
25  - pattern `info\\(\\) { \\[ \"\\${TERM:-}\" != \"dumb\" ] && tput colors >/dev/null 2>&1 && printf \"\\\\033\\[34m\\[INFO] %s\\\\033\\[0m\\n\" \"\\${1}\" || printf \"\\[INFO] %s\\n\" \"\\${1}\"; }$` – Include 'info' function for blue informational messages.
26  - pattern `pass\\(\\) { \\[ \"\\${TERM:-}\" != \"dumb\" ] && tput colors >/dev/null 2>&1 && printf \"\\\\033\\[32m\\[ OK ] %s\\\\033\\[0m\\n\" \"\\${1}\" || printf \"\\[ OK ] %s\\n\" \"\\${1}\"; }$` – Include 'pass' function for green success messages.
27  - pattern `fail\\(\\) { \\[ \"\\${TERM:-}\" != \"dumb\" ] && tput colors >/dev/null 2>&1 && printf \"\\\\033\\[31m\\[FAIL] %s\\\\033\\[0m\\n\" \"\\${1}\" || printf \"\\[FAIL] %s\\n\" \"\\${1}\"; }$` – Include 'fail' function for red error messages.
28  - pattern `warn\\(\\) { \\[ \"\\${TERM:-}\" != \"dumb\" ] && tput colors >/dev/null 2>&1 && printf \"\\\\033\\[33m\\[WARN] %s\\\\033\\[0m\\n\" \"\\${1}\" || printf \"\\[WARN] %s\\n\" \"\\${1}\"; }$` – Include 'warn' function for yellow warning messages.
29  - pattern `^# @formatter:on$` – End of formatting block for log functions.
30 
31## Suggestions
32- Guidance:
33**Bash Scripting Best Practices:**
34- **Error Handling:** Use `set -eu` to catch errors and undefined variables early.
35- **Debugging:** Implement conditional debugging with `set -x` using a DEBUG variable.
36- **Logging Functions:** Use colorized logging for better script output readability:
37  - `note()` for plain notes
38  - `info()` for blue informational messages
39  - `pass()` for green success messages
40  - `fail()` for red error messages
41  - `warn()` for yellow warnings, ensuring users can distinguish different types of messages easily
42- **Security:** Avoid using `eval` or similar constructs; use safe alternatives.
43- **Documentation:** Include descriptive comments, especially for complex logic.
44- **Portability:** Use `/usr/bin/env bash` for the shebang to ensure script runs with bash on any system.
45- **Variable Checks:** Ensure necessary variables are set, enhancing script reliability.
46- **Exit Codes:** Use explicit exit codes for different failure scenarios.
47- **Color Support:** Ensure logging functions check for terminal color support before applying colors.
48 
49## Metadata
50- Priority: medium
51- Version: 1.2
52