Skip to content

Commit

Permalink
Merge pull request #97 from nojaf/update-readme
Browse files Browse the repository at this point in the history 
Extract any duplicatish code from the main README.
  • Loading branch information
@nojaf
nojaf authored Sep 20, 2023
2 parents 0383534 + f62e8da commit 79e302b
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 212 deletions.
99 changes: 5 additions & 94 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FSharp.Analyzers.SDK
# Ionide FSharp.Analyzers.SDK

Library used for building custom analyzers for FSAC / F# editors.

Expand All @@ -8,110 +8,21 @@ F# analyzers are live, real-time, project based plugins that enables to diagnose

1. Install the .NET SDK version specified in `global.json`
2. `dotnet tool restore`
2. Open and build in your favorite IDE, or use `dotnet build`
3. Open and build in your favorite IDE, or use `dotnet build`

## How to run sample
1. `dotnet build -c Release`
2.
2. Run the console application:

```shell
dotnet run --project src\FSharp.Analyzers.Cli\FSharp.Analyzers.Cli.fsproj -- --project ./samples/OptionAnalyzer/OptionAnalyzer.fsproj --analyzers-path ./samples/OptionAnalyzer/bin/Release --verbose
```


You can also set up a run configuration of FSharp.Analyzers.Cli in your favorite IDE using similar arguments. This also allows you to debug FSharp.Analyzers.Cli.

## Writing Analyzers

Analyzers that are consumed by this SDK and from Ionide are simply .NET core class libraries. These class libraries expose a *value* of type `Analyzer` which is effectively a function that has input of type `Context` and returns a list of `Message` records:
```fsharp
module BadCodeAnalyzer
open FSharp.Analyzers.SDK
[<Analyzer>]
let badCodeAnalyzer : Analyzer =
fun (context: Context) ->
// inspect context to determine the error/warning messages
[ ]
```
Notice how we expose the function `BadCodeAnalyzer.badCodeAnalyzer` with an attribute `[<Analyzer>]` that allows the SDK to detect the function. The input `Context` is a record that contains information about a single F# file such as the typed AST, the AST, the file content, the file name and more. The SDK runs this function against all files of a project during editing. The output messages that come out of the function are eventually used by Ionide to highlight the inspected code as a warning or error depending on the `Severity` level of each message.

Analyzers can also be named which allows for better logging if something went wrong while using the SDK from Ionide:
```fs
[<Analyzer "BadCodeAnalyzer">]
let badCodeAnalyzer : Analyzer =
fun (context: Context) ->
// inspect context to determine the error/warning messages
[ ]
```
### Analyzer Requirements

Analyzers are .NET core class libraries and they are distributed as such. However, since the SDK relies on dynamically loading the analyzers during runtime, there are some requirements to get them to work properly:
- The analyzer class library has to target the `net6.0` framework
- The analyzer has to reference the latest `FSharp.Analyzers.SDK` (at least the version used by FsAutoComplete which is subsequently used by Ionide)

### Packaging and Distribution

Since analyzers are just .NET core libraries, you can distribute them to the nuget registry just like you would with a normal .NET package. Simply run `dotnet pack --configuration Release` against the analyzer project to get a nuget package and publish it with

```
dotnet nuget push {NugetPackageFullPath} -s nuget.org -k {NugetApiKey}
```

