Merge pull request #52 from giraffe-fsharp/net8

Rewrite for .NET 8

Author: dbrattli

README.md

@@ -10,29 +10,39 @@ Giraffe web application template for the `dotnet new` command.
 
 ## Table of contents
 
-- [Installation](#installation)
-- [Updating the template](#updating-the-template)
-- [Basics](#basics)
-- [Template Options](#template-options)
+- [Giraffe Template](#giraffe-template)
+  - [Table of contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Updating the template](#updating-the-template)
+  - [Basics](#basics)
+  - [Template Options](#template-options)
     - [ViewEngine](#viewengine)
     - [Solution](#solution)
     - [ExcludeTests](#excludetests)
     - [Paket](#paket)
-- [Known Issues](#known-issues)
+  - [Known Issues](#known-issues)
     - [Cyclic reference](#cyclic-reference)
     - [.NET Core 2.0 issues](#net-core-20-issues)
     - [Using Visual Studio](#using-visual-studio)
-- [Nightly builds and NuGet feed](#nightly-builds-and-nuget-feed)
-- [Contributing](#contributing)
-- [More information](#more-information)
-- [License](#license)
+        - [Example:](#example)
+  - [Nightly builds and NuGet feed](#nightly-builds-and-nuget-feed)
+  - [Contributing](#contributing)
+    - [Examples](#examples)
+      - [Default](#default)
+      - [Installing the new template](#installing-the-new-template)
+      - [Creating a test project for each permutation](#creating-a-test-project-for-each-permutation)
+      - [Creating and testing all test projects for all permutations](#creating-and-testing-all-test-projects-for-all-permutations)
+      - [Creating and testing all permutations and updating the `paket.lock` file afterwards](#creating-and-testing-all-permutations-and-updating-the-paketlock-file-afterwards)
+      - [Testling the template locally](#testling-the-template-locally)
+  - [More information](#more-information)
+  - [License](#license)
 
 ## Installation
 
 The easiest way to install the Giraffe template is by running the following command in your terminal:
 
 ```
-dotnet new -i "giraffe-template::*"
+dotnet new install "giraffe-template::*"
 ```
 
 This will pull and install the latest [giraffe-template NuGet package](https://www.nuget.org/packages/giraffe-template/) into your .NET environment and make it available to subsequent `dotnet new` commands.
@@ -43,21 +53,21 @@ Whenever there is a new version of the Giraffe template you can update it by re-
 
 You can also explicitly set the version when installing the template:
 
-```
-dotnet new -i "giraffe-template::1.4.0"
+```console
+dotnet new install "giraffe-template::1.4.0"
 ```
 
 ## Basics
 
 After the template has been installed you can create a new Giraffe web application by simply running `dotnet new giraffe` in your terminal:
 
-```
+```console
 dotnet new giraffe
 ```
 
 If you wish to use [Paket](https://fsprojects.github.io/Paket/) for your dependency management use the `--Paket` or `-P` parameter when creating a new application:
 
-```
+```console
 dotnet new giraffe --Paket
 ```
 
@@ -80,13 +90,13 @@ The Giraffe template supports four project templates, three different view engin
 
 Use the `--ViewEngine` parameter (short `-V`) to set one of the supported values from above:
 
-```
+```console
 dotnet new giraffe --ViewEngine razor
 ```
 
 The same command can be abbreviated using the `-V` parameter:
 
-```
+```console
 dotnet new giraffe -V razor
 ```
 
@@ -96,13 +106,13 @@ If you do not specify the `--ViewEngine` parameter then the `dotnet new giraffe`
 
 When running `dotnet new giraffe` the created project will only be a single Giraffe project which can be added to an existing .NET Core solution. However, when generating a new Giraffe project from a blank sheet then the `--Solution` (or short `-S`) parameter can simplify the generation of an entire solution, including a `.sln` file and accompanied test projects:
 
-```
+```console
 dotnet new giraffe --Solution
 ```
 
 This will create the following structure:
 
-```
+```text
 src/
   - AppName/
       - Views/
@@ -158,7 +168,7 @@ The affected SDKs are `2.1.x` where `x < 300`. The issue has been fixed in the S
 
 If you do run into this issue the workaround is to explicitly specify the language:
 
-```
+```console
 dotnet new giraffe -lang F#
 ```
 
@@ -176,7 +186,7 @@ All official Giraffe packages are published to the official and public NuGet fee
 
 Unofficial builds (such as pre-release builds from the `develop` branch and pull requests) produce unofficial pre-release NuGet packages which can be pulled from the project's public NuGet feed on AppVeyor:
 
-```
+```url
 https://ci.appveyor.com/nuget/giraffe-template
 ```
 
@@ -198,7 +208,7 @@ The `./build.ps1` PowerShell script comes with the following feature switches:
 
 ### Examples
 
-#### Default:
+#### Default
 
 Windows:
 
@@ -212,7 +222,7 @@ macOS and Linux:
 $ pwsh ./build.ps1
 ```
 
-#### Installing the new template:
+#### Installing the new template
 
 Windows:
 
@@ -226,7 +236,7 @@ macOS and Linux:
 $ pwsh ./build.ps1 -InstallTemplate
 ```
 
-#### Creating a test project for each permutation:
+#### Creating a test project for each permutation
 
 Windows:
 
@@ -240,7 +250,7 @@ macOS and Linux:
 $ pwsh ./build.ps1 -CreatePermutations
 ```
 
-#### Creating and testing all test projects for all permutations:
+#### Creating and testing all test projects for all permutations
 
 Windows:
 
@@ -254,7 +264,7 @@ macOS and Linux:
 $ pwsh ./build.ps1 -TestPermutations
 ```
 
-#### Creating and testing all permutations and updating the `paket.lock` file afterwards:
+#### Creating and testing all permutations and updating the `paket.lock` file afterwards
 
 Windows:
 
@@ -268,6 +278,40 @@ macOS and Linux:
 $ pwsh ./build.ps1 -UpdatePaketDependencies
 ```
 
+#### Testling the template locally
+
+If you already have giraffe-template installed, then
+
+```console
+$ dotnet new uninstall giraffe-template
+```
+
+This will install from the local file system
+
+```console
+dotnet new install ./src/ --force
+```
+
+To uninstall later:
+
+```console
+$ dotnet new uninstall <some-path>/giraffe-template/src
+```
+
+To use the template:
+
+```console
+dotnet new giraffe
+```
+
+Test it locally:
+
+```console
+dotnet run --project giraffe-template.fsproj
+```
+
+Remember to remove the template generated files
+
 ## More information
 
 For more information about Giraffe, how to set up a development environment, contribution guidelines and more please visit the [main documentation](https://github.com/giraffe-fsharp/Giraffe#table-of-contents) page.

RELEASE_NOTES.md

@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+## 1.5.0
+
+- Updated templates to .NET 8 and latest Giraffe
+
+
 ## 1.4.0
 
 - Updated templates to .NET 7 and latest Giraffe

appveyor.yml

@@ -5,7 +5,7 @@ environment:
 init:
   - git config --global core.autocrlf true
 install:
-  - ps: .\.psscripts\install-dotnet.ps1 -SdkVersions "7.0.304"
+  - ps: .\.psscripts\install-dotnet.ps1 -SdkVersions "8.0.202"
 build: off
 build_script:
   - ps: .\build.ps1

global.json

@@ -1,7 +1,7 @@
 {
     "projects": [ "src", "tests" ],
     "sdk": {
-        "version": "7.0.304",
+        "version": "8.0.202",
         "rollForward": "latestMajor",
         "allowPrerelease": false
     }

src/content/DotLiquid/paket.dependencies

@@ -2,7 +2,7 @@ storage: none
 framework: auto-detect
 source https://api.nuget.org/v3/index.json
 
-nuget Giraffe ~> 6.0.0
+nuget Giraffe ~> 6.4.0
 nuget Giraffe.DotLiquid >= 3 prerelease
 nuget Microsoft.NET.Test.Sdk
 nuget Microsoft.AspNetCore.TestHost

src/content/DotLiquid/paket.lock

@@ -1,9 +1,9 @@
 STORAGE: NONE
-RESTRICTION: == net7.0
+RESTRICTION: == net8.0
 NUGET
   remote: https://api.nuget.org/v3/index.json
     DotLiquid (2.2.692)
-    FSharp.Core (7.0.400)
+    FSharp.Core (8.0.200)
     Giraffe (6.0)
       FSharp.Core (>= 6.0.1)
       Giraffe.ViewEngine (>= 1.3)
@@ -18,58 +18,50 @@ NUGET
       Ply (>= 0.3.1)
     Giraffe.ViewEngine (1.4)
       FSharp.Core (>= 5.0)
-    Microsoft.AspNetCore.TestHost (7.0.10)
-      System.IO.Pipelines (>= 7.0)
-    Microsoft.CodeCoverage (17.7)
-    Microsoft.IO.RecyclableMemoryStream (2.3.2)
-    Microsoft.NET.Test.Sdk (17.7)
-      Microsoft.CodeCoverage (>= 17.7)
-      Microsoft.TestPlatform.TestHost (>= 17.7)
-    Microsoft.NETCore.Platforms (7.0.4)
-    Microsoft.TestPlatform.ObjectModel (17.7)
-      NuGet.Frameworks (>= 6.5)
+    Microsoft.AspNetCore.TestHost (8.0.4)
+      System.IO.Pipelines (>= 8.0)
+    Microsoft.CodeCoverage (17.9)
+    Microsoft.IO.RecyclableMemoryStream (3.0)
+    Microsoft.NET.Test.Sdk (17.9)
+      Microsoft.CodeCoverage (>= 17.9)
+      Microsoft.TestPlatform.TestHost (>= 17.9)
+    Microsoft.TestPlatform.ObjectModel (17.9)
       System.Reflection.Metadata (>= 1.6)
-    Microsoft.TestPlatform.TestHost (17.7)
-      Microsoft.TestPlatform.ObjectModel (>= 17.7)
+    Microsoft.TestPlatform.TestHost (17.9)
+      Microsoft.TestPlatform.ObjectModel (>= 17.9)
       Newtonsoft.Json (>= 13.0.1)
-    NETStandard.Library (2.0.3)
-      Microsoft.NETCore.Platforms (>= 1.1)
     Newtonsoft.Json (13.0.3)
-    NuGet.Frameworks (6.7)
     Ply (0.3.1)
       FSharp.Core (>= 4.6.2)
       System.Threading.Tasks.Extensions (>= 4.5.4)
-    System.Collections.Immutable (7.0)
-    System.IO.Pipelines (7.0)
+    System.Collections.Immutable (8.0)
+    System.IO.Pipelines (8.0)
     System.Reflection.Emit (4.7)
     System.Reflection.Emit.Lightweight (4.7)
-    System.Reflection.Metadata (7.0.2)
-      System.Collections.Immutable (>= 7.0)
-    System.Text.Encodings.Web (7.0)
-    System.Text.Json (7.0.3)
-      System.Text.Encodings.Web (>= 7.0)
+    System.Reflection.Metadata (8.0)
+      System.Collections.Immutable (>= 8.0)
+    System.Text.Encodings.Web (8.0)
+    System.Text.Json (8.0.3)
+      System.Text.Encodings.Web (>= 8.0)
     System.Threading.Tasks.Extensions (4.5.4)
     System.ValueTuple (4.5)
     Utf8Json (1.3.7)
       System.Reflection.Emit (>= 4.3)
       System.Reflection.Emit.Lightweight (>= 4.3)
       System.Threading.Tasks.Extensions (>= 4.4)
       System.ValueTuple (>= 4.4)
-    xunit (2.5)
-      xunit.analyzers (>= 1.2)
-      xunit.assert (>= 2.5)
-      xunit.core (2.5)
+    xunit (2.8)
+      xunit.analyzers (>= 1.13)
+      xunit.assert (>= 2.8)
+      xunit.core (2.8)
     xunit.abstractions (2.0.3)
-    xunit.analyzers (1.2)
-    xunit.assert (2.5)
-      NETStandard.Library (>= 1.6.1)
-    xunit.core (2.5)
-      xunit.extensibility.core (2.5)
-      xunit.extensibility.execution (2.5)
-    xunit.extensibility.core (2.5)
-      NETStandard.Library (>= 1.6.1)
+    xunit.analyzers (1.13)
+    xunit.assert (2.8)
+    xunit.core (2.8)
+      xunit.extensibility.core (2.8)
+      xunit.extensibility.execution (2.8)
+    xunit.extensibility.core (2.8)
       xunit.abstractions (>= 2.0.3)
-    xunit.extensibility.execution (2.5)
-      NETStandard.Library (>= 1.6.1)
-      xunit.extensibility.core (2.5)
-    xunit.runner.visualstudio (2.5)
+    xunit.extensibility.execution (2.8)
+      xunit.extensibility.core (2.8)
+    xunit.runner.visualstudio (2.8)

src/content/DotLiquid/src/AppName.1/AppName.1.fsproj

@@ -1,25 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project Sdk="Microsoft.NET.Sdk.Web">
-
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
-    <AssemblyName>AppName.1.App</AssemblyName>
+    <TargetFramework>net8.0</TargetFramework>
+    <AssemblyName>AppName.1</AssemblyName>
     <EnableDefaultContentItems>false</EnableDefaultContentItems>
+    <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
   </PropertyGroup>
-
   <ItemGroup Condition="'$(Paket)' == false OR '$(Paket)' == ''">
-    <PackageReference Include="Giraffe" Version="6.0.0" />
+    <PackageReference Include="Giraffe" Version="6.4.0" />
     <PackageReference Include="Giraffe.DotLiquid" Version="3.0.0-rc-1" />
   </ItemGroup>
-
   <ItemGroup>
     <Watch Include="**\*.html" Exclude="bin\**\*" />
   </ItemGroup>
-
   <ItemGroup>
     <Compile Include="Models.fs" />
     <Compile Include="Program.fs" />
   </ItemGroup>
-
   <ItemGroup>
     <None Include="web.config" CopyToOutputDirectory="PreserveNewest" />
     <None Condition="'$(Paket)' == true" Include="paket.references" />