diff --git a/README.md b/README.md index 9781a73f5..7d930924c 100644 --- a/README.md +++ b/README.md @@ -33,21 +33,34 @@ Component Detection can also be used as a library to detect dependencies in your ## Features -Component Detection supports detecting libraries from the following ecosystem: +Component Detection supports detecting libraries from the following ecosystems: | Ecosystem | Scanning | Graph Creation | | -------------------------------------------------------------------------------- | ----------------------------------------------- | -------------- | -| CocoaPods | ✔ | ✔ | -| [Go](docs/detectors/go.md) | ✔ | ❌ | +| [CocoaPods](docs/detectors/cocoapods.md) | ✔ | ✔ | +| [Conan](docs/detectors/conan.md) | ✔ | ❌ | +| [Conda (Python)](docs/detectors/conda.md) | ✔ | ✔ | +| [Docker Compose](docs/detectors/dockercompose.md) | ✔ | ❌ | +| [Dockerfile](docs/detectors/dockerfile.md) | ✔ | ❌ | +| [DotNet SDK](docs/detectors/dotnet.md) | ✔ | ❌ | +| [Go](docs/detectors/go.md) | ✔ | ✔ (with Go 1.11+) | | [Gradle (lockfiles only)](docs/detectors/gradle.md) | ✔ | ❌ | -| [Linux (Debian, Alpine, Rhel, Centos, Fedora, Ubuntu)](docs/detectors//linux.md) | ✔ (via [syft](https://github.com/anchore/syft)) | ❌ | +| [Helm](docs/detectors/helm.md) | ✔ | ❌ | +| [Ivy](docs/detectors/ivy.md) | ✔ | ✔ | +| [Linux (Debian, Alpine, Rhel, Centos, Fedora, Ubuntu)](docs/detectors/linux.md) | ✔ (via [syft](https://github.com/anchore/syft)) | ❌ | | [Maven](docs/detectors/maven.md) | ✔ | ✔ | | [NPM (including Yarn, Pnpm)](docs/detectors/npm.md) | ✔ | ✔ | | [NuGet (including Paket)](docs/detectors/nuget.md) | ✔ | ✔ | | [Pip (Python)](docs/detectors/pip.md) | ✔ | ✔ | | [Poetry (Python, lockfiles only)](docs/detectors/poetry.md) | ✔ | ❌ | -| Ruby | ✔ | ✔ | -| Rust | ✔ | ✔ | +| [Ruby](docs/detectors/ruby.md) | ✔ | ✔ | +| [Rust (Cargo)](docs/detectors/rust.md) | ✔ | ✔ | +| [SPDX SBOM](docs/detectors/spdx.md) | ✔ | ❌ | +| [Swift](docs/detectors/swift.md) | ✔ | ❌ | +| [Uv (Python)](docs/detectors/uv.md) | ✔ | ✔ | +| [Vcpkg](docs/detectors/vcpkg.md) | ✔ | ❌ | + +See the [detectors directory](docs/detectors/README.md) for the current status (Stable, Experimental, or DefaultOff) of each individual detector. For a complete feature overview refer to [feature-overview.md](docs/feature-overview.md) diff --git a/docs/detectors/README.md b/docs/detectors/README.md index 313886577..6e4bf3c4d 100644 --- a/docs/detectors/README.md +++ b/docs/detectors/README.md @@ -87,7 +87,7 @@ | NuGetComponentDetector | Stable | | NuGetPackagesConfigDetector | Stable | | NuGetProjectModelProjectCentricComponentDetector | Stable | -| MSBuildBinaryLogComponentDetector | DefaultOff | +| MSBuildBinaryLogComponentDetector | Experimental | - [Pip](pip.md) diff --git a/docs/detectors/nuget.md b/docs/detectors/nuget.md index 2f55f9785..62524b121 100644 --- a/docs/detectors/nuget.md +++ b/docs/detectors/nuget.md @@ -38,7 +38,9 @@ The `NuGetPackagesConfig` detector raises NuGet components referenced by project ## MSBuildBinaryLog -The `MSBuildBinaryLog` detector is a **DefaultOff** detector intended to eventually replace both the `NuGetProjectCentric` and `DotNet` detectors. It combines MSBuild binary log (binlog) information with `project.assets.json` to provide enhanced component detection with project-level classifications. +The `MSBuildBinaryLog` detector is an **Experimental** detector intended to eventually replace both the `NuGetProjectCentric` and `DotNet` detectors. It combines MSBuild binary log (binlog) information with `project.assets.json` to provide enhanced component detection with project-level classifications. + +As an experimental detector, it runs automatically whenever a scan is performed, but its results are not reported as part of the normal scan output. Instead, the results are compared against the existing `NuGetProjectCentric` and `DotNet` detectors and recorded as telemetry so maintainers can evaluate parity before promoting the detector to default. It looks for `project.assets.json` files and separately discovers `*.binlog` files. The binlog provides build-time context that isn't available from `project.assets.json` alone. diff --git a/docs/feature-overview.md b/docs/feature-overview.md index 0c96ebebb..541f91202 100644 --- a/docs/feature-overview.md +++ b/docs/feature-overview.md @@ -11,7 +11,7 @@ | NPM | | - | ✔ (dev-dependencies in package.json, dev flag in package-lock.json) | ✔ | | Yarn (v1, v2) | | - | ✔ (dev-dependencies in package.json) | ✔ | | Pnpm | | - | ✔ (packages/{package}/dev flag) | ✔ | -| NuGet | | - | - | ✔ (required project.assets.json) | +| NuGet | | - | - | ✔ (required project.assets.json) | | Pip (Python) | | | ❌ | ✔ | | Poetry (Python) |