From 910570d9218a51c77951e3ef5bd710e25344214d Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Wed, 30 Oct 2024 05:19:06 -0400 Subject: [PATCH] docs: add missing documentation for the MS Build Analyzer (#7113) --- src/site/markdown/analyzers/index.md | 3 ++- src/site/markdown/analyzers/msbuild.md | 7 +++++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 src/site/markdown/analyzers/msbuild.md diff --git a/src/site/markdown/analyzers/index.md b/src/site/markdown/analyzers/index.md index 7ce82f45dc3..0ecc2743ab1 100644 --- a/src/site/markdown/analyzers/index.md +++ b/src/site/markdown/analyzers/index.md @@ -9,7 +9,8 @@ to extract identification information from the files analyzed. | [Assembly](./assembly-analyzer.html) | .NET Assemblies (\*.exe, \*.dll) | Uses [GrokAssembly.exe](https://github.com/colezlaw/GrokAssembly); requires the dotnet core 8.0 runtime to be installed. | | [Jar](./jar-analyzer.html) | Java archive files (\*.jar); Web application archive (\*.war) | Examines archive manifest metadata, and Maven Project Object Model files (pom.xml). | | [RetireJS](./retirejs-analyzer.html) | JavaScript files | Analyzes JavaScript files using the [RetireJS](https://github.com/RetireJS/retire.js) database. | -| [Node.js](./nodejs.html) | NPM package specification files (package.json) | Parses the package.json to gather a bill-of-materials for a Node JS project. | +| [MS Build](./msbuild.html) | MS Build files (\*.csproj, \*.vbproj) | Parses the project files, including related directory build or package properties, to gather dependency information. | +| [Node.js](./nodejs.html) | NPM package specification files (package.json) | Parses the package.json to gather a dependency information for a Node JS project. | | [Node Audit](./node-audit-analyzer.html) | Uses the `npm audit` APIs to report on known vulnerable node.js libraries. This analyzer requires an Internet connection. | | [Nugetconf](./nugetconf-analyzer.html) | Nuget packages.config file | Uses XPath to parse specification XML. | | [Nuspec](./nuspec-analyzer.html) | Nuget package specification file (\*.nuspec) | Uses XPath to parse specification XML. | diff --git a/src/site/markdown/analyzers/msbuild.md b/src/site/markdown/analyzers/msbuild.md new file mode 100644 index 00000000000..7fcd313150d --- /dev/null +++ b/src/site/markdown/analyzers/msbuild.md @@ -0,0 +1,7 @@ +MS Build Analyzer +============== + +The MS Build Analyzer will parse csproj and vbproj files to gather infromation +on the projects dependencies. + +Files Scanned: *.csproj, *.vbproj, and related Directory.Build.props and Directory.Packages.props.