From 94eb106552c501c27233035d4be7b54a20e07e2b Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 16 Nov 2023 15:43:59 +0100 Subject: [PATCH 1/2] docs: fix typos Signed-off-by: Jan Kowalleck --- HISTORY.md | 3 +++ README.md | 2 +- src/cli.ts | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 2f910fc57..7220fce65 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -6,8 +6,11 @@ All notable changes to this project will be documented in this file. * Fixed * Added direct dependency `packageurl-js` as such (via [#1122]) +* Docs + * Fixed typos (via [#]) [#1122]: https://github.com/CycloneDX/cyclonedx-node-npm/pull/1122 +[#]: ## 1.14.2 - 2023-11-06 diff --git a/README.md b/README.md index 401f20e8b..210b4969c 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Options: This means the actual nesting of node packages is not represented in the SBOM result. (default: false) --short-PURLs Omit all qualifiers from PackageURLs. - This causes information loss in trade of shorter PURLs, which might improve digesting these strings. + This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings. (default: false) --spec-version Which version of CycloneDX spec to use. (choices: "1.2", "1.3", "1.4", "1.5", default: "1.4") diff --git a/src/cli.ts b/src/cli.ts index 0efac1243..45e2b6a42 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -93,7 +93,7 @@ function makeCommand (process: NodeJS.Process): Command { new Option( '--short-PURLs', 'Omit all qualifiers from PackageURLs.\n' + - 'This causes information loss in trade of shorter PURLs, which might improve digesting these strings.' + 'This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.' ).default(false) ).addOption( new Option( From 6727a8061b8f08a883f6f759a18d73bbc8b47d9a Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 16 Nov 2023 15:47:30 +0100 Subject: [PATCH 2/2] docs Signed-off-by: Jan Kowalleck --- HISTORY.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 7220fce65..f04174a0e 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -7,10 +7,10 @@ All notable changes to this project will be documented in this file. * Fixed * Added direct dependency `packageurl-js` as such (via [#1122]) * Docs - * Fixed typos (via [#]) + * Fixed typos (via [#1123]) [#1122]: https://github.com/CycloneDX/cyclonedx-node-npm/pull/1122 -[#]: +[#1123]: https://github.com/CycloneDX/cyclonedx-node-npm/pull/1123 ## 1.14.2 - 2023-11-06