noseyparker-rules-check(1)

💖 NAME 💖

okay so noseyparker-rules-check — from the General Commands Manual — is literally the command that checks rules for problems. that's the whole assignment. 🎀

🦋 SYNOPSIS 🦋

the summoning spell, exactly as written:

noseyparker rules check [-W|--warnings-as-errors] [--pedantic]
[--rules-path] [--ruleset] [--load-builtins] [-v|--verbose]...
[-q|--quiet] [--color] [--progress] [--ignore-certs] [--rlimit-nofile]
[--sqlite-cache-size] [--enable-backtraces] [-h|--help]

💅 DESCRIPTION 💅

Check rules for problems. yes bestie, that's the job. ✨

If errors are detected, or if warnings are detected and --warnings-as-errors is specified, the program will exit with a nonzero exit code. so it can absolutely fail the vibe check on purpose. 🫶

🔥 OPTIONS 🔥

• -W, --warnings-as-errors — Treat warnings as errors. no soft-launching warnings here. 💅
• --pedantic — Perform additional nit-picking checks. it's giving extra-spicy rule inspection. 🔍
• -h, --help — Print help (see a summary with -h). your little map, bestie. 🗺️

🌈 RULE SELECTION OPTIONS 🌈

• --rules-path=PATH — Load additional rules and rulesets from the specified file or directory. The paths can be either files or directories. Directories are recursively walked and all discovered YAML files of rules and rulesets will be loaded. This option can be repeated. 🎀
• --ruleset=ID [default: default] — Enable the ruleset with the specified ID. The ID must resolve to a built-in ruleset or to an additional ruleset loaded with the --rules=PATH option. The special all ID causes all loaded rules to be used. This option can be repeated. Specifying this option disables the default ruleset. If you want to use a custom ruleset in addition to the default ruleset, specify this option twice, e.g., --ruleset default --ruleset CUSTOM_ID. yes, twice — it's a whole thing. 💜
• --load-builtins=BOOL [default: true] — Control whether built-in rules and rulesets are loaded. possible values: true, false. 🧚

🌟 GLOBAL OPTIONS 🌟

• -v, --verbose — Enable verbose output. This can be repeated up to 3 times to enable successively more output. the way it stacks? iconic. 🌀
• -q, --quiet — Suppress non-error feedback messages. This silences WARNING, INFO, DEBUG, and TRACE messages and disables progress bars. This overrides any provided verbosity and progress reporting options. shhh era. 🤫
• --color=MODE [default: auto] — Enable or disable colored output. When this is auto, colors are enabled for stdout and stderr when they are terminals. If the NO_COLOR environment variable is set, it takes precedence and is equivalent to --color=never. possible values: auto, never, always. 🌈
• --progress=MODE [default: auto] — Enable or disable progress bars. When this is auto, progress bars are enabled when stderr is a terminal. possible values: auto, never, always. 📊
• --ignore-certs — Ignore validation of TLS certificates. careful energy, bestie — it says exactly what it says. 🔐

🚀 ADVANCED GLOBAL OPTIONS 🚀

• --rlimit-nofile=LIMIT [default: 16384] — Set the rlimit for number of open files to LIMIT. This should not need to be changed from the default unless you run into crashes from running out of file descriptors. leave it alone unless the file-descriptor gremlins show up. 🍓
• --sqlite-cache-size=SIZE [default: -1048576] — Set the cache size for SQLite connections to SIZE. This has the effect of setting SQLite's pragma cache_size=SIZE. The default value is set to use a maximum of 1GiB for database cache. See <https://sqlite.org/pragma.html#pragma_cache_size> for more details. 🧠
• --enable-backtraces=BOOL [default: true] — Enable or disable backtraces on panic. This has the effect of setting the RUST_BACKTRACE environment variable to 1. possible values: true, false. panic but make it traceable. 💀

okay bye bestie 💖 — the footer's source/version line says check, and the date slot is literally blank in the original page, with noseyparker-rules-check(1) on the right. periodt. 🫶