FsProjLint

Opinionated F# project and repo validator for OSS readiness. Checks fsproj metadata, SourceLink, LICENSE, and more.

Installation

dotnet tool install -g FsProjLint

Usage

Run from the root of your repository:

fsprojlint

FsProjLint discovers all .fsproj files under src/ and checks them alongside repo-level requirements. Exit code 0 means everything passed; exit code 1 means at least one check failed.

Checks

Repo-level checks

Check	Description
LICENSE exists	`LICENSE` or `LICENSE.md` at repo root
README.md exists	`README.md` at repo root
.editorconfig exists	`.editorconfig` at repo root
docs/index.md exists	Only required when at least one project is packable

Project-level checks (all projects)

Check	Description
TreatWarningsAsErrors is true	Ensures warnings don't slip through

Project-level checks (packable projects only)

A project is considered packable if it has a PackageId and IsPackable is not false. Packable projects get additional checks:

Check	Description
Version present	`<Version>` element exists and is non-empty
Description present	`<Description>` element exists and is non-empty
Authors present	`<Authors>` element exists and is non-empty
PackageLicenseExpression present	License SPDX expression set
RepositoryUrl present	Source repository URL set
RepositoryType present	Repository type (e.g., `git`) set
GenerateDocumentationFile is true	XML docs generated for IntelliSense
IncludeSymbols is true	Symbol packages included
SymbolPackageFormat is snupkg	Uses the portable PDB symbol format
Has Microsoft.SourceLink.GitHub	SourceLink package referenced for debugger support

Example Output

FAILED:
  FAIL IncludeSymbols is true
  FAIL Has Microsoft.SourceLink.GitHub
Passed:
  PASS LICENSE exists
  PASS README.md exists
  PASS .editorconfig exists
  PASS TreatWarningsAsErrors is true
  PASS Version present
  PASS Description present

Result: 6/8 checks passed

License

MIT

namespace Microsoft

Multiple items
module Result from Microsoft.FSharp.Core

--------------------
[<Struct>] type Result<'T,'TError> = | Ok of ResultValue: 'T | Error of ErrorValue: 'TError