CI: code analysis

[swharden]

There exists a GitHub Action which uploads files to the ScottPlot developer site http://dev.scottplot.net hosted by GitHub Pages

ScottPlot/.github/workflows/devsite.yaml

Lines 1 to 40 in 7300d88

	name: Update Developer Website
	# This script copies contents of /dev/www to dev.scottplot.net (hosted by GitHub Pages)
	on:
	workflow_dispatch:
	push: # only runs on commits to main branch (typically after a merge)
	branches:
	- main
	paths:
	- "dev/www/**"
	permissions:
	contents: read
	pages: write
	id-token: write
	concurrency:
	group: "pages"
	cancel-in-progress: true
	jobs:
	publish:
	name: Deploy
	runs-on: ubuntu-latest
	environment:
	name: Cookbook
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: 🛒 Checkout
	uses: actions/checkout@v3
	- name: 🛠️ Configure Pages
	uses: actions/configure-pages@v2
	- name: 📦 Upload Artifact
	uses: actions/upload-pages-artifact@v1
	with:
	path: "./dev/www"
	- name: 🚀 Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v1

It would be interesting to have the CI system generate basic code analysis statistics and update a page on that website. I would be interested to know the total lines of code (separated by ScottPlot 4 and ScottPlot 5) and perhaps cyclomatic complexity by class or namespace would be useful too.

It looks like official packages can be used to evaluate code metrics

Rabbit Hole

• https://www.nuget.org/packages/Microsoft.CodeAnalysis.Metrics/
• https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp/
• https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/get-started/syntax-analysis
• https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-cyclomatic-complexity
• https://github.com/dotnet/code-analysis
• https://learn.microsoft.com/en-us/visualstudio/code-quality/how-to-generate-code-metrics-data
• https://github.com/dotnet/samples/blob/main/github-actions/DotNet.GitHubAction/CODE_METRICS.md
• https://stackoverflow.com/questions/44726384/enabling-microsofts-code-analysis-on-net-core-projects
• https://www.nuget.org/packages/Microsoft.CodeAnalysis.NetAnalyzers
• https://learn.microsoft.com/en-us/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers
• https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/overview
• https://www.microfocus.com/documentation/visual-cobol/vc50all/VS2019/GUID-6FD9DA7A-667F-4B51-8D64-33D247F96DAE.html
• https://github.com/MicrosoftDocs/visualstudio-docs/issues/1395
• Shipping story for Metrics.exe dotnet/roslyn-analyzers#1756
• Microsoft.CodeAnalysis.Metrics for MacOs dotnet/roslyn-analyzers#2402
• Codemetrics does not work for multi-target projects dotnet/roslyn-analyzers#3615

Generate Code Analysis Metrics from the Command Line

Note: this may not work on multi-target csproj files

dotnet add package Microsoft.CodeAnalysis.Metrics
dotnet build -target:Metrics

multi-targeted projects must specify a framework:

dotnet build --framework net6.0 -target:Metrics

indicate private assets to avoid the package from being included in NuGet packages

<PackageReference Include="Microsoft.CodeAnalysis.Metrics" Version="*" >
    <PrivateAssets>all</PrivateAssets>
</PackageReference>

[swharden]

https://swharden.com/blog/2023-03-05-dotnet-code-analysis/

[swharden]

https://dev.scottplot.net/metrics/