Skip to content

Commit

Permalink
test(cmd/root): fixup topics/docs tests
Browse files Browse the repository at this point in the history 
Signed-off-by: Leonardo Di Donato <[email protected]>
  • Loading branch information
@leodido
leodido committed Apr 24, 2024
1 parent 8a0f691 commit 2cd51ea
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion cmd/root/root_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ func (suite *CmdAdditionalHelpSuite) SetupSuite() {

suite.expectedOuts[Environment] = "# lstn environment variables\n\nThe environment variables override any corresponding configuration setting.\n\nBut flags override them.\n\n`LSTN_GH_OWNER`: set the GitHub owner name (org|user)\n\n`LSTN_GH_PULL_ID`: set the GitHub pull request ID\n\n`LSTN_GH_REPO`: set the GitHub repository name\n\n`LSTN_GH_TOKEN`: set the GitHub token\n\n`LSTN_IGNORE_DEPTYPES`: the list of dependencies types to not process\n\n`LSTN_IGNORE_PACKAGES`: the list of packages to not process\n\n`LSTN_JWT_TOKEN`: set the listen.dev auth token\n\n`LSTN_LOCKFILES`: set one or more lock file paths (relative to the working dir) to lookup for\n\n`LSTN_LOGLEVEL`: set the logging level\n\n`LSTN_NPM_ENDPOINT`: the listen.dev endpoint emitting the NPM verdicts\n\n`LSTN_NPM_REGISTRY`: set a custom NPM registry\n\n`LSTN_PYPI_ENDPOINT`: the listen.dev endpoint emitting the PyPi verdicts\n\n`LSTN_REPORTER`: set one or more reporters to use\n\n`LSTN_SELECT`: filter the output verdicts using a jsonpath script expression (server-side)\n\n`LSTN_TIMEOUT`: set the timeout, in seconds\n\n"

suite.expectedOuts[Manual] = "# lstn cheatsheet\n\n## Global Flags\n\nEvery child command inherits the following flags:\n\n```\n--config string config file (default is $HOME/.lstn.yaml)\n```\n\n## `lstn ci`\n\nListen in on what your CI does.\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Token Flags\n\n```\n--gh-token string set the GitHub token\n--jwt-token string set the listen.dev auth token\n```\n\n## `lstn completion <bash|fish|powershell|zsh>`\n\nGenerate the autocompletion script for the specified shell.\n\n### `lstn completion bash`\n\nGenerate the autocompletion script for bash.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n### `lstn completion fish [flags]`\n\nGenerate the autocompletion script for fish.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n### `lstn completion powershell [flags]`\n\nGenerate the autocompletion script for powershell.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n### `lstn completion zsh [flags]`\n\nGenerate the autocompletion script for zsh.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n## `lstn config`\n\nDetails about the ~/.lstn.yaml config file.\n\n## `lstn environment`\n\nWhich environment variables you can use with lstn.\n\n## `lstn exit`\n\nDetails about the lstn exit codes.\n\n## `lstn help [command]`\n\nHelp about any command.\n\n## `lstn in [path]`\n\nInspect the verdicts for your dependencies tree.\n\n### Flags\n\n```\n --json output the verdicts (if any) in JSON form\n-l, --lockfiles strings set one or more lock file paths (relative to the working dir) to lookup for (default [package-lock.json,poetry.lock])\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--npm-endpoint string the listen.dev endpoint emitting the NPM verdicts (default \"https://npm.listen.dev\")\n--pypi-endpoint string the listen.dev endpoint emitting the PyPi verdicts (default \"https://pypi.listen.dev\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Filtering Flags\n\n```\n-q, --jq string filter the output verdicts using a jq expression (requires --json)\n```\n\n### Registry Flags\n\n```\n--npm-registry string set a custom NPM registry (default \"https://registry.npmjs.org\")\n```\n\n### Reporting Flags\n\n```\n --gh-owner string set the GitHub owner name (org|user)\n --gh-pull-id int set the GitHub pull request ID\n --gh-repo string set the GitHub repository name\n-r, --reporter (gh-pull-check,gh-pull-comment,gh-pull-review,pro) set one or more reporters to use (default [])\n```\n\n### Token Flags\n\n```\n--gh-token string set the GitHub token\n--jwt-token string set the listen.dev auth token\n```\n\nFor example:\n\n```bash\nlstn in\nlstn in .\nlstn in /we/snitch\nlstn in sub/dir\nlstn in --lockfiles poetry.lock,package-lock.json\nlstn in /pyproj --lockfiles poetry.lock\n```\n\n## `lstn manual`\n\nA comprehensive reference of all the lstn commands.\n\n## `lstn reporters`\n\nA comprehensive guide to the `lstn` reporting mechanisms.\n\n## `lstn scan [path]`\n\nInspect the verdicts for your direct dependencies.\n\n### Flags\n\n```\n--json output the verdicts (if any) in JSON form\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--npm-endpoint string the listen.dev endpoint emitting the NPM verdicts (default \"https://npm.listen.dev\")\n--pypi-endpoint string the listen.dev endpoint emitting the PyPi verdicts (default \"https://pypi.listen.dev\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Filtering Flags\n\n```\n --ignore-deptypes (dep,dev,optional,peer) the list of dependencies types to not process (default [bundle])\n --ignore-packages strings the list of packages to not process\n-q, --jq string filter the output verdicts using a jq expression (requires --json)\n-s, --select string filter the output verdicts using a jsonpath script expression (server-side)\n```\n\n### Registry Flags\n\n```\n--npm-registry string set a custom NPM registry (default \"https://registry.npmjs.org\")\n```\n\n### Reporting Flags\n\n```\n --gh-owner string set the GitHub owner name (org|user)\n --gh-pull-id int set the GitHub pull request ID\n --gh-repo string set the GitHub repository name\n-r, --reporter (gh-pull-check,gh-pull-comment,gh-pull-review,pro) set one or more reporters to use (default [])\n```\n\n### Token Flags\n\n```\n--gh-token string set the GitHub token\n```\n\nFor example:\n\n```bash\nlstn scan\nlstn scan .\nlstn scan sub/dir\nlstn scan /we/snitch\nlstn scan /we/snitch --ignore-deptypes peer\nlstn scan /we/snitch --ignore-deptypes dev,peer\nlstn scan /we/snitch --ignore-deptypes dev --ignore-deptypes peer\nlstn scan /we/snitch --ignore-packages react,glob --ignore-deptypes peer\nlstn scan /we/snitch --ignore-packages react --ignore-packages glob,@vue/devtools\n```\n\n## `lstn to <name> [[version] [shasum] | [version constraint]]`\n\nGet the verdicts of a package.\n\n### Flags\n\n```\n--json output the verdicts (if any) in JSON form\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--npm-endpoint string the listen.dev endpoint emitting the NPM verdicts (default \"https://npm.listen.dev\")\n--pypi-endpoint string the listen.dev endpoint emitting the PyPi verdicts (default \"https://pypi.listen.dev\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Filtering Flags\n\n```\n-q, --jq string filter the output verdicts using a jq expression (requires --json)\n-s, --select string filter the output verdicts using a jsonpath script expression (server-side)\n```\n\n### Registry Flags\n\n```\n--npm-registry string set a custom NPM registry (default \"https://registry.npmjs.org\")\n```\n\nFor example:\n\n```bash\n# Get the verdicts for all the chalk versions that listen.dev owns\nlstn to chalk\nlstn to debug 4.3.4\nlstn to react 18.0.0 b468736d1f4a5891f38585ba8e8fb29f91c3cb96\n\n# Get the verdicts for all the existing chalk versions\nlstn to chalk \"*\"\n# Get the verdicts for nock versions >= 13.2.0 and < 13.3.0\nlstn to nock \"~13.2.x\"\n# Get the verdicts for tap versions >= 16.3.0 and < 16.4.0\nlstn to tap \"^16.3.0\"\n# Get the verdicts for prettier versions >= 2.7.0 <= 3.0.0\nlstn to prettier \">=2.7.0 <=3.0.0\"\n```\n\n## `lstn version`\n\nPrint out version information.\n\n### Flags\n\n```\n-v, -- count increment the verbosity level\n --changelog output the relase notes URL\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n"
suite.expectedOuts[Manual] = "# lstn cheatsheet\n\n## Global Flags\n\nEvery child command inherits the following flags:\n\n```\n--config string config file (default is $HOME/.lstn.yaml)\n```\n\n## `lstn ci`\n\nListen in on what your CI does.\n\n### Flags\n\n```\n--dir string the directory where the argus binary is\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Token Flags\n\n```\n--gh-token string set the GitHub token\n--jwt-token string set the listen.dev auth token\n```\n\n## `lstn completion <bash|fish|powershell|zsh>`\n\nGenerate the autocompletion script for the specified shell.\n\n### `lstn completion bash`\n\nGenerate the autocompletion script for bash.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n### `lstn completion fish [flags]`\n\nGenerate the autocompletion script for fish.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n### `lstn completion powershell [flags]`\n\nGenerate the autocompletion script for powershell.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n### `lstn completion zsh [flags]`\n\nGenerate the autocompletion script for zsh.\n\n#### Flags\n\n```\n--no-descriptions disable completion descriptions\n```\n\n## `lstn config`\n\nDetails about the ~/.lstn.yaml config file.\n\n## `lstn environment`\n\nWhich environment variables you can use with lstn.\n\n## `lstn exit`\n\nDetails about the lstn exit codes.\n\n## `lstn help [command]`\n\nHelp about any command.\n\n## `lstn in [path]`\n\nInspect the verdicts for your dependencies tree.\n\n### Flags\n\n```\n --json output the verdicts (if any) in JSON form\n-l, --lockfiles strings set one or more lock file paths (relative to the working dir) to lookup for (default [package-lock.json,poetry.lock])\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--npm-endpoint string the listen.dev endpoint emitting the NPM verdicts (default \"https://npm.listen.dev\")\n--pypi-endpoint string the listen.dev endpoint emitting the PyPi verdicts (default \"https://pypi.listen.dev\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Filtering Flags\n\n```\n-q, --jq string filter the output verdicts using a jq expression (requires --json)\n```\n\n### Registry Flags\n\n```\n--npm-registry string set a custom NPM registry (default \"https://registry.npmjs.org\")\n```\n\n### Reporting Flags\n\n```\n --gh-owner string set the GitHub owner name (org|user)\n --gh-pull-id int set the GitHub pull request ID\n --gh-repo string set the GitHub repository name\n-r, --reporter (gh-pull-check,gh-pull-comment,gh-pull-review,pro) set one or more reporters to use (default [])\n```\n\n### Token Flags\n\n```\n--gh-token string set the GitHub token\n--jwt-token string set the listen.dev auth token\n```\n\nFor example:\n\n```bash\nlstn in\nlstn in .\nlstn in /we/snitch\nlstn in sub/dir\nlstn in --lockfiles poetry.lock,package-lock.json\nlstn in /pyproj --lockfiles poetry.lock\n```\n\n## `lstn manual`\n\nA comprehensive reference of all the lstn commands.\n\n## `lstn reporters`\n\nA comprehensive guide to the `lstn` reporting mechanisms.\n\n## `lstn scan [path]`\n\nInspect the verdicts for your direct dependencies.\n\n### Flags\n\n```\n--json output the verdicts (if any) in JSON form\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--npm-endpoint string the listen.dev endpoint emitting the NPM verdicts (default \"https://npm.listen.dev\")\n--pypi-endpoint string the listen.dev endpoint emitting the PyPi verdicts (default \"https://pypi.listen.dev\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Filtering Flags\n\n```\n --ignore-deptypes (dep,dev,optional,peer) the list of dependencies types to not process (default [bundle])\n --ignore-packages strings the list of packages to not process\n-q, --jq string filter the output verdicts using a jq expression (requires --json)\n-s, --select string filter the output verdicts using a jsonpath script expression (server-side)\n```\n\n### Registry Flags\n\n```\n--npm-registry string set a custom NPM registry (default \"https://registry.npmjs.org\")\n```\n\n### Reporting Flags\n\n```\n --gh-owner string set the GitHub owner name (org|user)\n --gh-pull-id int set the GitHub pull request ID\n --gh-repo string set the GitHub repository name\n-r, --reporter (gh-pull-check,gh-pull-comment,gh-pull-review,pro) set one or more reporters to use (default [])\n```\n\n### Token Flags\n\n```\n--gh-token string set the GitHub token\n```\n\nFor example:\n\n```bash\nlstn scan\nlstn scan .\nlstn scan sub/dir\nlstn scan /we/snitch\nlstn scan /we/snitch --ignore-deptypes peer\nlstn scan /we/snitch --ignore-deptypes dev,peer\nlstn scan /we/snitch --ignore-deptypes dev --ignore-deptypes peer\nlstn scan /we/snitch --ignore-packages react,glob --ignore-deptypes peer\nlstn scan /we/snitch --ignore-packages react --ignore-packages glob,@vue/devtools\n```\n\n## `lstn to <name> [[version] [shasum] | [version constraint]]`\n\nGet the verdicts of a package.\n\n### Flags\n\n```\n--json output the verdicts (if any) in JSON form\n```\n\n### Config Flags\n\n```\n--loglevel string set the logging level (default \"info\")\n--npm-endpoint string the listen.dev endpoint emitting the NPM verdicts (default \"https://npm.listen.dev\")\n--pypi-endpoint string the listen.dev endpoint emitting the PyPi verdicts (default \"https://pypi.listen.dev\")\n--timeout int set the timeout, in seconds (default 60)\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n### Filtering Flags\n\n```\n-q, --jq string filter the output verdicts using a jq expression (requires --json)\n-s, --select string filter the output verdicts using a jsonpath script expression (server-side)\n```\n\n### Registry Flags\n\n```\n--npm-registry string set a custom NPM registry (default \"https://registry.npmjs.org\")\n```\n\nFor example:\n\n```bash\n# Get the verdicts for all the chalk versions that listen.dev owns\nlstn to chalk\nlstn to debug 4.3.4\nlstn to react 18.0.0 b468736d1f4a5891f38585ba8e8fb29f91c3cb96\n\n# Get the verdicts for all the existing chalk versions\nlstn to chalk \"*\"\n# Get the verdicts for nock versions >= 13.2.0 and < 13.3.0\nlstn to nock \"~13.2.x\"\n# Get the verdicts for tap versions >= 16.3.0 and < 16.4.0\nlstn to tap \"^16.3.0\"\n# Get the verdicts for prettier versions >= 2.7.0 <= 3.0.0\nlstn to prettier \">=2.7.0 <=3.0.0\"\n```\n\n## `lstn version`\n\nPrint out version information.\n\n### Flags\n\n```\n-v, -- count increment the verbosity level\n --changelog output the relase notes URL\n```\n\n### Debug Flags\n\n```\n--debug-options output the options, then exit\n```\n\n"

suite.expectedOuts[Exit] = "The lstn CLI follows the usual conventions regarding exit codes.\n\nMeaning:\n\n* when a command completes successfully, the exit code will be 0\n\n* when a command fails for any reason, the exit code will be 1\n\n* when a command is running but gets cancelled, the exit code will be 2\n\n* when a command meets an authentication issue, the exit code will be 4\n\nNotice that it's possible that a particular command may have more exit codes,\nso it's a good practice to check the docs for the specific command\nin case you're relying on the exit codes to control some behaviour.\n"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/cheatsheet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Listen in on what your CI does.
### Flags

```
--dir string the directory where Argus binary is
--dir string the directory where the argus binary is
```

### Config Flags
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/options/ci.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ var _ cmd.CommandOptions = (*Ci)(nil)
type Ci struct {
flags.ConfigFlags
flags.DebugFlags `flagset:"Debug"`
Directory string `flag:"dir" name:"dir" desc:"the directory where Argus binary is" validate:"omitempty,dir" json:"argusdir"`
Directory string `flag:"dir" name:"dir" desc:"the directory where the argus binary is" validate:"omitempty,dir" json:"argusdir"`
}

func NewCi() (*Ci, error) {
Expand Down

0 comments on commit 2cd51ea

Please sign in to comment.