However, the story is different and slightly more complicated when your analyzer package has third-party dependencies also coming from nuget. Since the SDK dynamically loads the package assemblies (`.dll` files), the assemblies of the dependencies has be there *next* to the main assembly of the analyzer. Using `dotnet pack` will **not** include these dependencies into the output Nuget package. More specifically, the `./lib/net6.0` directory of the nuget package must have all the required assemblies, also those from third-party packages. In order to package the analyzer properly with all the assemblies, you need to take the output you get from running:
```
dotnet publish --configuration Release --framework net6.0
```
against the analyzer project and put every file from that output into the `./lib/net6.0` directory of the nuget package. This requires some manual work by unzipping the nuget package first (because it is just an archive), modifying the directories then zipping the package again. It can be done using a FAKE build target to automate the work:
```fs
// make ZipFile available
#r "System.IO.Compression.FileSystem.dll"
let releaseNotes = ReleaseNotes.load "RELEASE_NOTES.md"
Target.create "PackAnalyzer" (fun _ ->
let analyzerProject = "src" </> "BadCodeAnalyzer"
let args =
[
"pack"
"--configuration Release"
sprintf "/p:PackageVersion=%s" releaseNotes.NugetVersion
sprintf "/p:PackageReleaseNotes=\"%s\"" (String.concat "\n" releaseNotes.Notes)
sprintf "--output %s" (__SOURCE_DIRECTORY__ </> "dist")
]
// create initial nuget package
let exitCode = Shell.Exec("dotnet", String.concat " " args, analyzerProject)
if exitCode <> 0 then
failwith "dotnet pack failed"
else
match Shell.Exec("dotnet", "publish --configuration Release --framework net6.0", analyzerProject) with
| 0 ->
let nupkg =
System.IO.Directory.GetFiles(__SOURCE_DIRECTORY__ </> "dist")
|> Seq.head
|> IO.Path.GetFullPath
let nugetParent = DirectoryInfo(nupkg).Parent.FullName
let nugetFileName = IO.Path.GetFileNameWithoutExtension(nupkg)
let publishPath = analyzerProject </> "bin" </> "Release" </> "net6.0" </> "publish"
// Unzip the nuget
ZipFile.ExtractToDirectory(nupkg, nugetParent </> nugetFileName)
// delete the initial nuget package
File.Delete nupkg
// remove stuff from ./lib/net6.0
Shell.deleteDir (nugetParent </> nugetFileName </> "lib" </> "net6.0")
// move the output of publish folder into the ./lib/net6.0 directory
Shell.copyDir (nugetParent </> nugetFileName </> "lib" </> "net6.0") publishPath (fun _ -> true)
// re-create the nuget package
ZipFile.CreateFromDirectory(nugetParent </> nugetFileName, nupkg)
// delete intermediate directory
Shell.deleteDir(nugetParent </> nugetFileName)
| _ ->
failwith "dotnet publish failed"
)
```
Checkout our [Getting Started](https://ionide.io/FSharp.Analyzers.SDK/content/Getting%20Started.html) guide!

## How to contribute

Expand Down
143 changes: 119 additions & 24 deletions docs/content/Getting Started.fsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ index: 1
# Getting started
## Premise
Analyzers that are consumed by this SDK and from Ionide are simply .NET core class libraries.
These class libraries expose a *value* of type [Analyzer<'TContext>](../reference/fsharp-analyzers-sdk-analyzer-1.html) which is effectively a function that has input of type [Context](../reference/fsharp-analyzers-sdk-context.html) and returns a list of [Message](../reference/fsharp-analyzers-sdk-message.html) records.
## Create project
Create a new class library targeting `net6.0`
Expand All @@ -23,6 +28,8 @@ Add a reference to the analyzers SDK:
dotnet add package FSharp.Analyzers.SDK
```
⚠️ Note: To utilize the analyzers in FsAutoComplete (which is subsequently utilized by Ionide), it is essential to ensure that the SDK version matches correctly.
```shell
paket add FSharp.Analyzers.SDK
```
Expand All @@ -49,31 +56,39 @@ In the following example we will be
#r "../../src/FSharp.Analyzers.Cli/bin/Release/net6.0/FSharp.Analyzers.SDK.dll"
#r "../../src/FSharp.Analyzers.Cli/bin/Release/net6.0/FSharp.Compiler.Service.dll"
(** *)
open FSharp.Analyzers.SDK

// This attribute is required and needs to match the correct context type!
[<CliAnalyzer>]
let optionValueAnalyzer: Analyzer<CliContext> =
fun (context: CliContext) ->
async {
// inspect context to determine the error/warning messages
// A potential implementation might traverse the untyped syntax tree
// to find any references of `Option.Value`
return
[
{
Type = "Option.Value analyzer"
Message = "Option.Value shouldn't be used"
Code = "OV001"
Severity = Warning
Range = FSharp.Compiler.Text.Range.Zero
Fixes = []
}
]
}

(**
Analyzers can also be named which allows for better logging if something went wrong while using the SDK from Ionide:
*)

module OptionAnalyzer =

open FSharp.Analyzers.SDK

// This attribute is required and needs to match the correct context type!
[<CliAnalyzer>]
let optionValueAnalyzer: Analyzer<CliContext> =
fun (context: CliContext) ->
async {
// inspect context to determine the error/warning messages
// A potential implementation might traverse the untyped syntax tree
// to find any references of `Option.Value`
return
[
{
Type = "Option.Value analyzer"
Message = "Option.Value shouldn't be used"
Code = "OV001"
Severity = Warning
Range = FSharp.Compiler.Text.Range.Zero
Fixes = []
}
]
}
[<EditorAnalyzer "BadCodeAnalyzer">]
let badCodeAnalyzer: Analyzer<EditorContext> =
fun (context: EditorContext) ->
async { // inspect context to determine the error/warning messages
return []
}

(**
## Running your first analyzer
Expand All @@ -89,6 +104,86 @@ dotnet tool install --global fsharp-analyzers
fsharp-analyzers --project YourProject.fsproj --analyzers-path ./OptionAnalyzer/bin/Release --verbose
```
### Packaging and Distribution
Since analyzers are just .NET core libraries, you can distribute them to the nuget registry just like you would with a normal .NET package.
Simply run `dotnet pack --configuration Release` against the analyzer project to get a nuget package and publish it with
```shell
dotnet nuget push {NugetPackageFullPath} -s nuget.org -k {NugetApiKey}
```
However, the story is different and slightly more complicated when your analyzer package has third-party dependencies also coming from nuget. Since the SDK dynamically loads the package assemblies (`.dll` files), the assemblies of the dependencies have to be right *next* to the main assembly of the analyzer. Using `dotnet pack` will **not** include these dependencies into the output Nuget package. More specifically, the `./lib/net6.0` directory of the nuget package must have all the required assemblies, also those from third-party packages. In order to package the analyzer properly with all the assemblies, you need to take the output you get from running:
```shell
dotnet publish --configuration Release --framework net6.0
```
against the analyzer project and put every file from that output into the `./lib/net6.0` directory of the nuget package. This requires some manual work by unzipping the nuget package first (because it is just an archive), modifying the directories then zipping the package again. It can be done using a FAKE build target to automate the work:
*)

// make ZipFile available
#r "System.IO.Compression.FileSystem.dll"
#r "nuget: Fake.Core.Target, 6.0.0"
#r "nuget: Fake.Core.ReleaseNotes, 6.0.0"
#r "nuget: Fake.IO.Zip, 6.0.0"

open System.IO
open System.IO.Compression
open Fake.Core
open Fake.IO
open Fake.IO.FileSystemOperators

let releaseNotes = ReleaseNotes.load "RELEASE_NOTES.md"

Target.create
"PackAnalyzer"
(fun _ ->
let analyzerProject = "src" </> "BadCodeAnalyzer"

let args =
[
"pack"
"--configuration Release"
sprintf "/p:PackageVersion=%s" releaseNotes.NugetVersion
sprintf "/p:PackageReleaseNotes=\"%s\"" (String.concat "\n" releaseNotes.Notes)
sprintf "--output %s" (__SOURCE_DIRECTORY__ </> "dist")
]

// create initial nuget package
let exitCode = Shell.Exec("dotnet", String.concat " " args, analyzerProject)

if exitCode <> 0 then
failwith "dotnet pack failed"
else
match Shell.Exec("dotnet", "publish --configuration Release --framework net6.0", analyzerProject) with
| 0 ->
let nupkg =
System.IO.Directory.GetFiles(__SOURCE_DIRECTORY__ </> "dist")
|> Seq.head
|> Path.GetFullPath

let nugetParent = DirectoryInfo(nupkg).Parent.FullName
let nugetFileName = Path.GetFileNameWithoutExtension(nupkg)

let publishPath = analyzerProject </> "bin" </> "Release" </> "net6.0" </> "publish"
// Unzip the nuget
ZipFile.ExtractToDirectory(nupkg, nugetParent </> nugetFileName)
// delete the initial nuget package
File.Delete nupkg
// remove stuff from ./lib/net6.0
Shell.deleteDir (nugetParent </> nugetFileName </> "lib" </> "net6.0")
// move the output of publish folder into the ./lib/net6.0 directory
Shell.copyDir (nugetParent </> nugetFileName </> "lib" </> "net6.0") publishPath (fun _ -> true)
// re-create the nuget package
ZipFile.CreateFromDirectory(nugetParent </> nugetFileName, nupkg)
// delete intermediate directory
Shell.deleteDir (nugetParent </> nugetFileName)
| _ -> failwith "dotnet publish failed"
)

(**
[Next]({{fsdocs-next-page-link}})
*)
Loading

0 comments on commit 79e302b

Please sign in to comment.