📦 deps(thirdparty): update snapshots
This commit is contained in:
+98
@@ -0,0 +1,98 @@
|
||||
{
|
||||
"name": "mycmd",
|
||||
"summary": "One-line description of what this tool does.",
|
||||
"description": "Longer description: what it does, what it does not do, and when to use it.",
|
||||
"docsUrl": "https://example.com/docs/mycmd",
|
||||
"issuesUrl": "https://github.com/example/mycmd/issues",
|
||||
"outputModes": {
|
||||
"default": "human",
|
||||
"jsonFlag": "--json",
|
||||
"plainFlag": "--plain",
|
||||
"quietFlag": "--quiet",
|
||||
"verboseFlag": "--verbose",
|
||||
"debugFlag": "--debug",
|
||||
"noColorFlag": "--no-color",
|
||||
"noInputFlag": "--no-input",
|
||||
"dryRunFlag": "--dry-run",
|
||||
"forceFlag": "--force"
|
||||
},
|
||||
"streamsContract": {
|
||||
"stdout": "Primary output and machine-readable output.",
|
||||
"stderr": "Errors, warnings, progress, and status messages."
|
||||
},
|
||||
"exitCodes": [
|
||||
{ "code": 0, "meaning": "Success." },
|
||||
{ "code": 1, "meaning": "General failure." },
|
||||
{ "code": 2, "meaning": "Usage / invalid arguments." }
|
||||
],
|
||||
"config": {
|
||||
"precedenceHighToLow": [
|
||||
"flags",
|
||||
"env",
|
||||
"projectConfig",
|
||||
"userConfig",
|
||||
"systemConfig"
|
||||
],
|
||||
"xdg": true,
|
||||
"files": {
|
||||
"projectConfig": "./.mycmd.toml",
|
||||
"userConfig": "~/.config/mycmd/config.toml",
|
||||
"cacheDir": "~/.cache/mycmd/"
|
||||
},
|
||||
"env": [
|
||||
{ "name": "MYCMD_DEBUG", "purpose": "Enable verbose debug logging." },
|
||||
{ "name": "NO_COLOR", "purpose": "Disable ANSI color output." }
|
||||
]
|
||||
},
|
||||
"globalOptions": [
|
||||
{ "flags": ["-h", "--help"], "description": "Show help and exit." },
|
||||
{ "flags": ["--version"], "description": "Show version and exit." }
|
||||
],
|
||||
"commands": [
|
||||
{
|
||||
"name": "example",
|
||||
"summary": "Describe what this command does.",
|
||||
"usage": "mycmd example [options] <arg>",
|
||||
"args": [
|
||||
{
|
||||
"name": "arg",
|
||||
"required": true,
|
||||
"description": "What this argument is."
|
||||
}
|
||||
],
|
||||
"options": [
|
||||
{
|
||||
"flags": ["-o", "--output"],
|
||||
"value": "PATH",
|
||||
"description": "Write output to PATH (or '-' for stdout)."
|
||||
}
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"description": "Basic example.",
|
||||
"command": "mycmd example ./input.txt"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"safety": {
|
||||
"boundaryCrossingActions": [
|
||||
"Network calls",
|
||||
"Writing files not explicitly passed",
|
||||
"Mutating remote state"
|
||||
],
|
||||
"destructiveActions": [
|
||||
{
|
||||
"action": "delete-project",
|
||||
"dangerLevel": "severe",
|
||||
"interactiveConfirmation": "type the project name",
|
||||
"nonInteractiveConfirmation": "--confirm=\"project-name\"",
|
||||
"supportsDryRun": true
|
||||
}
|
||||
],
|
||||
"secrets": {
|
||||
"neverAcceptVia": ["flags", "environment variables"],
|
||||
"preferAcceptVia": ["stdin", "file", "OS keychain", "secret manager"]
|
||||
}
|
||||
}
|
||||
}
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
# Error Message Template
|
||||
|
||||
## Goals
|
||||
|
||||
- *Human readable first*: describe the problem in plain language.
|
||||
- *Actionable*: include the next step (flag, file path, permission change, docs link).
|
||||
- *Low noise*: avoid stack traces in normal mode.
|
||||
- *Correct stream*: errors go to `stderr`.
|
||||
- *Correct exit code*: non-zero.
|
||||
|
||||
## Pattern
|
||||
|
||||
```text
|
||||
Error: <what failed in plain language>
|
||||
Cause: <most likely cause, if known> (optional)
|
||||
Fix: <what the user should do next>
|
||||
Hint: <related command / docs> (optional)
|
||||
|
||||
For more help: mycmd <subcmd> --help
|
||||
Docs: <https://example.com/docs/...> (optional)
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
### Missing required argument
|
||||
|
||||
```text
|
||||
Error: missing required argument <path>
|
||||
Fix: pass a path, or run: mycmd upload --help
|
||||
```
|
||||
|
||||
### Permission error with actionable fix
|
||||
|
||||
```text
|
||||
Error: can't write to /var/log/mycmd/output.txt
|
||||
Fix: choose a writable location, or run: chmod u+w /var/log/mycmd/output.txt
|
||||
```
|
||||
|
||||
### Unknown flag (with suggestion)
|
||||
|
||||
```text
|
||||
Error: unknown option: --jon
|
||||
Fix: did you mean --json ?
|
||||
For more help: mycmd --help
|
||||
```
|
||||
|
||||
### Unexpected error (debug path)
|
||||
|
||||
```text
|
||||
Error: unexpected failure while reading config
|
||||
Fix: re-run with --debug, and include the log in a bug report
|
||||
Issues: https://github.com/example/mycmd/issues/new
|
||||
```
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
# Help Text Template
|
||||
|
||||
Use this as a skeleton for `mycmd --help` (plain text, scan-friendly).
|
||||
|
||||
```text
|
||||
mycmd — <one-line summary>
|
||||
|
||||
USAGE
|
||||
mycmd <command> [options]
|
||||
mycmd <command> --help
|
||||
|
||||
DESCRIPTION
|
||||
<what this tool does, and when to use it>
|
||||
<what it does NOT do (optional, but helpful for setting expectations)>
|
||||
|
||||
EXAMPLES
|
||||
# <most common use case>
|
||||
mycmd <command> <args>
|
||||
|
||||
# <machine-readable output>
|
||||
mycmd <command> --json
|
||||
|
||||
COMMANDS
|
||||
<command> <short summary>
|
||||
<command> <short summary>
|
||||
help [command] Show help for a command (optional)
|
||||
|
||||
OPTIONS
|
||||
-h, --help Show help and exit
|
||||
--version Show version and exit
|
||||
--json Output structured JSON
|
||||
--plain Output stable plain text (one record per line)
|
||||
--no-color Disable ANSI color output
|
||||
--no-input Disable prompts; fail if required input is missing
|
||||
-q, --quiet Reduce non-essential output
|
||||
-v, --verbose Increase output detail
|
||||
-d, --debug Enable debug logging
|
||||
-n, --dry-run Describe changes without applying them
|
||||
-f, --force Skip confirmations / force the action
|
||||
|
||||
ENVIRONMENT
|
||||
NO_COLOR Disable color output
|
||||
MYCMD_DEBUG Enable debug logging (equivalent to --debug)
|
||||
|
||||
DOCUMENTATION
|
||||
Docs: <https://example.com/docs/mycmd>
|
||||
Issues: <https://github.com/example/mycmd/issues>
|
||||
```
|
||||
Reference in New Issue
Block a user