Skip to content

Support per-TFM .cssig files #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agocke merged 2 commits into from
Jun 29, 2026
Merged

Support per-TFM .cssig files #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e89acf
Support per-TFM .cssig files for multi-targeted projects
agocke Jun 29, 2026
aabf2fe
Merge branch 'main' into tfm-cssig
agocke Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/CsSig/Analyzer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ All `*.cssig` files in the project are included automatically and together defin
API surface. Set `<EnableCsSigAnalyzer>false</EnableCsSigAnalyzer>` to opt out. A project with no
`.cssig` files enforces nothing.

For multi-targeted projects, name a file `<name>.<tfm>.cssig` (e.g. `PublicApi.net8.0.cssig`) to
apply it only when building that target framework. Unqualified files (e.g. `PublicApi.cssig`) apply
to every TFM, so put the shared surface there and the TFM-specific surface in qualified files.

You don't write the file by hand: create an empty `PublicApi.cssig`, build (every public member reports
`CSSIG002`), then invoke the code fix → **Fix all** to generate it from the current surface. Apply
the same fix to keep it current as the API grows.
Expand Down
15 changes: 15 additions & 0 deletions src/CsSig/Analyzer/build/StaticCS.CsSig.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,21 @@
Include="**/*.cssig"
Exclude="$(BaseIntermediateOutputPath)**/*.cssig;$(BaseOutputPath)**/*.cssig;bin/**/*.cssig;obj/**/*.cssig"
/>

<!--
Per-TFM signatures: a `<name>.<tfm>.cssig` file (e.g. PublicApi.net8.0.cssig) applies only
to that target framework. Drop every TFM-qualified file, then re-add the ones for the TFM
currently building, so multi-targeted projects can declare a distinct surface per TFM.
-->
<AdditionalFiles
Remove="**/*.net*.cssig;**/*.netstandard*.cssig;**/*.netcoreapp*.cssig"
Condition="'$(TargetFramework)' != ''"
/>
<AdditionalFiles
Include="**/*.$(TargetFramework).cssig"
Exclude="$(BaseIntermediateOutputPath)**/*.cssig;$(BaseOutputPath)**/*.cssig;bin/**/*.cssig;obj/**/*.cssig"
Condition="'$(TargetFramework)' != ''"
/>
</ItemGroup>

<!--
Expand Down
Loading