Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/theangrybyrd/miniscaffold

F# Template for creating and publishing libraries targeting .NET 6.0 `net6.0` or console apps .NET 6.0 `net6.0`.
https://github.com/theangrybyrd/miniscaffold

dotnet dotnet-core dotnet-framework dotnet-template fsharp scaffold

Last synced: about 1 month ago
JSON representation

F# Template for creating and publishing libraries targeting .NET 6.0 `net6.0` or console apps .NET 6.0 `net6.0`.

Host: GitHub
URL: https://github.com/theangrybyrd/miniscaffold
Owner: TheAngryByrd
License: mit
Created: 2017-03-24T02:26:26.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-11-19T17:23:12.000Z (12 months ago)
Last Synced: 2024-10-12T21:03:47.985Z (about 1 month ago)
Topics: dotnet, dotnet-core, dotnet-framework, dotnet-template, fsharp, scaffold
Language: F#
Homepage: https://www.jimmybyrd.me/MiniScaffold/
Size: 1.65 MB
Stars: 267
Watchers: 8
Forks: 31
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # MiniScaffold

## What is MiniScaffold?

This is an [F# Template](https://docs.microsoft.com/en-us/dotnet/core/tools/custom-templates) for:

- creating and publishing [libraries](https://docs.microsoft.com/en-us/dotnet/standard/glossary#library) targeting .NET 6.0 `net6.0`

- creating and publishing [applications](https://docs.microsoft.com/en-us/dotnet/core/tutorials/cli-create-console-app#hello-console-app) targeting .NET 6.0 `net6.0`

## Why use MiniScaffold

This takes away the ambiguity that developers face when creating an OSS project. Such as:

- How do I structure my project?

- How do I create repeatable builds?

- Which test framework should I use?

- How do I create releases easily?

- What Issue/Pull Request templates should I use?

- How should I go about creating documentation?

- How do I get CI/CD setup easily?

- What's the standard .gitignore file?

- What other things would make it easier for me when starting off creating a project I might not even know about?

## What does this include in the box?

### All project types

- [Standard project structure](https://docs.microsoft.com/en-us/dotnet/core/porting/project-structure) for your dotnet application

- [Build Automation](https://en.wikipedia.org/wiki/Build_automation) tool via [FAKE](https://fake.build/)

- [Package management](https://en.wikipedia.org/wiki/Package_manager) tool via [Paket](https://fsprojects.github.io/Paket/)

- [Unit Testing](https://en.wikipedia.org/wiki/Unit_testing) via [Expecto](https://github.com/haf/expecto)

- [Code Coverage](https://en.wikipedia.org/wiki/Code_coverage) via [Altcover](https://github.com/SteveGilham/altcover)

    - Also builds an html report with [ReportGenerator](https://github.com/danielpalme/ReportGenerator)

- [Code formatting](https://en.wikipedia.org/wiki/Programming_style) style via [Fantomas](https://github.com/fsprojects/fantomas)

- `GitRelease` build step commits latest [CHANGELOG.md](https://keepachangelog.com/en/1.0.0/) in the body and creates a [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).

    - If you [reference a Pull Request](https://github.com/TheAngryByrd/MiniScaffold/blob/master/CHANGELOG.md#0230-beta001---2020-02-07) in the `CHANGELOG.md` it will [update that Pull Request](https://github.com/TheAngryByrd/MiniScaffold/pull/186#ref-commit-b343218) with the version it was released in.

- `GitHubRelease` build step publishes a [GitHub Release](https://help.github.com/en/articles/creating-releases) via the  [CHANGELOG.md](https://keepachangelog.com/en/1.0.0/) and adds any artifacts (nuget/zip/targz/etc).

- [Continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) via [GitHub Actions](https://github.com/features/actions)

### For [Libraries](Content/Library/README.md)

- Builds for `net6.0` - [Target Frameworks](https://docs.microsoft.com/en-us/dotnet/standard/frameworks)

    - To build for `net6.0` [.NET 6.0 ](https://dotnet.microsoft.com/download) installed

- [Sourcelink](https://github.com/dotnet/sourcelink) which enables a great source debugging experience for your users, by adding source control metadata to your built assets

- [Documentation Generation](https://github.com/fsprojects/FSharp.Formatting) - Generates Documentation from markdown files, fsx files, and the [XML Documentation Comments](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/) from your library.

- [Continuous deployment](https://en.wikipedia.org/wiki/Continuous_deployment) via [GitHub Actions](https://github.com/features/actions)

    - [Publish to NuGet] - Pushes NuGet packages to [NuGet](https://docs.microsoft.com/en-us/nuget/what-is-nuget)

        - Generates [Package Version](https://docs.microsoft.com/en-us/nuget/reference/nuspec#version) from `CHANGELOG.md`

        - Adds [Package Release Notes](https://docs.microsoft.com/en-us/nuget/reference/nuspec#releasenotes) metadata from `CHANGELOG.md`

    - [Documentation Publish] - Publish Documenation to [Github Pages](https://pages.github.com/)

### For [Applications](Content/Console/README.md)

- Basic argument parsing example via [Argu](https://fsprojects.github.io/Argu/)

- Builds a `net6.0` application - [Target Frameworks](https://docs.microsoft.com/en-us/dotnet/standard/frameworks)

    - To build for `net6.0`

        - Have [.NET 6.0](https://dotnet.microsoft.com/download) installed

- Builds for `win-x64`, `osx-x64` and `linux-x64` - [Runtime Identifiers](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog).  Bundles the application via [dotnet-packaging](https://github.com/qmfrederik/dotnet-packaging)

    - Bundles the `win-x64` application in a .zip file.

    - Bundles the `osx-x64` application in a .tar.gz file.

    - Bundles the `linux-x64` application in a .tar.gz file.

---

## Getting started quickly

### Install the [dotnet template](https://docs.microsoft.com/en-us/dotnet/core/tools/custom-templates) from NuGet:

```

dotnet new install "MiniScaffold::*"

```

Then choose:

- [I want to build a Library](Content/Library/README.md)

```

dotnet new mini-scaffold -n MyCoolNewLib --githubUsername MyGithubUsername

```

- [I want to build an Application](Content/Console/README.md)

```

dotnet new mini-scaffold -n MyCoolNewApp --githubUsername MyGithubUsername -ou console

```

The scaffold defaults to using the `main` branch for releases. If you release from a different branch, you can use the `--releaseBranch ` parameter to use your release branch instead of the default.

---

## Builds

GitHub Actions |

:---: |

[![GitHub Actions](https://github.com/TheAngryByrd/MiniScaffold/workflows/Build%20master/badge.svg)](https://github.com/TheAngryByrd/MiniScaffold/actions?query=branch%3Amaster) |

[![Build History](https://buildstats.info/github/chart/TheAngryByrd/MiniScaffold)](https://github.com/TheAngryByrd/MiniScaffold/actions?query=branch%3Amaster) |

## NuGet

Stable | Prerelease

:---: | :---:

[![NuGet Badge](https://buildstats.info/nuget/MiniScaffold)](https://www.nuget.org/packages/MiniScaffold/) | [![NuGet Badge](https://buildstats.info/nuget/MiniScaffold?includePreReleases=true)](https://www.nuget.org/packages/MiniScaffold/)

---

## Options

### githubUserName

This is used to automatically configure author information in the NuGet package, as well as configure push urls for repo locations.

### outputType

Defaults to Library

When set to either Console or Library project and the supporting infrastructure around their respective types.

---

## Known issues

### Permission denied

```

-bash: ./build.sh: Permission denied

```

This is because dotnet template loses permissions of files. (https://github.com/TheAngryByrd/MiniScaffold/pull/37) added a post hook to address this but this only fixes it for dotnet sdk 2.x users.  dotnet sdk 1.x will need to run `chmod +x ./build.sh`

### Appveyor badge not scaffolded correctly

Appveyor's conventions around generating URLs based on the project name has some nuances.  See [this issue](https://github.com/TheAngryByrd/MiniScaffold/issues/63) for details.

---

#### Example Projects using this template:

* [Chessie.Hopac](https://github.com/TheAngryByrd/Chessie.Hopac)

* [Marten.FSharp](https://github.com/TheAngryByrd/Marten.FSharp)

* [FSharp.Control.WebSockets](https://github.com/TheAngryByrd/FSharp.Control.WebSockets)

* [FSharp.Control.Redis.Streams](https://github.com/TheAngryByrd/FSharp.Control.Redis.Streams)

* [FsLibLog](https://github.com/TheAngryByrd/FsLibLog)

* [Giraffe.HotReload](https://github.com/baronfel/Giraffe.HotReload)

* [EFCore.FSharp](https://github.com/efcore/EFCore.FSharp)

#### This project uses the following projects:

* Heavily inspired by [Project Scaffold](https://github.com/fsprojects/ProjectScaffold)

* [Paket](https://fsprojects.github.io/Paket/)

* [FAKE](https://fsharp.github.io/FAKE/)

* [Expecto](https://github.com/haf/expecto)

* [Buildstats.info](https://github.com/dustinmoris/CI-BuildStats)

* [Source Link](https://github.com/ctaggart/SourceLink)

* [AltCover](https://github.com/SteveGilham/altcover)

* [ReportGenerator](https://github.com/danielpalme/ReportGenerator)

* [Fantomas](https://github.com/fsprojects/fantomas)

* [Argu](https://github.com/fsprojects/Argu)

* [dotnet-packaging](https://github.com/qmfrederik/dotnet-packaging)

* [FSharp.Formatting](https://github.com/fsprojects/FSharp.Formatting)