From 01004eabf94cfe04101bbc498cc578543a41693d Mon Sep 17 00:00:00 2001 From: PagoNxt-Trade <118373228+PagoNxt-Trade@users.noreply.github.com> Date: Mon, 19 Dec 2022 17:04:13 +0100 Subject: [PATCH] docs(cli): remove -s alias from docs --- docs/guides/2-cli.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/guides/2-cli.md b/docs/guides/2-cli.md index 772b614836..ee16525b5d 100644 --- a/docs/guides/2-cli.md +++ b/docs/guides/2-cli.md @@ -39,7 +39,7 @@ Other options include: --stdin-filepath path to a file to pretend that stdin comes from [string] --resolver path to custom json-ref-resolver instance [string] -r, --ruleset path/URL to a ruleset file [string] - --scoring-config path/URL to a scoring config file [string] + --scoring-config path/URL to a scoring config file [string] -F, --fail-severity results of this level or above will trigger a failure exit code [string] [choices: "error", "warn", "info", "hint"] [default: "error"] -D, --display-only-failures only output results equal to or greater than --fail-severity [boolean] [default: false] @@ -72,7 +72,7 @@ The scoring is produced in two different metrics: Also it introduces a quality gate, were an API scoring below the specific threshold will fail in a pipeline. -Enabling scoring is done using a new parameter called --scoring-config or -s and the scoring configuration file, where you can define how an error or a warning affects to the scoring +Enabling scoring is done using a new parameter called --scoring-config and the scoring configuration file, where you can define how an error or a warning affects to the scoring Usage: @@ -80,12 +80,6 @@ Usage: spectral lint ./reference/**/*.oas*.{json,yml,yaml} --ruleset mycustomruleset.js --scoring-config ./scoringFile.json ``` -or - -```bash -spectral lint ./reference/**/*.oas*.{json,yml,yaml} -r mycustomruleset.js -s ./scoringFile.json -``` - Heres an example of this scoringFile config file: ```