Added --use-caching flag to maintain a persisted cache to speed-up the analysis using

[dennisdoomen]

Introduces a package caching mechanism to speed up future analysis in the system. It allows caching of license information and other package metadata, saving it to a default location or a user-specified path, so that subsequent runs can leverage this cached data, reducing the overhead of fetching the same information repeatedly. T

Several additions were made to configuration files, build scripts, and command-line options, such as the --use-caching flag for enabling caching and --cache-file-path for specifying the cache file location. These changes aim to optimize performance, streamline processes, and improve usability when working on multiple or repeated project analyses. PackageGuard

Closes #44

[github-actions]

Test Results

42 tests  +4   42 ✅ +4   33s ⏱️ +2s
 2 suites ±0    0 💤 ±0 
 2 files   ±0    0 ❌ ±0 

Results for commit 807bcec. ± Comparison against base commit 2344d84.

This pull request removes 4 and adds 8 tests. Note that renamed tests count towards both.

PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ A_package_version_inside_the_allowed_range_is_okay
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ A_package_version_outside_the_allowed_range_is_a_violation
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Can_allow_a_package_that_violates_the_allowed_licenses
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Specifying_a_specific_project_file_requires_it_to_exist

PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ A_specified_project_must_exist
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ A_version_inside_the_allowed_range_is_okay
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ A_version_outside_the_allowed_range_is_a_violation
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Can_reuse_a_cache_from_an_earlier_run
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Can_still_allow_a_package_that_violates_the_allowed_licenses
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Creates_a_cache_at_a_specific_path_if_asked_for
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Creates_a_cache_if_asked_for
PackageGuard.Specs.CSharpProjectAnalyzerSpecs ‑ Will_ignore_a_corrupt_cache

♻️ This comment has been updated with latest results.

[Copilot]

Pull Request Overview

This PR adds a package‐level cache to the analysis process, controlled by new CLI flags and configuration properties.

• Introduce UseCaching and CacheFilePath options to AnalyzeCommandSettings and pass them through to CSharpProjectAnalyzer.
• Implement PackageInfoCollection.TryInitializeFromCache and WriteToCache using MemoryPack to load/save cached package metadata.
• Update projects, tests, and documentation to reference Name instead of Id on PackageInfo and bump various package versions.

Reviewed Changes

Copilot reviewed 23 out of 25 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
PackageGuard.csproj	Upgrade configuration packages and add Pathy reference
AnalyzeCommandSettings.cs	Add UseCaching and CacheFilePath CLI options
AnalyzeCommand.cs	Pass caching settings into analyzer
PackageInfoCollection.cs	Add cache load/save, rename constructor to take logger
PackageInfo.cs	Rename Id→Name, mark [MemoryPackable]
NuGetPackageAnalyzer.cs	Propagate source list to Find and metadata retrieval
CSharpProjectAnalyzer.cs	Wire up cache logic in ExecuteAnalysis
Multiple test/spec files	Update to use Name and add caching specs
README.md	Document new CLI flags and caching details

Comments suppressed due to low confidence (3)

README.md:154

• [nitpick] This new header has no accompanying text; consider adding an explanation of the caching feature or removing the empty section to keep the docs clear.

### Speed-up the analysis using caching

README.md:172

• [nitpick] The backlog list contains duplicated and inconsistent bullet formatting; clean up or reformat the sections under “Major features”/“Minor features” for readability.

**Major features**

Src/PackageGuard.Specs/CSharpProjectAnalyzerSpecs.cs:535

• There’s no test verifying that when UseCaching is false, no cache file is written; consider adding a negative test to ensure the cache path is untouched when caching is disabled.

    public async Task Creates_a_cache_if_asked_for()

[coveralls]

Pull Request Test Coverage Report for Build 16241778058

Details

• 79 of 93 (84.95%) changed or added relevant lines in 9 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+2.1%) to 76.449%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
Src/PackageGuard.Core/PackageInfo.cs	6	7	85.71%
Src/PackageGuard.Core/LicenseFetcher.cs	8	10	80.0%
Src/PackageGuard/AnalyzeCommand.cs	0	2	0.0%
Src/PackageGuard/AnalyzeCommandSettings.cs	0	2	0.0%
Src/PackageGuard.Core/PackageInfoCollection.cs	38	45	84.44%

Totals
Change from base Build 16089372995:	2.1%
Covered Lines:	471
Relevant Lines:	626

---

💛 - Coveralls