bash-explainer 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/cli.js +175 -147
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -46,6 +46,7 @@ bash-explainer --check install.sh # constructs its shell (#!/bin/sh: dash…
|
|
|
46
46
|
| `--shell <name>` | the script's shell: `bash`, `sh`, `dash`, `ash`, `yash`, `ksh`, `mksh`, `zsh` (default: from the shebang or the file name) |
|
|
47
47
|
| `--kind <kind>` | what the file is: `shell`, `dockerfile`, `makefile`, `yaml`, `npm`, `markdown`, `python`, `jenkinsfile` (default: from the file name) |
|
|
48
48
|
| `--lang <en\|ja>` | language (default: from `LANG`) |
|
|
49
|
+
| `--sarif <file>` | with `--check`, also write the problems to this file as SARIF, whatever `--format` prints (so one run gives annotations and a SARIF file) |
|
|
49
50
|
| `--format <format>` | `text`, `markdown` or `json`; with `--check`, also `github` (annotations in GitHub Actions) or `sarif` (for code scanning) |
|
|
50
51
|
| `--no-examples` | leave out worked examples |
|
|
51
52
|
| `--config <file>` | read the settings from this file (see [Settings](#settings)) |
|