diff --git a/CHANGELOG.md b/CHANGELOG.md index 0acc9bc..6cdbcaa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # CHANGELOG +## 1.0.10 + +### added + +* documentation examples + +### changed + +* moved to xunit.v3 + ## 1.0.9 * changed global and target framework to net10 diff --git a/README.md b/README.md index 23ae9a2..d9eebb9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The source file can contain directives to reference libraries and to influence t Because of a) concerns of parts of the F# community about having two similar tools (`dotnet fsi script.fsx` and `dotnet runfs app.fs`) and b) missing "market pull", I have currently no further plans for this project. -The tool is still available as dotnet tool and can be useful especially for ad-hoc testing of library projects. +The tool is still available as dotnet tool and can be useful especially for [ad-hoc testing of library projects](docs/examples/testing/README.md). ## Usage diff --git a/docs/examples/testing/README.md b/docs/examples/testing/README.md new file mode 100644 index 0000000..246433d --- /dev/null +++ b/docs/examples/testing/README.md @@ -0,0 +1,10 @@ +# Using runfs for library testing + +## Explorative testing + +Just create an ad-hoc driver file (see example file `explore.fs` in this directory), add a project reference and start testing your library API by running `dotnet runfs explore.fs`. + +## Unit test development / fixes + +Rather than building a test project, discovering the tests, selecting the one you are interested in and running it, you just add the project reference and the test framework package reference to the test file you are interested in (see example file `tests.fs`, using xunit.v3) and run it with runfs (here: `dotnet runfs tests.fs`). + diff --git a/docs/examples/testing/explore.fs b/docs/examples/testing/explore.fs new file mode 100644 index 0000000..0dbfb47 --- /dev/null +++ b/docs/examples/testing/explore.fs @@ -0,0 +1,5 @@ +#r_project "D:/fsharp/projects/div/Runfs/docs/examples/testing/mylib/mylib.fsproj" + +open Mylib + +printfn $"Hello {x}" diff --git a/docs/examples/testing/mylib/Directory.Build.props b/docs/examples/testing/mylib/Directory.Build.props new file mode 100644 index 0000000..c339825 --- /dev/null +++ b/docs/examples/testing/mylib/Directory.Build.props @@ -0,0 +1,5 @@ + + + true + + diff --git a/docs/examples/testing/mylib/Library.fs b/docs/examples/testing/mylib/Library.fs new file mode 100644 index 0000000..4b5de8c --- /dev/null +++ b/docs/examples/testing/mylib/Library.fs @@ -0,0 +1,3 @@ +module Mylib + +let x = 42 diff --git a/docs/examples/testing/mylib/mylib.fsproj b/docs/examples/testing/mylib/mylib.fsproj new file mode 100644 index 0000000..b35881d --- /dev/null +++ b/docs/examples/testing/mylib/mylib.fsproj @@ -0,0 +1,11 @@ + + + + net10.0 + + + + + + + diff --git a/docs/examples/testing/tests.fs b/docs/examples/testing/tests.fs new file mode 100644 index 0000000..f351690 --- /dev/null +++ b/docs/examples/testing/tests.fs @@ -0,0 +1,13 @@ +module Mylib.Tests + +#r_package "xunit.v3.mtp-v2@3.2.2" +#r_project "mylib/mylib.fsproj" + +#nowarn 988 + +open Xunit +open Mylib + +[] +let test1 () = + Assert.Equal(x, 42) diff --git a/global.json b/global.json index 69e101b..7cceb99 100644 --- a/global.json +++ b/global.json @@ -3,5 +3,8 @@ "version": "10.0.100", "rollForward": "latestMinor", "allowPrerelease": false + }, + "test": { + "runner": "Microsoft.Testing.Platform" } -} \ No newline at end of file +} diff --git a/src/Runfs/Runfs.fsproj b/src/Runfs/Runfs.fsproj index a82ee05..e11908f 100644 --- a/src/Runfs/Runfs.fsproj +++ b/src/Runfs/Runfs.fsproj @@ -2,7 +2,7 @@ Runfs - 1.0.9 + 1.0.10 "dotnet run app.cs" functionality for F#. Copyright 2025 by Martin521 Martin521 and contributors @@ -15,12 +15,15 @@ True runfs -## 1.0.9 +## 1.0.10 + +### added + +* documentation examples ### changed -* changed global and target framework to net10 -* updated README +* moved to xunit.v3 true diff --git a/tests/Runfs.Tests/Runfs.Tests.fsproj b/tests/Runfs.Tests/Runfs.Tests.fsproj index 2263448..ef64dd3 100644 --- a/tests/Runfs.Tests/Runfs.Tests.fsproj +++ b/tests/Runfs.Tests/Runfs.Tests.fsproj @@ -1,23 +1,14 @@ net10.0 + Exe - - - - - - - - - all - runtime; build; native; contentfiles; analyzers; buildtransitive - +