From 5325858f11ffbe40d2f9a5ca868771b2a474e704 Mon Sep 17 00:00:00 2001
From: dawe <dawedawe@posteo.de>
Date: Wed, 8 Nov 2023 16:22:37 +0100
Subject: [PATCH] - add LocalAnalyzersSDKRepo property - add documentation

---
 Directory.Build.props                                      | 2 ++
 docs/content/contributions.md                              | 5 +++++
 src/Ionide.Analyzers/Ionide.Analyzers.fsproj               | 2 +-
 tests/Ionide.Analyzers.Tests/Ionide.Analyzers.Tests.fsproj | 2 +-
 4 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/Directory.Build.props b/Directory.Build.props
index 81cd132..5aefb17 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -32,7 +32,9 @@
         <ServerGarbageCollection>true</ServerGarbageCollection>
         <LangVersion>preview</LangVersion>
         <OtherFlags>$(OtherFlags) --test:GraphBasedChecking --test:ParallelOptimization --test:ParallelIlxGen</OtherFlags>
+        <!-- Set to true and adjust the path to your local repo if you want to use that instead of the nuget packages -->
         <UseLocalAnalyzersSDK>false</UseLocalAnalyzersSDK>
+        <LocalAnalyzersSDKRepo>../../../FSharp.Analyzers.SDK</LocalAnalyzersSDKRepo>
     </PropertyGroup>
 
     <ItemGroup Condition="'$(IsPackable)' == 'true'">
diff --git a/docs/content/contributions.md b/docs/content/contributions.md
index 437033a..946ee66 100644
--- a/docs/content/contributions.md
+++ b/docs/content/contributions.md
@@ -69,3 +69,8 @@ Please add [a new entry](https://keepachangelog.com/en/1.1.0/) for your changes.
 
 Unless, there are technical reason blocking us, we will try and ship your contribution as soon as possible.  
 Our CI process should pick up new version from the changelog and push new packages to NuGet.org once the code is on the `main` branch.
+
+## Using a local analyzers SDK
+
+You might run into a situation when the SDK packages don't provide the features you need for your analyzers development.  
+In such a case, you can edit the `Directory.Build.props` file and set `UseLocalAnalyzersSDK` to `true` and let `LocalAnalyzersSDKRepo` point to your local SDK repository.
diff --git a/src/Ionide.Analyzers/Ionide.Analyzers.fsproj b/src/Ionide.Analyzers/Ionide.Analyzers.fsproj
index 942cbf4..b63570f 100644
--- a/src/Ionide.Analyzers/Ionide.Analyzers.fsproj
+++ b/src/Ionide.Analyzers/Ionide.Analyzers.fsproj
@@ -20,7 +20,7 @@
     </ItemGroup>
 
     <ItemGroup Condition="'$(UseLocalAnalyzersSDK)' == 'true'">
-        <ProjectReference Include="../../../FSharp.Analyzers.SDK/src/FSharp.Analyzers.SDK/FSharp.Analyzers.SDK.fsproj" />
+        <ProjectReference Include="$(LocalAnalyzersSDKRepo)/src/FSharp.Analyzers.SDK/FSharp.Analyzers.SDK.fsproj" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/tests/Ionide.Analyzers.Tests/Ionide.Analyzers.Tests.fsproj b/tests/Ionide.Analyzers.Tests/Ionide.Analyzers.Tests.fsproj
index 69511c6..554b868 100644
--- a/tests/Ionide.Analyzers.Tests/Ionide.Analyzers.Tests.fsproj
+++ b/tests/Ionide.Analyzers.Tests/Ionide.Analyzers.Tests.fsproj
@@ -31,7 +31,7 @@
   </ItemGroup>
   
   <ItemGroup Condition="'$(UseLocalAnalyzersSDK)' == 'true'">
-    <ProjectReference Include="../../../FSharp.Analyzers.SDK/src/FSharp.Analyzers.SDK.Testing/FSharp.Analyzers.SDK.Testing.fsproj" />
+    <ProjectReference Include="$(LocalAnalyzersSDKRepo)/src/FSharp.Analyzers.SDK.Testing/FSharp.Analyzers.SDK.Testing.fsproj" />
   </ItemGroup>
 
 </Project>