From 49e45b946c6ad41c295252d49a62f21dae6a459e Mon Sep 17 00:00:00 2001 From: Artem Muterko Date: Thu, 26 Mar 2026 19:24:39 +0100 Subject: [PATCH] fix: correct typos and update examples README Signed-off-by: Artem Muterko --- README.md | 2 +- cmd/syft/internal/ui/ui.go | 2 +- examples/README.md | 4 +++- syft/pkg/cataloger/dotnet/parse_packages_lock.go | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b5e57d0ca37..acf888e34b5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@  Go Report Card   GitHub release   GitHub go.mod Go version  -  License: Apache-2.0  +  License: Apache-2.0   Join our Discourse   Follow on Mastodon 

diff --git a/cmd/syft/internal/ui/ui.go b/cmd/syft/internal/ui/ui.go index e0354b5831a..193768c5183 100644 --- a/cmd/syft/internal/ui/ui.go +++ b/cmd/syft/internal/ui/ui.go @@ -100,7 +100,7 @@ func (m *UI) Teardown(force bool) error { }) // it may be tempting to use Kill() however it has been found that this can cause the terminal to be left in - // a bad state (where Ctrl+C and other control characters no longer works for future processes in that terminal). + // a bad state (where Ctrl+C and other control characters no longer work for future processes in that terminal). m.program.Quit() _ = runWithTimeout(250*time.Millisecond, func() error { diff --git a/examples/README.md b/examples/README.md index 8b6f1d45cf6..4f518ac58d5 100644 --- a/examples/README.md +++ b/examples/README.md @@ -5,8 +5,10 @@ This directory contains examples of how to use the Syft API. - `create_simple_sbom`: Create a simple SBOM from scratch - `create_custom_sbom`: Create an SBOM using as much custom configuration as possible, including a custom cataloger implementation - `decode_sbom`: Take an existing SBOM file (of arbitrary format) and decode it into a Syft SBOM object +- `select_catalogers`: Example demonstrating how to select specific catalogers to run - `source_detection`: Shows how to detect what to catalog automatically from a user string (e.g. container image vs directory) -- `source_from_image`: Construct a source from a only a container image +- `source_from_image`: Construct a source from only a container image +- `source_from_registry`: Construct a source directly from a container registry You can run any of these examples from this directory with: diff --git a/syft/pkg/cataloger/dotnet/parse_packages_lock.go b/syft/pkg/cataloger/dotnet/parse_packages_lock.go index 97bb4df861b..99535d9dab5 100644 --- a/syft/pkg/cataloger/dotnet/parse_packages_lock.go +++ b/syft/pkg/cataloger/dotnet/parse_packages_lock.go @@ -80,7 +80,7 @@ func parseDotnetPackagesLock(_ context.Context, _ file.Resolver, _ *generic.Envi for depNameVersion, dep := range allDependencies { parentPkg, ok := pkgMap[depNameVersion] if !ok { - log.Debugf("package \"%s\" not found in map of all pacakges", depNameVersion) + log.Debugf("package \"%s\" not found in map of all packages", depNameVersion) continue }