Skip to content

Commit

Permalink
docs: Update the options usage description
Browse files Browse the repository at this point in the history
  • Loading branch information
RSeidelsohn committed Apr 15, 2023
1 parent b8cbb84 commit 62f95a1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,12 +170,12 @@ before.
## All options in alphabetical order:

- `--angularCli` is just a synonym for `--plainVertical`
- `--clarificationsFile` A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. The clarifications file can also be used to specify a subregion of a package's license file (instead reading the entire file).
- `--clarificationsFile [filepath]` A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. The clarifications file can also be used to specify a subregion of a package's license file (instead reading the entire file).
- `--csv` output in csv format.
- `--csvComponentPrefix` prefix column for component in csv format.
- `--customPath` to add a custom Format file in JSON
- `--development` only show development dependencies.
- `--direct` look for direct dependencies only
- `--direct [boolean|number]` look for direct dependencies only if "true" or look for "number" of levels of dependencies
- `--excludeLicenses [list]` exclude modules which licenses are in the comma-separated list from the output
- `--excludePackages [list]` restrict output to the packages (either "package@fullversion" or "package@majorversion" or only "package") not in the semicolon-seperated list
- `--excludePackagesStartingWith [list]` exclude modules which names start with the comma-separated list from the output (useful for excluding modules from a specific vendor and such). Example: `--excludePackagesStartingWith "webpack;@types;@babel"`
Expand Down
4 changes: 2 additions & 2 deletions lib/usageMessage.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ const usageMessage = [
'All options in alphabetical order:',
'',
' --angularCli is just a synonym for --plainVertical',
" --clarificationsFile A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. Can also be used to specify a subregion of a package's license file (instead reading the entire file).",
" --clarificationsFile [filepath] A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. Can also be used to specify a subregion of a package's license file (instead reading the entire file).",
' --csv output in csv format.',
' --csvComponentPrefix column prefix for components in csv file',
' --customPath to add a custom Format file in JSON',
' --development only show development dependencies.',
' --direct look for direct dependencies only',
' --direct [boolean|number] look for direct dependencies only if "true" or look for "number" of levels of dependencies',
' --excludeLicenses [list] exclude modules which licenses are in the comma-separated list from the output',
' --excludePackages [list] restrict output to the packages (either "package@fullversion" or "package@majorversion" or only "package") not in the semicolon-seperated list',
' --excludePackageStartingWith [list] excludes packages starting with anything the comma-separated list',
Expand Down

0 comments on commit 62f95a1

Please sign in to comment.