Skip to content

Add stable versioned API #289

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

Draft
Smaug123 wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

Add stable versioned API #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
72d6302
Add a versioned API
Smaug123 Feb 27, 2026
f0e4c3d
Add to test project
Smaug123 Feb 27, 2026
6c5710c
Fix stack overflow
Smaug123 Feb 27, 2026
28da7c7
Less odd names
Smaug123 Feb 27, 2026
9724f2d
Expand tests
Smaug123 Feb 27, 2026
81f0db2
Get rid of bizarre string match
Smaug123 Feb 28, 2026
b015ee8
Merge branch 'main' into versioned-api
Smaug123 Mar 18, 2026
4496673
Repair test fixture
Smaug123 Mar 18, 2026
399670f
More
Smaug123 Mar 18, 2026
b930e5d
More
Smaug123 Mar 18, 2026
977fa01
More
Smaug123 Mar 18, 2026
cfe8557
More
Smaug123 Mar 18, 2026
b830432
Extend to EditorAnalyzer as well
Smaug123 Mar 18, 2026
6710734
Merge branch 'main' into versioned-api
Smaug123 Mar 19, 2026
ead445b
Assert analyzers
Smaug123 Mar 19, 2026
d86f3b3
Dedupe
Smaug123 Mar 19, 2026
ce2c3ca
Markups
Smaug123 Mar 19, 2026
0a67d85
Merge branch 'main' into versioned-api
Smaug123 Mar 23, 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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.37.0] - 2026-02-27

### Changed

- We now expose stable backward-compatible APIs, independent of the FSharp.Compiler.Service API, which you are encouraged to use. If you use the stable API, then upgrading FSharp.Analyzers.SDK will not require you to rebuild your analyzers until you need to consume features from later versions of the SDK. (For example, if a new F# language version introduces new syntax that you wish to parse, then you will have to upgrade your analyzer to a later stable API version which understands that new syntax.)
Copy link
Contributor Author

@Smaug123 Smaug123 Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As of f0e4c3d this is the only part of the code that I wrote. (It's also all I've even read, so far.)


## [0.36.0] - 2026-02-02

### Added
Expand Down
2 changes: 2 additions & 0 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
<ItemGroup>
<PackageVersion Include="CliWrap" Version="3.10.0" />
<PackageVersion Include="FSharp.Core" Version="[10.0.101]" />
<PackageVersion Include="FsCheck" Version="2.16.6" />
<PackageVersion Include="FsCheck.NUnit" Version="2.16.6" />
<PackageVersion Include="FSharp.Compiler.Service" Version="[43.10.101]" />
<PackageVersion Include="Ionide.KeepAChangelog.Tasks" Version="0.3.0" PrivateAssets="all" />
<PackageVersion Include="McMaster.NETCore.Plugins" Version="2.0.0" />
Expand Down
21 changes: 18 additions & 3 deletions FSharp.Analyzers.SDK.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "FSharp.Analyzers.SDK.Testin
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FSharp.Analyzers.Build", "src\FSharp.Analyzers.Build\FSharp.Analyzers.Build.csproj", "{34AD5A2D-5FDE-4A03-8AC5-100F54E6D2DF}"
EndProject
Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "OptionAnalyzer.V1", "samples\OptionAnalyzer.V1\OptionAnalyzer.V1.fsproj", "{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -49,9 +51,6 @@ Global
Release|x64 = Release|x64
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Copy link
Contributor Author

@Smaug123 Smaug123 Feb 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This appears to be the default, not that it seems to be documented anywhere. Anyway, Claude chose for inscrutable reasons to move it down the file.

Copy link
Member

@TheAngryByrd TheAngryByrd Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should move to slnx anyway

EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{C1D38B7A-0193-46AA-B033-ADBBF642AAA0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{C1D38B7A-0193-46AA-B033-ADBBF642AAA0}.Debug|Any CPU.Build.0 = Debug|Any CPU
Expand Down Expand Up @@ -125,6 +124,21 @@ Global
{34AD5A2D-5FDE-4A03-8AC5-100F54E6D2DF}.Release|x64.Build.0 = Release|Any CPU
{34AD5A2D-5FDE-4A03-8AC5-100F54E6D2DF}.Release|x86.ActiveCfg = Release|Any CPU
{34AD5A2D-5FDE-4A03-8AC5-100F54E6D2DF}.Release|x86.Build.0 = Release|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Debug|x64.ActiveCfg = Debug|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Debug|x64.Build.0 = Debug|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Debug|x86.ActiveCfg = Debug|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Debug|x86.Build.0 = Debug|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Release|Any CPU.ActiveCfg = Release|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Release|Any CPU.Build.0 = Release|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Release|x64.ActiveCfg = Release|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Release|x64.Build.0 = Release|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Release|x86.ActiveCfg = Release|Any CPU
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{C1D38B7A-0193-46AA-B033-ADBBF642AAA0} = {95A9FA19-723D-4D2C-A936-F0B45656B0D6}
Expand All @@ -135,5 +149,6 @@ Global
{9A9AC3F8-E34B-4C30-A52A-A507D6E0CA01} = {0FE81935-26A8-45E1-A62E-5148C73BA6A2}
{3C70D1B2-DDCE-439A-BAB2-AC6B2E0919D5} = {95A9FA19-723D-4D2C-A936-F0B45656B0D6}
{34AD5A2D-5FDE-4A03-8AC5-100F54E6D2DF} = {95A9FA19-723D-4D2C-A936-F0B45656B0D6}
{71366770-A3E2-4B3B-9FB5-391BDDAD2AFB} = {0FE81935-26A8-45E1-A62E-5148C73BA6A2}
EndGlobalSection
EndGlobal
4 changes: 4 additions & 0 deletions samples/OptionAnalyzer.Test/OptionAnalyzer.Test.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<ItemGroup>
<Compile Include="TestHelpers.fs" />
<Compile Include="UnitTests.fs" />
<Compile Include="V1Tests.fs" />
</ItemGroup>

<ItemGroup>
Expand All @@ -21,12 +22,15 @@
<PackageReference Include="NUnit" />
<PackageReference Include="NUnit3TestAdapter" />
<PackageReference Include="FSharp.Compiler.Service"/>
<PackageReference Include="FsCheck" />
<PackageReference Include="FsCheck.NUnit" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\src\FSharp.Analyzers.SDK.Testing\FSharp.Analyzers.SDK.Testing.fsproj" />
<ProjectReference Include="..\..\src\FSharp.Analyzers.SDK\FSharp.Analyzers.SDK.fsproj" />
<ProjectReference Include="..\OptionAnalyzer\OptionAnalyzer.fsproj" />
<ProjectReference Include="..\OptionAnalyzer.V1\OptionAnalyzer.V1.fsproj" />
Copy link
Contributor Author

@Smaug123 Smaug123 Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cloned the existing OptionAnalyzer but now coding it against the stable API rather than against the raw FCS API.

</ItemGroup>

</Project>
Loading
Loading