ReadMe.md

This is a repository that contains several useful things that other nblockchain repos use, such as:

• Config file and plugins for commitlint.
• A reference .editorconfig file.
• An F# style guide.
• Workflow guidelines.
• Scripts that aid maintainability:
  • Detection of .fsx scripts without shebang.
  • F# scripts compilation.
  • EOF without EOL detection.
  • Mixed line-endings detection.
  • Use of unpinned versions:
    • Use of -latest suffix in runs-on: GitHubCI tags.
    • Use of asterisk (*) in PackageReference items of .NET projects.
    • Missing the version number in #r "nuget: refs of F# scripts.

All in all, this is mainly documentation, and some tooling to detect bad practices.

More things to come:

• Detect .fsx files without +x attrib.
• Detect old versions of FSharpLint and fantomas/fantomless being used.
• Detect old versions of .editorconfig or Directory.Build.props being used.
• Detect non-verbose flags (e.g. dotnet build -c Debug instead of dotnet build --configuration Debug) being used in scripts or YML CI files (there are exceptions, e.g. env -S).
• Detect unpinned versions, such as:
  • Missing the --version flag in dotnet tool install foo invocations.