@Model.Module.Name
35 |
36 | Defined in @(Model.Module.Assembly.Name).dll.
37 |
38 |
39 | @foreach (var sec in comment.Sections) {
40 | // XML comment for the type has multiple sections that can be labelled
41 | // with categories (to give comment for an individual category). Here,
42 | // we print only those that belong to the section.
43 | if (!byCategory.Any(g => g.GroupKey == sec.Key))
44 | {
45 | if (sec.Key != "") {
46 |
52 | @if (byCategory.Count() > 1)
53 | {
54 |
55 | @sec.Key
47 | } 48 | @sec.Value 49 | } 50 | } 51 |Table of contents
56 |-
57 | @foreach (var g in byCategory)
58 | {
59 |
- @g.Name 60 | } 61 |
Nested types and modules
68 |
69 | @RenderPart("part-nested", new {
70 | Types = nestTypes,
71 | Modules = nestModules
72 | })
73 |
74 | }
75 |
76 | @foreach (var g in byCategory)
77 | {
78 | // Iterate over all the categories and print members. If there are more than one
79 | // categories, print the category heading (as ) and add XML comment from the type
80 | // that is related to this specific category.
81 | if (byCategory.Count() > 1)
82 | {
83 | @g.Name
84 | var info = comment.Sections.FirstOrDefault(kvp => kvp.Key == g.GroupKey);
85 | if (info.Key != null)
86 | {
87 |
88 | @info.Value
89 |
90 | }
91 | }
92 |
93 | @RenderPart("part-members", new {
94 | Header = "Functions and values",
95 | TableHeader = "Function or value",
96 | Members = g.Members.Where(m => m.Kind == MemberKind.ValueOrFunction)
97 | })
98 |
99 | @RenderPart("part-members", new {
100 | Header = "Type extensions",
101 | TableHeader = "Type extension",
102 | Members = g.Members.Where(m => m.Kind == MemberKind.TypeExtension)
103 | })
104 |
105 | @RenderPart("part-members", new {
106 | Header = "Active patterns",
107 | TableHeader = "Active pattern",
108 | Members = g.Members.Where(m => m.Kind == MemberKind.ActivePattern)
109 | })
110 | }
--------------------------------------------------------------------------------
/doc/templates/reference/namespaces.cshtml:
--------------------------------------------------------------------------------
1 | @{
2 | Layout = "template";
3 | Title = "Namespaces - " + Properties["project-name"];
4 | }
5 |
6 | @Model.Name
7 |
8 | Overview
9 | @foreach (var ns in Model.Namespaces)
10 | {
11 | if (ns.Types.Length + ns.Modules.Length > 0)
12 | {
13 | @ns.Name
14 | }
15 | }
16 |
17 | @foreach (var ns in Model.Namespaces)
18 | {
19 | if (ns.Types.Length + ns.Modules.Length > 0)
20 | {
21 | 
@ns.Name Namespace
22 |
23 | @RenderPart("part-nested", new {
24 | Types = ns.Types,
25 | Modules = ns.Modules
26 | })
27 |
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/doc/templates/reference/part-members.cshtml:
--------------------------------------------------------------------------------
1 | @if (Enumerable.Count(Model.Members) > 0) {
2 | @Model.Header
3 |
@ns.Name Namespace| @Model.TableHeader | Description |
12 | @{ var id = Html.UniqueID().ToString(); }
13 |
14 | @Html.Encode(it.Details.FormatUsage(40))
15 |
16 |
17 | Signature: @Html.Encode(it.Details.Signature)
25 | 18 | @if (!it.Details.Modifiers.IsEmpty) { 19 | Modifiers: @it.Details.FormatModifiers 20 | } 21 | @if (!it.Details.TypeArguments.IsEmpty) { 22 | Type parameters: @it.Details.FormatTypeArguments 23 | } 24 | |
26 |
27 | @if (!String.IsNullOrEmpty(it.Details.FormatSourceLocation))
28 | {
29 |
30 | 
31 | 
32 |
33 | }
34 | @it.Comment.FullText
35 | |
36 |
| Type | Description |
| 11 | @it.Name 12 | | 13 |@it.Comment.Blurb | 14 |
| Module | Description |
| 29 | @it.Name 30 | | 31 |@it.Comment.Blurb | 32 |
@Model.Type.Name
31 |
32 | Defined in @(Model.Type.Assembly.Name).dll.
33 |
34 |
35 | @foreach (var sec in comment.Sections) {
36 | // XML comment for the type has multiple sections that can be labelled
37 | // with categories (to give comment for an individual category). Here,
38 | // we print only those that belong to the section.
39 | if (!byCategory.Any(g => g.GroupKey == sec.Key)) {
40 | if (sec.Key != "") {
41 |
47 | @if (byCategory.Count() > 1)
48 | {
49 |
50 | @sec.Key
42 | } 43 | @sec.Value 44 | } 45 | } 46 |Table of contents
51 |-
52 | @foreach (var g in byCategory)
53 | {
54 |
- @g.Name 55 | } 56 |
) and add XML comment from the type
61 | // that is related to this specific category.
62 | if (byCategory.Count() > 1) {
63 | @g.Name
64 | var info = comment.Sections.FirstOrDefault(kvp => kvp.Key == g.GroupKey);
65 | if (info.Key != null) {
66 |
67 | @info.Value
68 |
69 | }
70 | }
71 |
72 | @RenderPart("part-members", new {
73 | Header = "Union Cases",
74 | TableHeader = "Union Case",
75 | Members = g.Members.Where(m => m.Kind == MemberKind.UnionCase)
76 | })
77 |
78 | @RenderPart("part-members", new {
79 | Header = "Record Fields",
80 | TableHeader = "Record Field",
81 | Members = g.Members.Where(m => m.Kind == MemberKind.RecordField)
82 | })
83 |
84 | @RenderPart("part-members", new {
85 | Header = "Static parameters",
86 | TableHeader = "Static parameters",
87 | Members = g.Members.Where(m => m.Kind == MemberKind.StaticParameter)
88 | })
89 |
90 | @RenderPart("part-members", new {
91 | Header = "Constructors",
92 | TableHeader = "Constructor",
93 | Members = g.Members.Where(m => m.Kind == MemberKind.Constructor)
94 | })
95 |
96 | @RenderPart("part-members", new {
97 | Header = "Instance members",
98 | TableHeader = "Instance member",
99 | Members = g.Members.Where(m => m.Kind == MemberKind.InstanceMember)
100 | })
101 |
102 | @RenderPart("part-members", new {
103 | Header = "Static members",
104 | TableHeader = "Static member",
105 | Members = g.Members.Where(m => m.Kind == MemberKind.StaticMember)
106 | })
107 | }
108 |
--------------------------------------------------------------------------------
/doc/templates/template-color.tex:
--------------------------------------------------------------------------------
1 | \documentclass{article}
2 |
3 | % Defining colors by names
4 | \usepackage{xcolor}
5 | % Verbatim enviroment
6 | \usepackage{fancyvrb}
7 | % Verbatim enviroment for unformatted source code
8 | \usepackage{listings}
9 | % Better font for backslash
10 | \usepackage[T1]{fontenc}
11 | \usepackage{hyperref}
12 | % Providing more features than usual tabular
13 | \usepackage{longtable}
14 |
15 | % Identifiers in color code #000000
16 | \newcommand{\id}[1]{\textcolor{black}{#1}}
17 |
18 | % Comments in green
19 | \definecolor{officegreen}{rgb}{0, 0.5, 0}
20 | \newcommand{\com}[1]{\textcolor{officegreen}{#1}}
21 |
22 | % Inactive elements in color code #808080
23 | \newcommand{\inact}[1]{\textcolor{gray}{#1}}
24 |
25 | % Keywords in color code #000080
26 | \definecolor{navy}{rgb}{0, 0, 0.5}
27 | \newcommand{\kwd}[1]{\textcolor{navy}{#1}}
28 |
29 | % Numbers in color code #008000
30 | \newcommand{\num}[1]{\textcolor{officegreen}{#1}}
31 |
32 | % Operators in color code #800080
33 | \newcommand{\ops}[1]{\textcolor{purple}{#1}}
34 |
35 | % Preprocessors in color code #800080
36 | \newcommand{\prep}[1]{\textcolor{purple}{#1}}
37 |
38 | % Strings in color code #808000
39 | \newcommand{\str}[1]{\textcolor{olive}{#1}}
40 |
41 | % Lines in color code #80b0b0
42 | % Define relative color to work correctly with \newcommand
43 | \definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
44 | \newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
45 |
46 | % fsi output in color code #606060
47 | \definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
48 | \newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
49 |
50 | % Omitted parts in color code #808080
51 | \newcommand{\omi}[1]{\textcolor{gray}{#1}}
52 |
53 | % Overriding color and style of line numbers
54 | \renewcommand{\theFancyVerbLine}{
55 | \lines{\small \arabic{FancyVerbLine}:}}
56 |
57 | \lstset{%
58 | backgroundcolor=\color{gray!15},
59 | basicstyle=\ttfamily,
60 | breaklines=true,
61 | columns=fullflexible
62 | }
63 |
64 | \title{{page-title}}
65 | \date{}
66 |
67 | \begin{document}
68 |
69 | \maketitle
70 |
71 | {contents}
72 |
73 | {tooltips}
74 |
75 | \end{document}
76 |
--------------------------------------------------------------------------------
/doc/templates/template-math.tex:
--------------------------------------------------------------------------------
1 | \documentclass{article}
2 |
3 | % Defining colors by names
4 | \usepackage{xcolor}
5 | % Verbatim enviroment
6 | \usepackage{fancyvrb}
7 | % Verbatim enviroment for unformatted source code
8 | \usepackage{listings}
9 | % Better font for backslash
10 | \usepackage[T1]{fontenc}
11 | \usepackage{hyperref}
12 | % Providing more features than usual tabular
13 | \usepackage{longtable}
14 | % Augment with more font faces
15 | \usepackage{bera}
16 | % More math symbols
17 | \usepackage{amssymb}
18 |
19 | % Simple key value store
20 | % (source at http://tex.stackexchange.com/questions/48907/global-key-value-dictionary)
21 | \def\addvalue#1#2{\expandafter\gdef\csname my@data@\detokenize{#1}\endcsname{#2}}
22 | \def\usevalue#1{%
23 | \ifcsname my@data@\detokenize{#1}\endcsname
24 | \csname my@data@\detokenize{#1}\expandafter\endcsname
25 | \else
26 | % if not found, return key as value
27 | {#1}\expandafter
28 | \fi
29 | }
30 |
31 | \addvalue{>=}{$\geq$}
32 | \addvalue{<=}{$\leq$}
33 | \addvalue{<>}{$\neq$}
34 | \addvalue{not}{$\neg$}
35 | \addvalue{&&}{$\land$}
36 | \addvalue{||}{$\lor$}
37 | \addvalue{->}{$\rightarrow$}
38 | \addvalue{<-}{$\leftarrow$}
39 | \addvalue{=>}{$\Rightarrow$}
40 | \addvalue{*}{$\times$}
41 | \addvalue{|>}{$\blacktriangleright$}
42 | \addvalue{<|}{$\blacktriangleleft$}
43 |
44 | % Identifiers
45 | \newcommand{\id}[1]{\texttt{#1}}
46 |
47 | % Comments
48 | \newcommand{\com}[1]{\textit{#1}}
49 |
50 | % Inactive elements
51 | \newcommand{\inact}[1]{\textmd{#1}}
52 |
53 | % Keywords
54 | \newcommand{\kwd}[1]{\textbf{#1}}
55 |
56 | % Numbers
57 | \newcommand{\num}[1]{\textrm{#1}}
58 |
59 | % Operators
60 | \newcommand{\ops}[1]{\usevalue{#1}}
61 |
62 | % Preprocessors
63 | \newcommand{\prep}[1]{\textsf{#1}}
64 |
65 | % Strings
66 | \newcommand{\str}[1]{\textrm{#1}}
67 |
68 | % Line numbers
69 | \newcommand{\lines}[1]{\textrm{#1}}
70 |
71 | % fsi output
72 | \newcommand{\fsi}[1]{\textsf{#1}}
73 |
74 | % Omitted parts
75 | \newcommand{\omi}[1]{\textsc{#1}}
76 |
77 | % Overriding color and style of line numbers
78 | \renewcommand{\theFancyVerbLine}{
79 | \lines{\small \arabic{FancyVerbLine}:}}
80 |
81 | \lstset{%
82 | backgroundcolor=\color{gray!15},
83 | basicstyle=\ttfamily,
84 | breaklines=true,
85 | columns=fullflexible
86 | }
87 |
88 | \title{{page-title}}
89 | \date{}
90 |
91 | \begin{document}
92 |
93 | \maketitle
94 |
95 | {contents}
96 |
97 | {tooltips}
98 |
99 | \end{document}
100 |
--------------------------------------------------------------------------------
/doc/templates/template.cshtml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | @Title
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
24 |
25 |
26 |
27 |
28 |
29 | - fsharp.org
30 | 
F# Compiler Services
F# Formatting
33 | @Properties["project-name"]
34 |
35 |
36 |
37 |
38 | @RenderBody()
39 |
40 |
41 |
42 | 
43 |
44 |
45 |
70 |
71 |
72 |
73 | 
74 |
75 |
76 |
--------------------------------------------------------------------------------
/generateDocs.fsx:
--------------------------------------------------------------------------------
1 | // ----------------------------------------------------------------------------
2 | // This file is subject to the terms and conditions defined in
3 | // file 'LICENSE.txt', which is part of this source code package.
4 | // ----------------------------------------------------------------------------
5 | #load "packages/Yaaf.AdvancedBuilding/content/buildConfigDef.fsx"
6 | #load @"buildConfig.fsx"
7 | #load "packages/Yaaf.AdvancedBuilding/content/generateDocsInclude.fsx"
8 | open Fake
9 | RunTargetOrDefault "LocalDoc"
--------------------------------------------------------------------------------
/lib/README.md:
--------------------------------------------------------------------------------
1 | This file is in the `lib` directory.
2 |
3 | Any **libraries** on which your project depends and which are **NOT managed via NuGet** should be kept **in this directory**.
4 | This typically includes custom builds of third-party software, private (i.e. to a company) codebases, and native libraries.
5 |
6 | ---
7 | NOTE:
8 |
9 | This file is a placeholder, used to preserve directory structure in Git.
10 |
11 | This file does not need to be edited.
12 |
--------------------------------------------------------------------------------
/nuget/Yaaf.FSharp.Scripting.nuspec:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | @project@
5 | @build.number@
6 | @authors@
7 | @authors@
8 | http://github.com/matthid/Yaaf.FSharp.Scripting/blob/develop/LICENSE.md
9 | http://matthid.github.com/Yaaf.FSharp.Scripting
10 | https://raw.githubusercontent.com/matthid/Yaaf.FSharp.Scripting/develop/doc/content/img/logo.png
11 | false
12 | @summary@
13 | @description@
14 | @releaseNotes@
15 | Copyright 2015
16 | @tags@
17 | @dependencies@
18 |
19 |
20 |
27 |
28 |
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/build.cmd:
--------------------------------------------------------------------------------
1 | @echo off
2 | REM cls
3 | set nuget_packages=packages
4 | set paket_packages=packages
5 |
6 | set nuget_path=NuGet.CommandLine/tools/NuGet.exe
7 | set fake_path=FAKE/tools/FAKE.exe
8 |
9 | REM resore paket build dependencies
10 | if exist ".paket/paket.bootstrapper.exe" (
11 | echo Bootstrap paket
12 | .paket\paket.bootstrapper.exe %PAKET_VERSION%
13 | if %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL%
14 |
15 | REM Batch is just a useless shit
16 | if "%PAKET_UPDATE%" == "y" (
17 | echo Running paket update - as requested by PAKET_UPDATE=y
18 | .paket\paket.exe update
19 | if %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL%
20 | )
21 |
22 | if "%PAKET_UPDATE%" == "true" (
23 | echo Running paket update - as requested by PAKET_UPDATE=y
24 | .paket\paket.exe update
25 | if %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL%
26 | )
27 |
28 |
29 |
30 | echo restore paket packages
31 | .paket\paket.exe restore
32 | if %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL%
33 |
34 | set fake=%paket_packages%/%fake_path%
35 | set nuget=%paket_packages%/%nuget_path%
36 | )
37 | REM Download NuGet (if not already available because of paket)
38 | if not exist %nuget% (
39 | if exist downloadNuget.fsx (
40 | if not exist %nuget_packages%/%nuget_path% (
41 | echo Bootstrap Nuget
42 | "C:\Program Files (x86)\Microsoft SDKs\F#\3.1\Framework\v4.0\fsi.exe" downloadNuget.fsx
43 | if %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL%
44 | )
45 | set nuget=%nuget_packages%/%nuget_path%
46 | )
47 | )
48 | REM Restore Nuget build dependencies
49 | if exist packages.config (
50 | if exist %nuget% (
51 | echo Resolve build dependencies
52 | "%nuget%" "install" "packages.config" "-OutputDirectory" %nuget_packages% "-ExcludeVersion"
53 | if %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL%
54 | ) else (
55 | echo NuGet build dependencies file found but no NuGet.exe could be found, either add downloadNuget.fsx or add Nuget.Commandline as paket dependency!.
56 | )
57 | )
58 |
59 | REM FAKE could be available as nuget dependency
60 | if not exist %fake% (
61 | set fake=%nuget_packages%/%fake_path%
62 | if not exist %fake% (
63 | echo Could not find FAKE in nuget or paket dependencies!
64 | exit /b 1
65 | )
66 | )
67 |
68 | echo start FAKE for the rest of the build procedure...
69 | "%fake%" %* --fsiargs -d:WIN64 -d:FAKE build.fsx
70 |
71 |
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/build.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | if test "$OS" = "Windows_NT"
3 | then
4 | # use .Net
5 | MONO=""
6 | DEFINE="WIN64"
7 | FSI="C:\Program Files (x86)\Microsoft SDKs\F#\3.1\Framework\v4.0\fsi.exe"
8 | else
9 | # use mono
10 | command -v mono >/dev/null 2>&1 || { echo >&2 "Please install mono dependency."; exit 1; }
11 | myMono="mono --debug --runtime=v4.0"
12 | FSI="fsharpi"
13 |
14 | MONO="$myMono"
15 | DEFINE="MONO"
16 | fi
17 |
18 | function do_build {
19 | nuget_packages="packages"
20 | paket_packages="packages"
21 |
22 | nuget_path="NuGet.CommandLine/tools/NuGet.exe"
23 | fake_path="FAKE/tools/FAKE.exe"
24 |
25 | # Restore paket build dependencies
26 | if [ -f ".paket/paket.bootstrapper.exe" ];
27 | then
28 | echo "Bootstrap paket"
29 | $MONO .paket/paket.bootstrapper.exe $PAKET_VERSION
30 | exit_code=$?
31 | if [ $exit_code -ne 0 ]; then
32 | exit $exit_code
33 | fi
34 |
35 | if [ "$PAKET_UPDATE" == "y" ] || [ "$PAKET_UPDATE" == "true" ]; then
36 | echo "run paket update (as requested by PAKET_UPDATE=y)"
37 | $MONO .paket/paket.exe update
38 | exit_code=$?
39 | if [ $exit_code -ne 0 ]; then
40 | exit $exit_code
41 | fi
42 | fi
43 |
44 | echo "restore paket packages"
45 | $MONO .paket/paket.exe restore
46 | exit_code=$?
47 | if [ $exit_code -ne 0 ]; then
48 | exit $exit_code
49 | fi
50 |
51 | fake=$paket_packages/$fake_path
52 | nuget=$paket_packages/$nuget_path
53 | fi
54 | # Download NuGet (if not already available because of paket)
55 | if [ ! -f "$nuget" ];
56 | then
57 | if [ -f downloadNuget.fsx ];
58 | then
59 | if [ ! -f "$nuget_packages/$nuget_path" ]; then
60 | echo "Bootstrap Nuget"
61 | command -v "$FSI" >/dev/null 2>&1 || { echo >&2 "Please install fsharpi or download a NuGet.exe to $nuget_packages/$nuget_path"; exit 1; }
62 | "$FSI" downloadNuget.fsx
63 | fi
64 | nuget="$nuget_packages/$nuget_path"
65 | fi
66 | fi
67 |
68 | # Restore Nuget build dependencies
69 | if [ -f "packages.config" ];
70 | then
71 | if [ -f "$nuget" ];
72 | then
73 | echo "restore NuGet build dependencies."
74 | $MONO $nuget "install" "packages.config" "-OutputDirectory" "$nuget_packages" "-ExcludeVersion"
75 | else
76 | echo "NuGet build dependencies file found but no NuGet.exe could be found, either add downloadNuget.fsx or add Nuget.Commandline as paket dependency!."
77 | fi
78 | fi
79 |
80 | # FAKE could be available as nuget dependency
81 | if [ ! -f "$fake" ];
82 | then
83 | fake="$nuget_packages/$fake_path"
84 | if [ ! -f "$fake" ];
85 | then
86 | echo "Could not find FAKE in nuget or paket dependencies!"
87 | exit 1
88 | fi
89 | fi
90 |
91 | echo "start FAKE for the rest of the build procedure..."
92 | $MONO $fake $@ --fsiargs -d:$DEFINE -d:FAKE build.fsx
93 | return $?
94 | }
95 |
96 | if [[ "${BASH_SOURCE[0]}" != "${0}" ]]; then
97 | # we are sourced
98 | :
99 | else
100 | do_build $@
101 | fi
102 |
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/build.targets:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | $(MSBuildToolsPath)\Microsoft.CSharp.targets
7 |
8 |
9 |
10 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.5\Microsoft.FSharp.Targets
11 |
12 |
13 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.1\Framework\v4.5\Microsoft.FSharp.Targets
14 |
15 |
16 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.0\Microsoft.FSharp.Targets
17 |
18 |
19 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.1\Framework\v4.0\Microsoft.FSharp.Targets
20 |
21 |
22 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\4.0\Framework\v4.0\Microsoft.FSharp.Targets
23 |
24 |
25 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\4.0\Framework\v4.5\Microsoft.FSharp.Targets
26 |
27 |
28 |
29 |
30 | $(MSBuildExtensionsPath32)\Microsoft\Portable\$(TargetFrameworkVersion)\Microsoft.Portable.CSharp.targets
31 |
32 |
33 |
34 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.5\Microsoft.Portable.FSharp.Targets
35 |
36 |
37 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.1\Framework\v4.5\Microsoft.Portable.FSharp.Targets
38 |
39 |
40 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.0\Microsoft.Portable.FSharp.Targets
41 |
42 |
43 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.1\Framework\v4.0\Microsoft.Portable.FSharp.Targets
44 |
45 |
46 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\4.0\Framework\v4.0\Microsoft.Portable.FSharp.Targets
47 |
48 |
49 | $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\4.0\Framework\v4.5\Microsoft.Portable.FSharp.Targets
50 |
51 |
52 |
53 |
54 | $(OutputPath)\$(AssemblyName).xml
55 |
56 |
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/buildConfigDef.fsx:
--------------------------------------------------------------------------------
1 | // ----------------------------------------------------------------------------
2 | // This file is subject to the terms and conditions defined in
3 | // file 'LICENSE.txt', which is part of this source code package.
4 | // ----------------------------------------------------------------------------
5 | #I @"../../FAKE/tools/"
6 | #r @"FakeLib.dll"
7 | // NOTE: We cannot add those here because FSharp.Formatting requires Razor2
8 | //#I @"../../FSharp.Compiler.Service/lib/net40/"
9 | //#I @"../../Yaaf.FSharp.Scripting/lib/net40/"
10 | //#I "../tools/"
11 | //#r "Yaaf.AdvancedBuilding.dll"
12 |
13 |
14 | open System.IO
15 | open System
16 |
17 | open Fake
18 | open Fake.Testing.NUnit3
19 | open Fake.MSTest
20 | open AssemblyInfoFile
21 |
22 | (**
23 | ## The `BuildParams` Type
24 |
25 | You can define your own type for building, the only limitation is that this type needs the `SimpleBuildName` and `CustomBuildName` properties.
26 | The `SimpleBuildName` property is used for the generated FAKE target for this build `(sprintf "Build_%s" build.SimpleBuildName)`.
27 | The `CustomBuildName` is used as a parameter for msbuild/xbuild and can be used within the fsproj and csproj files to define custom builds.
28 | (IE. custom defines / targets and so on).
29 | The `CustomBuildName` property is also used as the name of the sub-directory within the `buildDir` (see below).
30 | *)
31 |
32 | type BuildParams =
33 | { /// The name of the output folder and the build target
34 | SimpleBuildName : string
35 | /// The name of the platform to build
36 | PlatformName : string
37 | BuildMode : string
38 | DisableProjectFileCreation : bool
39 | UseProjectOutDir : bool
40 | BeforeBuild : unit -> unit
41 | AfterBuild : unit -> unit
42 | AfterTest : unit -> unit
43 | FindSolutionFiles : BuildParams -> string seq
44 | FindProjectFiles : BuildParams -> string seq
45 | FindTestFiles : BuildParams -> string seq
46 | FindUnitTestDlls : (string * BuildParams) -> string seq }
47 | static member Empty =
48 | { SimpleBuildName = ""
49 | BuildMode = "Release"
50 | BeforeBuild = fun _ -> ()
51 | AfterBuild = fun _ -> ()
52 | AfterTest = fun _ -> ()
53 | PlatformName = "AnyCPU"
54 | DisableProjectFileCreation = false
55 | UseProjectOutDir = false
56 | FindSolutionFiles = fun _ -> Seq.empty
57 | FindProjectFiles = fun (_:BuildParams) ->
58 | !! (sprintf "src/**/*.fsproj")
59 | ++ (sprintf "src/**/*.csproj")
60 | -- (sprintf "src/**/*.Tests.fsproj")
61 | -- (sprintf "src/**/*.Tests.csproj")
62 | -- (sprintf "src/**/Test.*.fsproj")
63 | -- (sprintf "src/**/Test.*.csproj")
64 | :> _
65 | FindTestFiles = fun (_:BuildParams) ->
66 | !! (sprintf "src/**/*.Tests.fsproj")
67 | ++ (sprintf "src/**/*.Tests.csproj")
68 | ++ (sprintf "src/**/Test.*.fsproj")
69 | ++ (sprintf "src/**/Test.*.csproj")
70 | :> _
71 | FindUnitTestDlls = fun (testDir, (_:BuildParams)) ->
72 | !! (testDir + "/Test.*.dll")
73 | ++ (testDir + "/*.Tests.dll")
74 | :> _ }
75 | static member WithSolution =
76 | { BuildParams.Empty with
77 | BuildMode = "Release"
78 | PlatformName = "Any CPU"
79 | UseProjectOutDir = true
80 | FindSolutionFiles = fun _ -> !! "**/*.sln" :> _
81 | FindProjectFiles = fun _ -> Seq.empty
82 | FindTestFiles = fun _ -> Seq.empty }
83 |
84 | /// see http://tpetricek.github.io/FSharp.Formatting/diagnostics.html
85 | type FSharpFormattingLogging =
86 | /// Disable all logging. F# Formatting will not print anything to the console and it will also not produce a log file (this is not recomended, but you might need this if you want to suppress all output).
87 | | DisableFSFLogging
88 | /// Enables detailed logging to a file FSharp.Formatting.svclog and keeps printing of basic information to console too.
89 | | AllFSFLogging
90 | /// Enables detailed logging to a file FSharp.Formatting.svclog but disables printing of basic information to console.
91 | | FileOnlyFSFLogging
92 | /// Any other value (default) - Print basic information to console and do not produce a detailed log file.
93 | | ConsoleOnlyFSFLogging
94 |
95 | type NuGetPackage =
96 | { /// The version of the package (null = use global version)
97 | Version : string
98 | /// The filename of the nuspec (template) file, in the config.NugetDir folder
99 | FileName : string
100 | /// The prefix for the created tag (null = no tag will be created)
101 | TagPrefix : string
102 | /// identifier for this package
103 | SimpleName : string
104 |
105 | ConfigFun : (NuGetParams -> NuGetParams) }
106 | static member Empty =
107 | { Version = null
108 | FileName = null
109 | TagPrefix = null
110 | SimpleName = null
111 | ConfigFun = id }
112 | member x.Name =
113 | if isNull x.SimpleName then x.TagPrefix else x.SimpleName
114 | member x.TagName =
115 | if isNull x.TagPrefix then failwith "no TagPrefix is specified!"
116 | sprintf "%s%s" x.TagPrefix x.Version
117 | member x.VersionLine =
118 | sprintf "%s_%s" x.SimpleName (if isNull x.TagPrefix then x.Version else x.TagName)
119 |
120 | type BuildConfiguration =
121 | { // Metadata
122 | ProjectName : string
123 | ProjectSummary : string
124 | Company : string
125 | CopyrightNotice : string
126 | ProjectDescription : string
127 | ProjectAuthors : string list
128 | /// Enable all github integrations (pushing documentation)
129 | EnableGithub : bool
130 | GithubUser : string
131 | /// Defaults to ProjectName
132 | GithubProject : string
133 | PageAuthor : string
134 | /// Defaults to github issues
135 | IssuesUrl : string
136 | /// Defaults to github new issue page
137 | FileNewIssueUrl : string
138 | /// Defaults to github master branch "/blob/master/"
139 | SourceReproUrl : string
140 |
141 | // Nuget configuration
142 | /// Defaults to sprintf "https://www.nuget.org/packages/%s/" x.ProjectName
143 | NugetUrl : string
144 | NugetTags : string
145 | /// The directory for the nuspec (template) files.
146 | NugetDir : string
147 | /// Like NugetPackages but allows to define different versions (which will create tags)
148 | NugetVersionPackages : BuildConfiguration -> NuGetPackage list
149 | // []
150 | // see https://fslang.uservoice.com/forums/245727-f-language/suggestions/12826233-hide-obsolete-warnings-on-record-initializer-not-u
151 | NugetPackages : (string * (BuildConfiguration -> NuGetParams -> NuGetParams)) list
152 | // Defaults to "./release/nuget/"
153 | OutNugetDir : string
154 |
155 | // Pre build
156 | Version : string
157 | /// Defaults to setting up a "./src/SharedAssemblyInfo.fs" and "./src/SharedAssemblyInfo.cs"
158 | SetAssemblyFileVersions : BuildConfiguration -> unit
159 | /// Enables to convert pdb to mdb or mdb to pdb after paket restore.
160 | /// This improves cross platform development and creates pdb files
161 | /// on unix (to create nuget packages on linux with integrated pdb files)
162 | EnableDebugSymbolConversion : bool
163 |
164 | /// Makes "./build.sh Release" fail when not executed on a windows machine
165 | /// Use this if you want to include .pdb in your nuget packge
166 | /// (to ensure your release contains debug symbols)
167 | RestrictReleaseToWindows : bool
168 |
169 | // Build configuration
170 | /// Defaults to [ x.ProjectName + ".dll"; x.ProjectName + ".xml" ]
171 | GeneratedFileList : string list
172 | /// Defaults to false (support for nuget msbuild integration)
173 | UseNuget : bool
174 | BuildTargets : BuildParams list
175 | /// Defaults to "./build/"
176 | BuildDir : string
177 | /// Defaults to "./release/lib/"
178 | OutLibDir : string
179 | NugetPackageDir : string
180 | GlobalPackagesDir : string
181 |
182 | // Test
183 | /// Defaults to "./test/"
184 | TestDir : string
185 |
186 | DisableNUnit : bool
187 | SetupNUnit : (NUnitParams -> NUnitParams)
188 |
189 | DisableNUnit3 : bool
190 | SetupNUnit3 : (NUnit3Params -> NUnit3Params)
191 |
192 | DisableMSTest : bool
193 | SetupMSTest : (MSTestParams -> MSTestParams)
194 |
195 | // Documentation generation
196 | /// Defaults to "./release/documentation/"
197 | OutDocDir : string
198 | /// Defaults to "./doc/templates/"
199 | DocTemplatesDir : string
200 | DocLogging : FSharpFormattingLogging
201 | LayoutRoots : string list
202 | /// Specify the list of references used for (razor) documentation generation.
203 | DocRazorReferences : string list option }
204 | static member Defaults =
205 | { ProjectName = ""
206 | ProjectSummary = ""
207 | Company = ""
208 | CopyrightNotice = ""
209 | ProjectDescription = ""
210 | UseNuget = false
211 | EnableGithub = true
212 | EnableDebugSymbolConversion = false
213 | RestrictReleaseToWindows = true
214 | ProjectAuthors = []
215 | BuildTargets = [ BuildParams.Empty ]
216 | NugetUrl = ""
217 | NugetTags = ""
218 | PageAuthor = ""
219 | GithubUser = ""
220 | GithubProject = ""
221 | DocLogging = AllFSFLogging
222 | SetAssemblyFileVersions = (fun config ->
223 | let info =
224 | [ Attribute.Company config.Company
225 | Attribute.Product config.ProjectName
226 | Attribute.Copyright config.CopyrightNotice
227 | Attribute.Version config.Version
228 | Attribute.FileVersion config.Version
229 | Attribute.InformationalVersion config.Version ]
230 | CreateFSharpAssemblyInfo "./src/SharedAssemblyInfo.fs" info
231 | CreateCSharpAssemblyInfo "./src/SharedAssemblyInfo.cs" info)
232 | Version = ""
233 | IssuesUrl = ""
234 | FileNewIssueUrl = ""
235 | SourceReproUrl = ""
236 | NugetDir = "nuget"
237 | NugetVersionPackages = fun _ -> []
238 | NugetPackages = []
239 | DisableNUnit = false
240 | SetupNUnit = id
241 | DisableNUnit3 = false
242 | SetupNUnit3 = id
243 | DisableMSTest = isLinux
244 | SetupMSTest = id
245 | GeneratedFileList = []
246 | BuildDir = "./build/"
247 | OutLibDir = "./release/lib/"
248 | OutDocDir = "./release/documentation/"
249 | OutNugetDir = "./release/nuget/"
250 | DocTemplatesDir = "./doc/templates/"
251 | LayoutRoots = [ ]
252 | TestDir = "./build/test/"
253 | GlobalPackagesDir = "./packages"
254 | NugetPackageDir = "./packages/.nuget"
255 | DocRazorReferences =
256 | if isMono then
257 | let loadedList =
258 | System.AppDomain.CurrentDomain.GetAssemblies()
259 | |> Seq.choose (fun a -> try Some (a.Location) with _ -> None)
260 | |> Seq.cache
261 | let getItem name = loadedList |> Seq.find (fun l -> l.Contains name)
262 | [ (getItem "FSharp.Core").Replace("4.3.0.0", "4.3.1.0") // (if isMono then "/usr/lib64/mono/gac/FSharp.Core/4.3.1.0__b03f5f7f11d50a3a/FSharp.Core.dll" else "FSharp.Core")
263 | Path.GetFullPath "./packages/FSharp.Compiler.Service/lib/net40/FSharp.Compiler.Service.dll"
264 | Path.GetFullPath "./packages/FSharp.Formatting/lib/net40/System.Web.Razor.dll"
265 | Path.GetFullPath "./packages/FSharp.Formatting/lib/net40/RazorEngine.dll"
266 | Path.GetFullPath "./packages/FSharp.Formatting/lib/net40/FSharp.Literate.dll"
267 | Path.GetFullPath "./packages/FSharp.Formatting/lib/net40/FSharp.CodeFormat.dll"
268 | Path.GetFullPath "./packages/FSharp.Formatting/lib/net40/FSharp.MetadataFormat.dll" ]
269 | |> Some
270 | else None}
271 | member x.GithubUrl = sprintf "https://github.com/%s/%s" x.GithubUser x.GithubProject
272 | member x.AllNugetPackages =
273 | let versionPackages = x.NugetVersionPackages x
274 | let otherPackages = x.NugetPackages |> List.map (fun (s, func) -> { NuGetPackage.Empty with FileName = s; ConfigFun = func x })
275 | versionPackages @ otherPackages
276 | member x.GetPackageByName name =
277 | x.AllNugetPackages |> Seq.find (fun p -> p.Name = name)
278 | member x.SpecialVersionPackages =
279 | x.AllNugetPackages |> List.filter (fun p -> not (isNull p.Version))
280 | member x.VersionInfoLine =
281 | let packages = x.SpecialVersionPackages
282 | if packages.Length = 0 then
283 | x.Version
284 | else
285 | sprintf "%s (%s)" x.Version (String.Join(", ", packages |> Seq.map (fun p -> p.VersionLine)))
286 | member x.CheckValid() =
287 | match x.AllNugetPackages |> Seq.tryFind (fun p -> isNull p.FileName) with
288 | | Some p ->
289 | failwithf "found a package with a FileName of null: %A" p
290 | | None -> ()
291 | let packages = x.SpecialVersionPackages
292 | match packages |> Seq.tryFind (fun p -> isNull p.Name) with
293 | | Some p ->
294 | failwithf "package '%s' has a version '%s' but SimpleName and TagPrefix are both null!" p.FileName p.Version
295 | | None -> ()
296 | match x.AllNugetPackages |> Seq.tryFind (fun p -> isNull p.Version && not (isNull p.TagPrefix)) with
297 | | Some p ->
298 | failwithf "package '%s' has a TagPrefix set but it's version is not set (eg it is null)" p.FileName
299 | | None -> ()
300 |
301 | member x.FillDefaults () =
302 | let x =
303 | { x with
304 | Company =
305 | if String.IsNullOrEmpty x.Company then x.ProjectName else x.Company
306 | NugetUrl =
307 | if String.IsNullOrEmpty x.NugetUrl then sprintf "https://www.nuget.org/packages/%s/" x.ProjectName else x.NugetUrl
308 | GithubProject = if String.IsNullOrEmpty x.GithubProject then x.ProjectName else x.GithubProject
309 | GeneratedFileList =
310 | if x.GeneratedFileList |> List.isEmpty |> not then x.GeneratedFileList
311 | else [ x.ProjectName + ".dll"; x.ProjectName + ".xml" ]
312 | LayoutRoots =
313 | if not x.LayoutRoots.IsEmpty then x.LayoutRoots
314 | else [ x.DocTemplatesDir; x.DocTemplatesDir @@ "reference" ] }
315 | // GithubUrl is now available
316 | let final =
317 | { x with
318 | SourceReproUrl =
319 | if String.IsNullOrEmpty x.SourceReproUrl then x.GithubUrl + "/blob/master/" else x.SourceReproUrl
320 | IssuesUrl = if String.IsNullOrEmpty x.IssuesUrl then sprintf "%s/issues" x.GithubUrl else x.IssuesUrl
321 | FileNewIssueUrl =
322 | if String.IsNullOrEmpty x.FileNewIssueUrl then sprintf "%s/issues/new" x.GithubUrl else x.FileNewIssueUrl }
323 | final.CheckValid()
324 | final
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/buildInclude.fsx:
--------------------------------------------------------------------------------
1 | // ----------------------------------------------------------------------------
2 | // This file is subject to the terms and conditions defined in
3 | // file 'LICENSE.txt', which is part of this source code package.
4 | // ----------------------------------------------------------------------------
5 |
6 | (*
7 | This file handles the complete build process of RazorEngine
8 |
9 | The first step is handled in build.sh and build.cmd by bootstrapping a NuGet.exe and
10 | executing NuGet to resolve all build dependencies (dependencies required for the build to work, for example FAKE)
11 |
12 | The secound step is executing this file which resolves all dependencies, builds the solution and executes all unit tests
13 | *)
14 |
15 | #if FAKE
16 | #else
17 | // Support when file is opened in Visual Studio
18 | #load "buildConfigDef.fsx"
19 | #load "../../../buildConfig.fsx"
20 | #endif
21 |
22 | open BuildConfigDef
23 | let config = BuildConfig.buildConfig.FillDefaults ()
24 |
25 | // NOTE: We want to add that to buildConfigDef.fsx sometimes in the future
26 | // #I @"../../FSharp.Compiler.Service/lib/net40/" // included in FAKE, but to be able to use the latest
27 | // Bundled
28 | //#I @"../../Yaaf.FSharp.Scripting/lib/net40/"
29 | #I "../tools/"
30 | #r "Yaaf.AdvancedBuilding.dll"
31 |
32 |
33 | open Yaaf.AdvancedBuilding
34 | open System.IO
35 | open System
36 |
37 | open Fake
38 | open Fake.Testing.NUnit3
39 | open Fake.Git
40 | open Fake.MSTest
41 | open Fake.FSharpFormatting
42 | open AssemblyInfoFile
43 |
44 | let readLine msg def =
45 | if isLocalBuild then
46 | printf "%s" msg
47 | System.Console.ReadLine()
48 | else
49 | printf "%s%s" msg def
50 | def
51 |
52 | if config.UseNuget then
53 | // Ensure the ./src/.nuget/NuGet.exe file exists (required by xbuild)
54 | let nuget = findToolInSubPath "NuGet.exe" (config.GlobalPackagesDir @@ "NuGet.CommandLine/tools/NuGet.exe")
55 | if Directory.Exists "./src/.nuget" then
56 | File.Copy(nuget, "./src/.nuget/NuGet.exe", true)
57 | else
58 | failwith "you set UseNuget to true but there is no \"./src/.nuget/NuGet.targets\" or \"./src/.nuget/NuGet.Config\"! Please copy them from ./packages/Yaaf.AdvancedBuilding/scaffold/nuget"
59 |
60 | let createMissingSymbolFiles assembly =
61 | try
62 | match File.Exists (Path.ChangeExtension(assembly, "pdb")), File.Exists (assembly + ".mdb") with
63 | | true, false when not isLinux ->
64 | // create mdb
65 | trace (sprintf "Creating mdb for %s" assembly)
66 | DebugSymbolHelper.writeMdbFromPdb assembly
67 | | true, false ->
68 | trace (sprintf "Cannot create mdb for %s because we are not on windows :(" assembly)
69 | | false, true when not isLinux ->
70 | // create pdb
71 | trace (sprintf "Creating pdb for %s" assembly)
72 | DebugSymbolHelper.writePdbFromMdb assembly
73 | | false, true ->
74 | trace (sprintf "Cannot create pdb for %s because we are not on windows :(" assembly)
75 | | _, _ ->
76 | // either no debug symbols available or already both.
77 | ()
78 | with exn -> traceError (sprintf "Error creating symbols: %s" exn.Message)
79 |
80 |
81 | let buildWithFiles msg dir projectFileFinder (buildParams:BuildParams) =
82 | let files = projectFileFinder buildParams |> Seq.toList
83 | let buildDir =
84 | if not buildParams.UseProjectOutDir then
85 | let buildDir = dir @@ buildParams.SimpleBuildName
86 | CleanDirs [ buildDir ]
87 | buildDir
88 | else
89 | files
90 | |> MSBuild null "clean"
91 | [ "Configuration", buildParams.BuildMode
92 | "Platform", buildParams.PlatformName ]
93 | |> Log "Cleaning: "
94 | null
95 | // build app
96 | files
97 | |> MSBuild buildDir "Build"
98 | [ "Configuration", buildParams.BuildMode
99 | "Platform", buildParams.PlatformName ]
100 | |> Log msg
101 |
102 | let buildSolution = buildWithFiles "BuildSolution-Output: " config.BuildDir (fun buildParams -> buildParams.FindSolutionFiles buildParams)
103 | let buildApp = buildWithFiles "AppBuild-Output: " config.BuildDir (fun buildParams -> buildParams.FindProjectFiles buildParams)
104 | let buildTests = buildWithFiles "TestBuild-Output: " config.TestDir (fun buildParams -> buildParams.FindTestFiles buildParams)
105 |
106 | exception NUnitNotFoundException of string
107 |
108 | let runTests (buildParams:BuildParams) =
109 | let testDir = config.TestDir @@ buildParams.SimpleBuildName
110 | let logs = System.IO.Path.Combine(testDir, "logs")
111 | System.IO.Directory.CreateDirectory(logs) |> ignore
112 | let files = buildParams.FindUnitTestDlls (testDir, buildParams) |> Seq.cache
113 | if files |> Seq.isEmpty then
114 | traceError (sprintf "NO test found in %s" testDir)
115 | else
116 | let legacyNunitRun =
117 | if not config.DisableNUnit then
118 | try
119 | files
120 | |> NUnit (fun p ->
121 | let setupValue =
122 | {p with
123 | ProcessModel =
124 | // Because the default nunit-console.exe.config doesn't use .net 4...
125 | if isMono then NUnitProcessModel.SingleProcessModel else NUnitProcessModel.DefaultProcessModel
126 | WorkingDir = testDir
127 | StopOnError = true
128 | TimeOut = System.TimeSpan.FromMinutes 30.0
129 | Framework = "4.0"
130 | DisableShadowCopy = true
131 | OutputFile = "logs/TestResults.xml" } |> config.SetupNUnit
132 | let tool = setupValue.ToolPath @@ setupValue.ToolName
133 | if File.Exists tool |> not then
134 | raise <| NUnitNotFoundException (sprintf "The path to the nunit runner (%s) was not found!\nIt might be because you updated NUnit and they changed the path to the executable.\nEither downgrade NUnit again or use the new API (if already available)." tool)
135 | setupValue)
136 | true
137 | with
138 | | NUnitNotFoundException s ->
139 | traceEndTask "NUnit" (files |> separated ", ") // Workaround for https://github.com/fsharp/FAKE/issues/1079
140 | let msg = sprintf "NUNIT COULD NOT BE RUN, because it was not found. Please disable NUnit in your buildConfigDef.fsx with 'DisableNUnit = true'.\n\nDetails: %s" s
141 | if not config.DisableNUnit3 && File.Exists Fake.Testing.NUnit3.NUnit3Defaults.ToolPath then
142 | traceFAKE "%s\n\nThis is a warning only because we will be running NUnit3 as well" msg
143 | else failwith msg
144 | false
145 | else false
146 | if not legacyNunitRun && not config.DisableNUnit3 then
147 | files
148 | |> NUnit3 (fun p ->
149 | let setupValue =
150 | {p with
151 | ProcessModel =
152 | // Because the default nunit-console.exe.config doesn't use .net 4...
153 | if isMono then NUnit3ProcessModel.SingleProcessModel else NUnit3ProcessModel.DefaultProcessModel
154 | WorkingDir = testDir
155 | StopOnError = true
156 | TimeOut = System.TimeSpan.FromMinutes 30.0
157 | Framework = if isMono then NUnit3Runtime.Mono40 else NUnit3Runtime.Net45
158 | ShadowCopy = false
159 | OutputDir = "logs" } |> config.SetupNUnit3
160 | let tool = setupValue.ToolPath
161 | if File.Exists tool |> not then
162 | failwithf "The path to the nunit runner (%s) was not found!\nIt might be because you updated NUnit and they changed the path to the executable.\nEither downgrade NUnit again or use the new API (if already available)." tool
163 | setupValue)
164 |
165 | if not config.DisableMSTest then
166 | files
167 | |> MSTest (fun p ->
168 | {p with
169 | WorkingDir = testDir
170 | ResultsDir = "logs" } |> config.SetupMSTest)
171 |
172 | let buildAll (buildParams:BuildParams) =
173 | buildParams.BeforeBuild ()
174 | buildSolution buildParams
175 | buildApp buildParams
176 | buildTests buildParams
177 | buildParams.AfterBuild ()
178 | runTests buildParams
179 | buildParams.AfterTest ()
180 |
181 | let fakePath = "packages" @@ "FAKE" @@ "tools" @@ "FAKE.exe"
182 | let fakeStartInfo script workingDirectory args environmentVars =
183 | (fun (info: System.Diagnostics.ProcessStartInfo) ->
184 | info.FileName <- fakePath
185 | info.Arguments <- sprintf "%s --fsiargs -d:FAKE \"%s\"" args script
186 | info.WorkingDirectory <- workingDirectory
187 | let setVar k v =
188 | info.EnvironmentVariables.[k] <- v
189 | for (k, v) in environmentVars do
190 | setVar k v
191 | setVar "MSBuild" msBuildExe
192 | setVar "GIT" Git.CommandHelper.gitPath
193 | setVar "FSI" fsiPath)
194 |
195 |
196 | /// Run the given startinfo by printing the output (live)
197 | let executeWithOutput configStartInfo =
198 | let exitCode =
199 | ExecProcessWithLambdas
200 | configStartInfo
201 | TimeSpan.MaxValue false ignore ignore
202 | System.Threading.Thread.Sleep 1000
203 | exitCode
204 |
205 | /// Run the given startinfo by redirecting the output (live)
206 | let executeWithRedirect errorF messageF configStartInfo =
207 | let exitCode =
208 | ExecProcessWithLambdas
209 | configStartInfo
210 | TimeSpan.MaxValue true errorF messageF
211 | System.Threading.Thread.Sleep 1000
212 | exitCode
213 |
214 | /// Helper to fail when the exitcode is <> 0
215 | let executeHelper executer traceMsg failMessage configStartInfo =
216 | trace traceMsg
217 | let exit = executer configStartInfo
218 | if exit <> 0 then
219 | failwith failMessage
220 | ()
221 |
222 | let execute = executeHelper executeWithOutput
223 |
224 | /// Undocumentated way to disable cache (-nc) for documentation generation
225 | let mutable documentationFAKEArgs = ""
226 |
227 | // Documentation
228 | let buildDocumentationTarget target =
229 | let loggingValue =
230 | match config.DocLogging with
231 | | DisableFSFLogging -> "NONE"
232 | | AllFSFLogging -> "ALL"
233 | | FileOnlyFSFLogging -> "FILE_ONLY"
234 | | ConsoleOnlyFSFLogging -> "CONSOLE_ONLY"
235 | execute
236 | (sprintf "Building documentation (%s), this could take some time, please wait..." target)
237 | "generating reference documentation failed"
238 | (fakeStartInfo "generateDocs.fsx" "." documentationFAKEArgs ["target", target; "FSHARP_FORMATTING_LOG", loggingValue])
239 |
240 | let tryDelete dir =
241 | try
242 | CleanDirs [ dir ]
243 | with
244 | | :? System.IO.IOException as e ->
245 | traceImportant (sprintf "Cannot access: %s\nTry closing Visual Studio!" e.Message)
246 | | :? System.UnauthorizedAccessException as e ->
247 | traceImportant (sprintf "Cannot access: %s\nTry closing Visual Studio!" e.Message)
248 |
249 | let MyTarget name body =
250 | Target name (fun _ -> body false)
251 | let single = (sprintf "%s_single" name)
252 | Target single (fun _ -> body true)
253 |
254 | // Targets
255 | MyTarget "Clean" (fun _ ->
256 | tryDelete config.BuildDir
257 | tryDelete config.TestDir
258 |
259 | CleanDirs [ config.BuildDir; config.TestDir; config.OutLibDir; config.OutDocDir; config.OutNugetDir ]
260 | )
261 |
262 | MyTarget "CleanAll" (fun _ ->
263 | // Only done when we want to redownload all.
264 | Directory.EnumerateDirectories config.GlobalPackagesDir
265 | |> Seq.filter (fun buildDepDir ->
266 | let buildDepName = Path.GetFileName buildDepDir
267 | // We can't delete the FAKE directory (as it is used currently)
268 | buildDepName <> "FAKE")
269 | |> Seq.iter (fun dir ->
270 | try
271 | DeleteDir dir
272 | with exn ->
273 | traceError (sprintf "Unable to delete %s: %O" dir exn))
274 | )
275 |
276 | MyTarget "RestorePackages" (fun _ ->
277 | // will catch src/targetsDependencies
278 | !! "./src/**/packages.config"
279 | |> Seq.iter
280 | (RestorePackage (fun param ->
281 | { param with
282 | // ToolPath = ""
283 | OutputPath = config.NugetPackageDir }))
284 | )
285 |
286 | MyTarget "CreateDebugFiles" (fun _ ->
287 | // creates .mdb from .pdb files and the other way around
288 | !! (config.GlobalPackagesDir + "/**/*.exe")
289 | ++ (config.GlobalPackagesDir + "/**/*.dll")
290 | |> Seq.iter createMissingSymbolFiles
291 | )
292 |
293 | MyTarget "SetVersions" (fun _ ->
294 | config.SetAssemblyFileVersions config
295 | )
296 |
297 | config.BuildTargets
298 | |> Seq.iter (fun buildParam ->
299 | MyTarget (sprintf "Build_%s" buildParam.SimpleBuildName) (fun _ -> buildAll buildParam))
300 |
301 | MyTarget "CopyToRelease" (fun _ ->
302 | trace "Copying to release because test was OK."
303 | let outLibDir = config.OutLibDir
304 | CleanDirs [ outLibDir ]
305 | Directory.CreateDirectory(outLibDir) |> ignore
306 |
307 | // Copy files to release directory
308 | config.BuildTargets
309 | |> Seq.map (fun buildParam -> buildParam.SimpleBuildName)
310 | |> Seq.map (fun t -> config.BuildDir @@ t, t)
311 | |> Seq.filter (fun (p, _) -> Directory.Exists p)
312 | |> Seq.iter (fun (source, buildName) ->
313 | let outDir = outLibDir @@ buildName
314 | ensureDirectory outDir
315 | config.GeneratedFileList
316 | |> Seq.collect (fun file ->
317 | let extension = (Path.GetExtension file).TrimStart('.')
318 | match extension with
319 | | "dll" | "exe" ->
320 | [ file
321 | Path.ChangeExtension(file, "pdb")
322 | Path.ChangeExtension(file, extension + ".mdb" ) ]
323 | | _ -> [ file ]
324 | )
325 | |> Seq.filter (fun (file) -> File.Exists (source @@ file))
326 | |> Seq.iter (fun (file) ->
327 | let sourceFile = source @@ file
328 | let newfile = outDir @@ Path.GetFileName file
329 | trace (sprintf "Copying %s to %s" sourceFile newfile)
330 | File.Copy(sourceFile, newfile))
331 | )
332 | )
333 |
334 | MyTarget "CreateReleaseSymbolFiles" (fun _ ->
335 | // creates .mdb from .pdb files and the other way around
336 | !! (config.OutLibDir + "/**/*.exe")
337 | ++ (config.OutLibDir + "/**/*.dll")
338 | |> Seq.iter createMissingSymbolFiles
339 | )
340 |
341 | /// push package (and try again if something fails), FAKE Version doesn't work on mono
342 | /// From https://raw.githubusercontent.com/fsharp/FAKE/master/src/app/FakeLib/NuGet/NugetHelper.fs
343 | let rec private publish parameters =
344 | let replaceAccessKey key (text : string) =
345 | if isNullOrEmpty key then text
346 | else text.Replace(key, "PRIVATEKEY")
347 | let nuspec = sprintf "%s.%s.nupkg" parameters.Project parameters.Version
348 | traceStartTask "MyNuGetPublish" nuspec
349 | let tracing = enableProcessTracing
350 | enableProcessTracing <- false
351 | let source =
352 | let uri = if isNullOrEmpty parameters.PublishUrl then "https://www.nuget.org/api/v2/package" else parameters.PublishUrl
353 | sprintf "-s %s" uri
354 |
355 | let args = sprintf "push \"%s\" %s %s" (parameters.OutputPath @@ nuspec) parameters.AccessKey source
356 | tracefn "%s %s in WorkingDir: %s Trials left: %d" parameters.ToolPath (replaceAccessKey parameters.AccessKey args)
357 | (FullName parameters.WorkingDir) parameters.PublishTrials
358 | try
359 | try
360 | let result =
361 | ExecProcess (fun info ->
362 | info.FileName <- parameters.ToolPath
363 | info.WorkingDirectory <- FullName parameters.WorkingDir
364 | info.Arguments <- args) parameters.TimeOut
365 | enableProcessTracing <- tracing
366 | if result <> 0 then failwithf "Error during NuGet push. %s %s" parameters.ToolPath args
367 | true
368 | with exn ->
369 | let existsError = exn.Message.Contains("already exists and cannot be modified")
370 | if existsError then
371 | trace exn.Message
372 | false
373 | else
374 | if parameters.PublishTrials > 0 then publish { parameters with PublishTrials = parameters.PublishTrials - 1 }
375 | else
376 | (if not (isNull exn.InnerException) then exn.Message + "\r\n" + exn.InnerException.Message
377 | else exn.Message)
378 | |> replaceAccessKey parameters.AccessKey
379 | |> failwith
380 | finally
381 | traceEndTask "MyNuGetPublish" nuspec
382 |
383 | let packSetup version config p =
384 | { p with
385 | Authors = config.ProjectAuthors
386 | Project = config.ProjectName
387 | Summary = config.ProjectSummary
388 | Version = if isNull version then config.Version else version
389 | Description = config.ProjectDescription
390 | Tags = config.NugetTags
391 | WorkingDir = "."
392 | OutputPath = config.OutNugetDir
393 | AccessKey = getBuildParamOrDefault "nugetkey" ""
394 | Publish = false
395 | Dependencies = [ ] }
396 |
397 | MyTarget "NuGetPack" (fun _ ->
398 | ensureDirectory config.OutNugetDir
399 | for package in config.AllNugetPackages do
400 | let packSetup = packSetup package.Version config
401 | NuGet (fun p -> { (packSetup >> package.ConfigFun) p with Publish = false }) (Path.Combine(config.NugetDir, package.FileName))
402 | )
403 |
404 | MyTarget "NuGetPush" (fun _ ->
405 | let packagePushed =
406 | config.AllNugetPackages
407 | |> List.map (fun package ->
408 | try
409 | let packSetup = packSetup package.Version config
410 | let parameters = NuGetDefaults() |> (fun p -> { packSetup p with Publish = true }) |> package.ConfigFun
411 | // This allows us to specify packages which we do not want to push...
412 | if hasBuildParam "nugetkey" && parameters.Publish then publish parameters
413 | else true
414 | with e ->
415 | trace (sprintf "Could not push package '%s': %O" (if isNull package.Name then "{null}" else package.Name) e)
416 | false)
417 | |> List.exists id
418 |
419 | if not packagePushed then
420 | failwithf "No package could be pushed!"
421 | )
422 |
423 | // Documentation
424 | MyTarget "GithubDoc" (fun _ -> buildDocumentationTarget "GithubDoc")
425 |
426 | MyTarget "LocalDoc" (fun _ -> buildDocumentationTarget "LocalDoc")
427 |
428 | MyTarget "WatchDocs" (fun _ -> buildDocumentationTarget "WatchDocs")
429 |
430 | // its just faster to generate all at the same time...
431 | MyTarget "AllDocs" (fun _ -> buildDocumentationTarget "AllDocs")
432 |
433 | MyTarget "ReleaseGithubDoc" (fun isSingle ->
434 | let repro = (sprintf "git@github.com:%s/%s.git" config.GithubUser config.GithubProject)
435 | let doAction =
436 | if isSingle then true
437 | else
438 | let msg = sprintf "update github docs to %s? (y,n): " repro
439 | let line = readLine msg "y"
440 | line = "y"
441 | if doAction then
442 | CleanDir "gh-pages"
443 | cloneSingleBranch "" repro "gh-pages" "gh-pages"
444 | fullclean "gh-pages"
445 | CopyRecursive ("release"@@"documentation"@@(sprintf "%s.github.io" config.GithubUser)@@"html") "gh-pages" true |> printfn "%A"
446 | StageAll "gh-pages"
447 | Commit "gh-pages" (sprintf "Update generated documentation %s" config.VersionInfoLine)
448 | let msg = sprintf "gh-pages branch updated in the gh-pages directory, push that branch to %s now? (y,n): " repro
449 | let line = readLine msg "y"
450 | if line = "y" then
451 | Branches.pushBranch "gh-pages" "origin" "gh-pages"
452 | )
453 |
454 | Target "All" (fun _ ->
455 | trace "All finished!"
456 | )
457 |
458 | Target "CheckWindows" (fun _ ->
459 | if isLinux then failwith "can only do releases on windows."
460 | )
461 |
462 | MyTarget "VersionBump" (fun _ ->
463 | let repositoryHelperDir = "__repository"
464 | let workingDir =
465 | if not isLocalBuild && buildServer = BuildServer.TeamFoundation then
466 | let workingDir = repositoryHelperDir
467 | // We are not in a git repository, because the .git folder is missing.
468 | let repro = (sprintf "git@github.com:%s/%s.git" config.GithubUser config.GithubProject)
469 | CleanDir workingDir
470 | clone "" repro workingDir
471 | checkoutBranch workingDir (Information.getCurrentSHA1("."))
472 | fullclean (workingDir @@ "src")
473 | CopyRecursive "src" (workingDir @@ "src") true |> printfn "%A"
474 | workingDir
475 | else ""
476 |
477 | let doBranchUpdates = not isLocalBuild && (getBuildParamOrDefault "yaaf_merge_master" "false") = "true"
478 | if doBranchUpdates then
479 | // Make sure we are on develop (commit will fail otherwise)
480 | Stash.push workingDir ""
481 | try Branches.deleteBranch workingDir true "develop"
482 | with e -> trace (sprintf "deletion of develop branch failed %O" e)
483 | Branches.checkout workingDir true "develop"
484 | try Stash.pop workingDir
485 | with e -> trace (sprintf "stash pop failed %O" e)
486 |
487 | // Commit updates the SharedAssemblyInfo.cs files.
488 | let changedFiles = Fake.Git.FileStatus.getChangedFilesInWorkingCopy workingDir "HEAD" |> Seq.toList
489 | if changedFiles |> Seq.isEmpty |> not then
490 | for (status, file) in changedFiles do
491 | printfn "File %s changed (%A)" file status
492 |
493 | let line = readLine "version bump commit? (y,n): " "y"
494 | if line = "y" then
495 | StageAll workingDir
496 | Commit workingDir (sprintf "Bump version to %s" config.VersionInfoLine)
497 |
498 | if doBranchUpdates then
499 | try Branches.deleteBranch workingDir true "master"
500 | with e -> trace (sprintf "deletion of master branch failed %O" e)
501 | Branches.checkout workingDir false "origin/master"
502 | Branches.checkout workingDir true "master"
503 | try Merge.merge workingDir NoFastForwardFlag "develop"
504 | with e ->
505 | trace (sprintf "merging of develop into master failed: %O" e)
506 | trace (sprintf "Try 'git checkout develop && git pull origin master && git checkout master && git pull origin master && git merge develop && git push origin master' locally and repeat the release process!")
507 | reraise()
508 |
509 | //try Branches.deleteTag "" config.Version
510 | //with e -> trace (sprintf "deletion of tag %s failed %O" config.Version e)
511 |
512 | let specialVersionedPackages =
513 | config.SpecialVersionPackages
514 | |> List.filter (fun p -> not (isNull p.TagPrefix))
515 | let createdPackageTags =
516 | specialVersionedPackages
517 | |> List.map (fun p ->
518 | try Branches.tag workingDir p.TagName; true
519 | with e -> trace (sprintf "creation of tag '%s' failed: %O" p.TagName e); false)
520 | |> List.exists id
521 |
522 | try Branches.tag workingDir config.Version
523 | with e ->
524 | if createdPackageTags then
525 | trace (sprintf "creation of tag '%s' failed: %O" config.Version e)
526 | else
527 | raise <| new Exception("No tag was created for this release, please increase a (package) version!", e)
528 |
529 | try Branches.deleteBranch workingDir true "develop"
530 | with e -> trace (sprintf "deletion of develop branch failed %O" e)
531 | Branches.checkout workingDir false "origin/develop"
532 | Branches.checkout workingDir true "develop"
533 | try Merge.merge workingDir NoFastForwardFlag "master"
534 | with e ->
535 | trace (sprintf "merging of master into develop failed: %O" e)
536 | trace (sprintf "Try 'git checkout master && git pull origin master && git checkout develop && git pull origin master && git merge master && git push origin develop' locally and repeat the release process!")
537 | reraise()
538 |
539 | for p in specialVersionedPackages do
540 | Branches.pushTag workingDir "origin" p.TagName
541 | Branches.pushTag workingDir "origin" config.Version
542 | Branches.pushBranch workingDir "origin" "develop"
543 | Branches.pushBranch workingDir "origin" "master"
544 | CleanDir repositoryHelperDir
545 | DeleteDir repositoryHelperDir
546 | )
547 |
548 | Target "Release" (fun _ ->
549 | trace "All released!"
550 | )
551 |
552 | Target "ReadyForBuild" ignore
553 | Target "AfterBuild" ignore
554 |
555 | // Clean all
556 | "Clean"
557 | ==> "CleanAll"
558 | "Clean_single"
559 | ==> "CleanAll_single"
560 |
561 | "Clean"
562 | =?> ("RestorePackages", config.UseNuget)
563 | =?> ("CreateDebugFiles", config.EnableDebugSymbolConversion)
564 | ==> "SetVersions"
565 | ==> "ReadyForBuild"
566 |
567 | config.BuildTargets
568 | |> Seq.iter (fun buildParam ->
569 | let buildName = sprintf "Build_%s" buildParam.SimpleBuildName
570 | "ReadyForBuild"
571 | ==> buildName
572 | |> ignore
573 | buildName
574 | ==> "AfterBuild"
575 | |> ignore
576 | )
577 |
578 | // Dependencies
579 | "AfterBuild"
580 | ==> "CopyToRelease"
581 | =?> ("CreateReleaseSymbolFiles", config.EnableDebugSymbolConversion)
582 | ==> "NuGetPack"
583 | ==> "AllDocs"
584 | ==> "All"
585 |
586 | "All"
587 | =?> ("CheckWindows", config.RestrictReleaseToWindows)
588 | ==> "VersionBump"
589 | =?> ("ReleaseGithubDoc", config.EnableGithub)
590 | ==> "NuGetPush"
591 | ==> "Release"
592 |
593 |
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/downloadNugetInclude.fsx:
--------------------------------------------------------------------------------
1 | // ----------------------------------------------------------------------------
2 | // This file is subject to the terms and conditions defined in
3 | // file 'LICENSE.txt', which is part of this source code package.
4 | // ----------------------------------------------------------------------------
5 | // Get any working NuGet.exe
6 | // It's sad that this does'nt work on mono as they don't have a working "System.IO.Compression.FileSystem.dll"
7 |
8 | open System.Net
9 | open System.IO
10 |
11 | //let nugetCommandLinePackage = "https://www.nuget.org/api/v2/package/NuGet.Commandline"
12 | //let nugetPkg = "lib/NuGet.CommandLine/NuGet.CommandLine.nupkg"
13 | let nugetLink = "https://www.nuget.org/nuget.exe"
14 | let nugetExe = "packages/NuGet.CommandLine/tools/NuGet.exe"
15 |
16 | let nugetToolsPath = Path.GetDirectoryName(nugetExe)
17 | //let nugetPath = Path.GetDirectoryName(nugetToolsPath)
18 |
19 | let downloadFile (link:string) (filePath:string) =
20 | let wc = new WebClient()
21 | wc.DownloadFile(link, filePath)
22 |
23 | Directory.CreateDirectory(nugetToolsPath) |> ignore
24 |
25 | downloadFile nugetLink nugetExe
26 | //ZipFile.ExtractToDirectory(nugetPkg, nugetPath)
27 |
--------------------------------------------------------------------------------
/packages/Yaaf.AdvancedBuilding/content/generateDocsInclude.fsx:
--------------------------------------------------------------------------------
1 | // ----------------------------------------------------------------------------
2 | // This file is subject to the terms and conditions defined in
3 | // file 'LICENSE.txt', which is part of this source code package.
4 | // ----------------------------------------------------------------------------
5 |
6 | (*
7 | This file handles the generation of the docs (it is called by the build automatically).
8 | *)
9 | #if FAKE
10 | #else
11 | // Support when file is opened in Visual Studio
12 | #load "buildConfigDef.fsx"
13 | #load "../../../buildConfig.fsx"
14 | #endif
15 |
16 | open BuildConfigDef
17 | let config = BuildConfig.buildConfig.FillDefaults()
18 |
19 | #load @"../../FSharp.Formatting/FSharp.Formatting.fsx"
20 | #r "System.Web"
21 |
22 | open System.Collections.Generic
23 | open System.IO
24 | open System.Web
25 |
26 | open Fake
27 | open Fake.Git
28 | open Fake.FSharpFormatting
29 | open AssemblyInfoFile
30 |
31 | open FSharp.Markdown
32 | open FSharp.Literate
33 | open FSharp.MetadataFormat
34 |
35 | open RazorEngine.Compilation
36 |
37 | let commitHash = lazy Information.getCurrentSHA1(".")
38 |
39 | // Documentation
40 |
41 | /// Processes an entire directory containing multiple script files
42 | /// (*.fsx) and Markdown documents (*.md) and it specifies additional
43 | /// replacements for the template file
44 |
45 | //let website_root = "file://" + Path.GetFullPath (config.OutDocDir @@ "html")
46 |
47 | let formattingContext templateFile format generateAnchors replacements layoutRoots =
48 | { TemplateFile = templateFile
49 | Replacements = defaultArg replacements []
50 | GenerateLineNumbers = true
51 | IncludeSource = false
52 | Prefix = "fs"
53 | OutputKind = defaultArg format OutputKind.Html
54 | GenerateHeaderAnchors = defaultArg generateAnchors false
55 | LayoutRoots = defaultArg layoutRoots [] }
56 |
57 | let rec replaceCodeBlocks ctx = function
58 | | Matching.LiterateParagraph(special) ->
59 | match special with
60 | | LanguageTaggedCode(lang, code) ->
61 | let inlined =
62 | match ctx.OutputKind with
63 | | OutputKind.Html ->
64 | let code = HttpUtility.HtmlEncode code
65 | let codeHtmlKey = sprintf "language-%s" lang
66 | sprintf "%s
" codeHtmlKey codeHtmlKey code
67 | | OutputKind.Latex ->
68 | sprintf "\\begin{lstlisting}\n%s\n\\end{lstlisting}" code
69 | Some(InlineBlock(inlined))
70 | | _ -> Some (EmbedParagraphs special)
71 | | Matching.ParagraphNested(pn, nested) ->
72 | let nested = List.map (List.choose (replaceCodeBlocks ctx)) nested
73 | Some(Matching.ParagraphNested(pn, nested))
74 | | par -> Some par
75 |
76 | let editLiterateDocument ctx (doc:LiterateDocument) =
77 | doc.With(paragraphs = List.choose (replaceCodeBlocks ctx) doc.Paragraphs)
78 |
79 | let printAssemblies msg =
80 | printfn "%s. Loaded Assemblies:" msg
81 | System.AppDomain.CurrentDomain.GetAssemblies()
82 | |> Seq.choose (fun a -> try Some (a.GetName().FullName, a.Location) with _ -> None)
83 | //|> Seq.filter (fun l -> l.Contains ("Razor"))
84 | |> Seq.iter (fun (n, l) -> printfn "\t- %s: %s" n l)
85 |
86 | // ITS VERY IMPORTANT TO CREATE THE EVALUATOR LAZY (see https://github.com/matthid/Yaaf.AdvancedBuilding/issues/5)
87 | let evalutator = lazy (Some <| (FsiEvaluator() :> IFsiEvaluator))
88 | //let evalutator = lazy None
89 |
90 | let buildAllDocumentation outDocDir website_root =
91 | let references = config.DocRazorReferences
92 |
93 | let projInfo =
94 | [ "root", website_root
95 | "page-description", config.ProjectDescription
96 | "page-author", config.PageAuthor
97 | "github-link", config.GithubUrl
98 | "project-name", config.ProjectName
99 | "project-summary", config.ProjectSummary
100 | "project-commit", commitHash.Value
101 | "project-author", config.ProjectAuthors |> Seq.head
102 | "project-github", config.GithubUrl
103 | "project-issues", config.IssuesUrl
104 | "project-new-issue", config.FileNewIssueUrl
105 | "project-nuget", config.NugetUrl]
106 |
107 |
108 | // Copy static files and CSS + JS from F# Formatting
109 | let copyDocContentFiles () =
110 | ensureDirectory (outDocDir @@ "html" @@ "content")
111 | CopyRecursive "./doc/content" (outDocDir @@ "html" @@ "content") true |> Log "Copying file: "
112 | //CopyRecursive (formatting @@ "styles") (output @@ "content") true
113 | // |> Log "Copying styles and scripts: "
114 |
115 |
116 |
117 | let processDocumentationFiles(outputKind) =
118 | let indexTemplate, template, outDirName, indexName, extension =
119 | match outputKind with
120 | | OutputKind.Html -> "docpage-index.cshtml", "docpage.cshtml", "html", "index.html", ".html"
121 | | OutputKind.Latex ->
122 | config.DocTemplatesDir @@ "template-color.tex", config.DocTemplatesDir @@ "template-color.tex",
123 | "latex", "Readme.tex", ".tex"
124 | let outDir = outDocDir @@ outDirName
125 | let handleDoc template (doc:LiterateDocument) outfile =
126 | // prismjs support
127 | let ctx = formattingContext (Some template) (Some outputKind) (Some true) (Some projInfo) (Some config.LayoutRoots)
128 | Templating.processFile references (editLiterateDocument ctx doc) outfile ctx
129 |
130 | let processMarkdown template infile outfile =
131 | let doc = Literate.ParseMarkdownFile( infile, ?fsiEvaluator = evalutator.Value )
132 | handleDoc template doc outfile
133 | let processScriptFile template infile outfile =
134 | let doc = Literate.ParseScriptFile( infile, ?fsiEvaluator = evalutator.Value )
135 | handleDoc template doc outfile
136 |
137 | let rec processDirectory template indir outdir =
138 | Literate.ProcessDirectory(
139 | indir, template, outdir, outputKind, generateAnchors = true, replacements = projInfo,
140 | layoutRoots = config.LayoutRoots, customizeDocument = editLiterateDocument,
141 | processRecursive = true, includeSource = true, ?fsiEvaluator = evalutator.Value,
142 | ?assemblyReferences = references)
143 |
144 | processDirectory template (Path.GetFullPath "./doc") outDir
145 | let processFile template inFile outFile =
146 | if File.Exists inFile then
147 | processMarkdown template inFile outFile
148 | else
149 | trace (sprintf "File %s was not found so %s was not created!" inFile outFile)
150 |
151 | // Handle some special files.
152 | processFile indexTemplate "./README.md" (outDir @@ indexName)
153 | processFile template "./CONTRIBUTING.md" (outDir @@ "Contributing" + extension)
154 | processFile template "./LICENSE.md" (outDir @@ "License" + extension)
155 |
156 | // Build API reference from XML comments
157 | let referenceBinaries =
158 | let xmlFiles = config.GeneratedFileList |> List.filter (fun f -> f.EndsWith(".xml"))
159 | config.GeneratedFileList
160 | |> List.filter (fun f -> f.EndsWith(".dll") || f.EndsWith(".exe"))
161 | |> List.filter (fun f ->
162 | let exists =
163 | xmlFiles |> List.exists (fun xml ->
164 | Path.GetFileNameWithoutExtension xml = Path.GetFileNameWithoutExtension f)
165 | if not exists then
166 | trace (sprintf "No .xml file is given in GeneratedFileList for %s" f)
167 | exists)
168 |
169 | let buildReference () =
170 | let referenceDir = outDocDir @@ "html"
171 | let outDir = referenceDir @@ "references"
172 | ensureDirectory referenceDir
173 | ensureDirectory outDir
174 | let libDir = config.BuildDir @@ (config.BuildTargets |> Seq.last).SimpleBuildName
175 | let binaries =
176 | referenceBinaries
177 | |> List.map (fun lib -> libDir @@ lib)
178 |
179 | MetadataFormat.Generate
180 | (binaries, Path.GetFullPath outDir, config.LayoutRoots,
181 | parameters = projInfo,
182 | libDirs = [ libDir ],
183 | otherFlags = [],
184 | sourceRepo = config.SourceReproUrl,
185 | sourceFolder = "./",
186 | publicOnly = true,
187 | markDownComments = false, // ]
5 | []
6 | []
7 | []
8 | []
9 | []
10 | do ()
11 |
12 | module internal AssemblyVersionInformation =
13 | let [] Version = "1.7.1"
14 | let [] InformationalVersion = "1.7.1"
15 |
--------------------------------------------------------------------------------
/src/Yaaf.FSharp.Scripting.sln:
--------------------------------------------------------------------------------
1 | Microsoft Visual Studio Solution File, Format Version 12.00
2 | # Visual Studio 14
3 | VisualStudioVersion = 14.0.25123.0
4 | MinimumVisualStudioVersion = 10.0.40219.1
5 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".paket", ".paket", "{63297B98-5CED-492C-A5B7-A5B4F73CF142}"
6 | ProjectSection(SolutionItems) = preProject
7 | ..\paket.dependencies = ..\paket.dependencies
8 | ..\paket.lock = ..\paket.lock
9 | EndProjectSection
10 | EndProject
11 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "doc", "doc", "{A6A6AF7D-D6E3-442D-9B1E-58CC91879BE1}"
12 | ProjectSection(SolutionItems) = preProject
13 | ..\doc\Caching.fsx = ..\doc\Caching.fsx
14 | ..\CONTRIBUTING.md = ..\CONTRIBUTING.md
15 | ..\doc\DevelopReadme.md = ..\doc\DevelopReadme.md
16 | ..\doc\IntroExamples.fsx = ..\doc\IntroExamples.fsx
17 | ..\README.md = ..\README.md
18 | ..\doc\ReleaseNotes.md = ..\doc\ReleaseNotes.md
19 | EndProjectSection
20 | EndProject
21 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project", "project", "{BF60BC93-E09B-4E5F-9D85-95A519479D54}"
22 | ProjectSection(SolutionItems) = preProject
23 | ..\buildConfig.fsx = ..\buildConfig.fsx
24 | ..\paket.dependencies = ..\paket.dependencies
25 | ..\nuget\Yaaf.FSharp.Scripting.nuspec = ..\nuget\Yaaf.FSharp.Scripting.nuspec
26 | EndProjectSection
27 | EndProject
28 | Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Yaaf.FSharp.Scripting", "source\Yaaf.FSharp.Scripting\Yaaf.FSharp.Scripting.fsproj", "{2D4E0476-7D33-449B-B895-FF1CAF9DD712}"
29 | EndProject
30 | Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Test.Yaaf.FSharp.Scripting", "test\Test.Yaaf.FSharp.Scripting\Test.Yaaf.FSharp.Scripting.fsproj", "{ED6905ED-539D-43FA-A48D-15BF4D6A1F80}"
31 | EndProject
32 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "templates", "templates", "{1532E90C-4D3F-4AB2-9636-22726F68F4E8}"
33 | ProjectSection(SolutionItems) = preProject
34 | ..\doc\templates\docpage-index.cshtml = ..\doc\templates\docpage-index.cshtml
35 | ..\doc\templates\docpage.cshtml = ..\doc\templates\docpage.cshtml
36 | ..\doc\templates\template-color.tex = ..\doc\templates\template-color.tex
37 | ..\doc\templates\template-math.tex = ..\doc\templates\template-math.tex
38 | ..\doc\templates\template.cshtml = ..\doc\templates\template.cshtml
39 | EndProjectSection
40 | EndProject
41 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reference", "reference", "{65D8785D-F9BA-4E17-9667-99ADBEAA411C}"
42 | ProjectSection(SolutionItems) = preProject
43 | ..\doc\templates\reference\module.cshtml = ..\doc\templates\reference\module.cshtml
44 | ..\doc\templates\reference\namespaces.cshtml = ..\doc\templates\reference\namespaces.cshtml
45 | ..\doc\templates\reference\part-members.cshtml = ..\doc\templates\reference\part-members.cshtml
46 | ..\doc\templates\reference\part-nested.cshtml = ..\doc\templates\reference\part-nested.cshtml
47 | ..\doc\templates\reference\type.cshtml = ..\doc\templates\reference\type.cshtml
48 | EndProjectSection
49 | EndProject
50 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{B925F738-D2CD-469E-A596-CBE4BFD67C72}"
51 | ProjectSection(SolutionItems) = preProject
52 | ..\doc\content\prism.css = ..\doc\content\prism.css
53 | ..\doc\content\prism.js = ..\doc\content\prism.js
54 | ..\doc\content\style.css = ..\doc\content\style.css
55 | ..\doc\content\tips.js = ..\doc\content\tips.js
56 | EndProjectSection
57 | EndProject
58 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{0248EE74-229A-485A-8886-CC83C099FA76}"
59 | ProjectSection(SolutionItems) = preProject
60 | ..\doc\content\img\back_to_top.png = ..\doc\content\img\back_to_top.png
61 | ..\doc\content\img\github-blue.png = ..\doc\content\img\github-blue.png
62 | ..\doc\content\img\github.png = ..\doc\content\img\github.png
63 | ..\doc\content\img\logo-template.pdn = ..\doc\content\img\logo-template.pdn
64 | ..\doc\content\img\logo.png = ..\doc\content\img\logo.png
65 | EndProjectSection
66 | EndProject
67 | Global
68 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
69 | Debug|IncludeTest = Debug|IncludeTest
70 | Debug|Net40 = Debug|Net40
71 | Debug|Net45 = Debug|Net45
72 | Release|IncludeTest = Release|IncludeTest
73 | Release|Net40 = Release|Net40
74 | Release|Net45 = Release|Net45
75 | EndGlobalSection
76 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
77 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Debug|IncludeTest.ActiveCfg = Debug|IncludeTest
78 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Debug|IncludeTest.Build.0 = Debug|IncludeTest
79 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Debug|Net40.ActiveCfg = Debug|Net40
80 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Debug|Net40.Build.0 = Debug|Net40
81 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Debug|Net45.ActiveCfg = Debug|Net45
82 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Debug|Net45.Build.0 = Debug|Net45
83 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Release|IncludeTest.ActiveCfg = Release|IncludeTest
84 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Release|IncludeTest.Build.0 = Release|IncludeTest
85 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Release|Net40.ActiveCfg = Release|Net40
86 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Release|Net40.Build.0 = Release|Net40
87 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Release|Net45.ActiveCfg = Release|Net45
88 | {2D4E0476-7D33-449B-B895-FF1CAF9DD712}.Release|Net45.Build.0 = Release|Net45
89 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Debug|IncludeTest.ActiveCfg = Debug|Net45
90 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Debug|Net40.ActiveCfg = Debug|Net40
91 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Debug|Net40.Build.0 = Debug|Net40
92 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Debug|Net45.ActiveCfg = Debug|Net45
93 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Debug|Net45.Build.0 = Debug|Net45
94 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Release|IncludeTest.ActiveCfg = Release|Net45
95 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Release|Net40.ActiveCfg = Release|Net40
96 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Release|Net40.Build.0 = Release|Net40
97 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Release|Net45.ActiveCfg = Release|Net45
98 | {ED6905ED-539D-43FA-A48D-15BF4D6A1F80}.Release|Net45.Build.0 = Release|Net45
99 | EndGlobalSection
100 | GlobalSection(SolutionProperties) = preSolution
101 | HideSolutionNode = FALSE
102 | EndGlobalSection
103 | GlobalSection(NestedProjects) = preSolution
104 | {1532E90C-4D3F-4AB2-9636-22726F68F4E8} = {A6A6AF7D-D6E3-442D-9B1E-58CC91879BE1}
105 | {65D8785D-F9BA-4E17-9667-99ADBEAA411C} = {1532E90C-4D3F-4AB2-9636-22726F68F4E8}
106 | {B925F738-D2CD-469E-A596-CBE4BFD67C72} = {A6A6AF7D-D6E3-442D-9B1E-58CC91879BE1}
107 | {0248EE74-229A-485A-8886-CC83C099FA76} = {B925F738-D2CD-469E-A596-CBE4BFD67C72}
108 | EndGlobalSection
109 | EndGlobal
110 |
--------------------------------------------------------------------------------
/src/nuget.config:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
6 |
--------------------------------------------------------------------------------
/src/source/Yaaf.FSharp.Scripting/AssemblyInfo.fs:
--------------------------------------------------------------------------------
1 | namespace System
2 | open System.Runtime.CompilerServices
3 |
4 | []
5 | do ()
--------------------------------------------------------------------------------
/src/source/Yaaf.FSharp.Scripting/Script.fsx:
--------------------------------------------------------------------------------
1 | // Learn more about F# at http://fsharp.org. See the 'F# Tutorial' project
2 | // for more guidance on F# programming.
3 |
4 | #load "Library.fs"
5 | open Yaaf.FSharp.Scripting
6 |
7 | let num = Library.hello 42
8 | printfn "%i" num
9 |
--------------------------------------------------------------------------------
/src/source/Yaaf.FSharp.Scripting/Yaaf.FSharp.Scripting.fsproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
5 | Debug
6 | Net40
7 | 2.0
8 | 2d4e0476-7d33-449b-b895-ff1caf9dd712
9 | Library
10 | Yaaf.FSharp.Scripting
11 | Yaaf.FSharp.Scripting
12 | v4.0
13 | 4.3.0.0
14 | Yaaf.FSharp.Scripting
15 | ..\..\
17 |
18 |
19 | true
20 | full
21 | false
22 | false
23 | bin
24 | DEBUG;TRACE;NET40;YAAF_FSHARP_SCRIPTING_PUBLIC
25 | 3
26 |
27 |
28 | pdbonly
29 | true
30 | true
31 | $(SolutionDir)/../build/net40
32 | TRACE;NET40;YAAF_FSHARP_SCRIPTING_PUBLIC
33 | 3
34 |
35 |
36 | true
37 | full
38 | false
39 | false
40 | v4.5
41 | bin
42 | DEBUG;TRACE;YAAF_FSHARP_SCRIPTING_PUBLIC
43 | 3
44 |
45 |
46 | pdbonly
47 | true
48 | true
49 | v4.5
50 | $(SolutionDir)/../build/net45
51 | TRACE;YAAF_FSHARP_SCRIPTING_PUBLIC
52 | 3
53 |
54 |
55 | true
56 | full
57 | false
58 | false
59 | v4.5
60 | bin
61 | DEBUG;TRACE
62 | 3
63 |
64 |
65 | pdbonly
66 | true
67 | true
68 | v4.5
69 | $(SolutionDir)/../build/include_test
70 | TRACE
71 | 3
72 |
73 |
75 |
81 |
82 |
83 | SharedAssemblyInfo.fs
84 |
85 |
89 |
90 | 11
91 |
92 |
101 |
102 |
103 |
104 | ..\..\..\packages\FSharp.Compiler.Service\lib\net40\FSharp.Compiler.Service.dll
105 | True
106 | True
107 |
108 |
109 |
110 |
111 |
112 |
113 | ..\..\..\packages\FSharp.Compiler.Service\lib\net45\FSharp.Compiler.Service.dll
114 | True
115 | True
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 | ..\..\..\packages\FSharp.Core\lib\net20\FSharp.Core.dll
125 | True
126 | True
127 |
128 |
129 |
130 |
131 |
132 |
133 | ..\..\..\packages\FSharp.Core\lib\portable-net45+netcore45\FSharp.Core.dll
134 | True
135 | True
136 |
137 |
138 |
139 |
140 |
141 |
142 | ..\..\..\packages\FSharp.Core\lib\net40\FSharp.Core.dll
143 | True
144 | True
145 |
146 |
147 |
148 |
149 |
150 |
151 | ..\..\..\packages\FSharp.Core\lib\portable-net45+monoandroid10+monotouch10+xamarinios10\FSharp.Core.dll
152 | True
153 | True
154 |
155 |
156 |
157 |
158 |
159 |
160 | ..\..\..\packages\FSharp.Core\lib\portable-net45+sl5+netcore45\FSharp.Core.dll
161 | True
162 | True
163 |
164 |
165 |
166 |
167 |
168 |
169 | ..\..\..\packages\FSharp.Core\lib\portable-net45+netcore45+wp8\FSharp.Core.dll
170 | True
171 | True
172 |
173 |
174 |
175 |
176 |
177 |
178 | ..\..\..\packages\FSharp.Core\lib\portable-net45+netcore45+wpa81+wp8\FSharp.Core.dll
179 | True
180 | True
181 |
182 |
183 |
184 |
185 |
--------------------------------------------------------------------------------
/src/source/Yaaf.FSharp.Scripting/app.config:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
8 |
9 |
12 |
13 |
16 |
17 | True
18 |
21 |
22 |
--------------------------------------------------------------------------------
/src/source/Yaaf.FSharp.Scripting/paket.references:
--------------------------------------------------------------------------------
1 | FSharp.Compiler.Service
2 | FSharp.Core
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/App.config:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
10 |
11 |
12 |
13 |
15 |
16 |
17 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
28 |
29 |
32 |
33 |
36 |
37 | True
38 |
41 |
42 |
43 |
45 |
46 |
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/ExtensionMethodTests.fs:
--------------------------------------------------------------------------------
1 | module Test.Yaaf.FSharp.Scripting.ExtensionMethodTests
2 | type T () =
3 | let _ = ()
4 | type TGen<'a> () =
5 | let _ = ()
6 | open System.IO
7 | open NUnit.Framework
8 | open Test.Yaaf.FSharp.Scripting.FsiUnquote
9 | open Yaaf.FSharp.Scripting
10 | open FSharp.Compiler.SourceCodeServices
11 |
12 | let withNoWarnings f =
13 | let builder = new System.Text.StringBuilder()
14 | use writer = new StringWriter(builder)
15 | Log.source.Switch.Level <- System.Diagnostics.SourceLevels.Warning
16 | use listener =
17 | new System.Diagnostics.TextWriterTraceListener(
18 | writer,
19 | Filter = new System.Diagnostics.EventTypeFilter(System.Diagnostics.SourceLevels.Warning))
20 | let listenerIndex = Log.source.Listeners.Add(listener)
21 | f ()
22 | Log.source.Listeners.RemoveAt(listenerIndex)
23 | writer.Flush()
24 | let logText = builder.ToString()
25 | test <@ System.String.IsNullOrWhiteSpace logText @>
26 |
27 | let testType<'a> () =
28 | withNoWarnings (fun () ->
29 | // A Assembly -> FSharpEntity mapping (extension) function
30 | let fsAssembly = FSharpAssembly.FromAssembly typeof<'a>.Assembly
31 | test <@ fsAssembly.IsSome @>
32 | test <@ fsAssembly.Value.FileName.IsSome @>
33 | // we don't require the exact same path (could be loaded from somewhere else)
34 | test <@ Path.GetFileName fsAssembly.Value.FileName.Value = Path.GetFileName typeof<'a>.Assembly.Location @>
35 | test <@ fsAssembly.Value.SimpleName = typeof<'a>.Assembly.GetName().Name @>
36 | // A extension method to find the type
37 | let fsType = fsAssembly.Value.FindType typeof<'a>
38 | test <@ fsType.IsSome @>
39 | test <@ fsType.Value.FullName = typeof<'a>.NamespaceName.Replace("+", ".") @>
40 | ())
41 |
42 | []
43 | let ``check that default assemblies generate no warnings`` () =
44 | let frameworkVersion = FSharpAssemblyHelper.defaultFrameworkVersion
45 | let sysLibs = FSharpAssemblyHelper.getDefaultSystemReferences frameworkVersion
46 | let fsCore = FSharpAssemblyHelper.findFSCore [] []
47 | //for sysLib in sysLibs do
48 | let projFileName, args = FSharpAssemblyHelper.getCheckerArguments frameworkVersion sysLibs (Some fsCore) [] [] []
49 | let options = FSharpAssemblyHelper.checker.GetProjectOptionsFromCommandLineArgs(projFileName, args)
50 | let results = FSharpAssemblyHelper.checker.ParseAndCheckProject(options) |> Async.RunSynchronously
51 | test <@ results.Errors.Length = 0 @>
52 |
53 | []
54 | let ``check that we can get the fsassembly and fstype of a custom nested type`` () =
55 | testType()
56 |
57 | []
58 | let ``check that we can get the fsassembly and fstype of a custom generic type`` () =
59 | testType()
60 |
61 | []
62 | let ``check that we can get the fsassembly and fstype of a interface type`` () =
63 | testType()
64 |
65 |
66 | []
67 | let ``check that we can get the fsassembly and fstype of int`` () =
68 | testType ()
69 |
70 | []
71 | let ``check that we can get the fsassembly and fstype of option`` () =
72 | testType> ()
73 |
74 | []
75 | let ``check that the type extensions works for typedefof`` () =
76 |
77 | let def = typedefof>
78 | test <@ def.Name = "FSharpOption`1" @>
79 | test <@ def.FullName = "Microsoft.FSharp.Core.FSharpOption`1" @>
80 |
81 | test <@ def.FSharpParamList = "<_>" @>
82 | test <@ def.FSharpFullName = "Microsoft.FSharp.Core.Option" @>
83 | test <@ def.FSharpFullNameWithTypeArgs = "Microsoft.FSharp.Core.Option<_>" @>
84 | test <@ def.FSharpName = "Option" @>
85 |
86 | []
87 | let ``check that the type extensions works for typeof`` () =
88 |
89 | let def = typeof>
90 | test <@ def.Name = "FSharpOption`1" @>
91 | test <@ def.Namespace = "Microsoft.FSharp.Core" @>
92 |
93 | test <@ def.FSharpParamList = "" @>
94 | test <@ def.FSharpFullName = "Microsoft.FSharp.Core.Option" @>
95 | test <@ def.FSharpFullNameWithTypeArgs = "Microsoft.FSharp.Core.Option" @>
96 | test <@ def.FSharpName = "Option" @>
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/FsiArgsTest.fs:
--------------------------------------------------------------------------------
1 | module Test.Yaaf.FSharp.Scripting.FsiArgsTest
2 |
3 | open System.IO
4 | open NUnit.Framework
5 | open Test.Yaaf.FSharp.Scripting.FsiUnquote
6 | open Yaaf.FSharp.Scripting
7 |
8 | let argTest args =
9 | let parsed = FsiOptions.ofArgs args
10 | let toArgs = parsed.AsArgs
11 | let parsed2 = FsiOptions.ofArgs toArgs
12 | test <@ parsed = parsed2 @>
13 | parsed
14 |
15 | []
16 | let ``Check that fsi arg-parser works`` () =
17 | argTest [| "--noninteractive"; "-g+"; "--warnaserror+:34,42" ; "--"; "test" ; "more" |] |> ignore
18 |
19 | argTest [| "-I:first"; "-I:second" |]|> ignore
20 | argTest [| "-r:first"; "-r:second" |]|> ignore
21 | argTest [| "--load:first"; "--load:second" |]|> ignore
22 | argTest [| "--use:first"; "--use:second" |]|> ignore
23 |
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/FsiSessionTests.fs:
--------------------------------------------------------------------------------
1 | module Test.Yaaf.FSharp.Scripting.FsiSessionTests
2 |
3 | open NUnit.Framework
4 | open Test.Yaaf.FSharp.Scripting.FsiUnquote
5 | open Yaaf.FSharp.Scripting
6 | open System.Text
7 | open System.IO
8 | let fsiSession = ScriptHost.CreateNew(["MYDEFINE"])
9 | let liveOut = new StringBuilder()
10 | let liveErr = new StringBuilder()
11 | let liveOutStream = new StringWriter(liveOut)
12 | let liveErrStream = new StringWriter(liveErr)
13 | let fixNewLines (l:string) = l.Replace("\r\n", "\n")
14 |
15 | []
16 | let ``Check if we don't call the forwarder`` () =
17 | let called = ref false
18 | ( use __ = ScriptHost.CreateForwardWriter ((fun _ -> called := true), removeNewLines = true)
19 | ())
20 | test <@ (not !called) @>
21 |
22 | []
23 | let ``Check if we can detect a newline charater at the end with removeNewLines`` () =
24 | let called = ref 0
25 | ( use forwarder = ScriptHost.CreateForwardWriter ((fun _ -> called := !called + 1), removeNewLines = true)
26 | forwarder.WriteLine "test")
27 | test <@ !called = 2 @>
28 |
29 | called := 0
30 | ( use forwarder = ScriptHost.CreateForwardWriter ((fun _ -> called := !called + 1), removeNewLines = true)
31 | forwarder.Write "test")
32 | test <@ !called = 1 @>
33 |
34 | []
35 | let ``Check if get the last input`` () =
36 | let sb = new StringBuilder()
37 | ( use forwarder = ScriptHost.CreateForwardWriter (sb.AppendLine >> ignore, removeNewLines = true)
38 | forwarder.Write "test"
39 | ())
40 | test <@ fixNewLines (sb.ToString()) = "test\n" @>
41 |
42 | []
43 | let ``Check if get the multiple inputs`` () =
44 | let sb = new StringBuilder()
45 | ( use forwarder = ScriptHost.CreateForwardWriter (sb.AppendLine >> ignore, removeNewLines = true)
46 | forwarder.Write "test"
47 | forwarder.Write "test1"
48 | forwarder.WriteLine ()
49 | forwarder.Write "test2"
50 | ())
51 | test <@ fixNewLines (sb.ToString()) = "testtest1\ntest2\n" @>
52 |
53 | let preventFsiSession =
54 | ScriptHost.CreateNew(
55 | ["MYDEFINE"],
56 | preventStdOut = true,
57 | outWriter = liveOutStream,
58 | errWriter = liveErrStream)
59 | let forwardFsiSession =
60 | ScriptHost.CreateNew(
61 | ["MYDEFINE"],
62 | preventStdOut = true,
63 | outWriter = ScriptHost.CreateForwardWriter (liveOut.Append >> ignore),
64 | errWriter = ScriptHost.CreateForwardWriter (liveErr.Append >> ignore))
65 | let withOutput f =
66 | liveOut.Clear() |> ignore
67 | liveErr.Clear() |> ignore
68 | f (),
69 | liveOut.ToString(), liveErr.ToString()
70 | []
71 | let ``let with a given integer type works`` () =
72 | fsiSession.Let "test" 25
73 | test <@ fsiSession.EvalExpression "test" = 25 @>
74 |
75 | []
76 | let ``test that we get the correct output`` () =
77 | let inter = fsiSession.EvalInteractionWithOutput "3 + 4"
78 | test <@ fixNewLines inter.Output.FsiOutput = "val it : int = 7\n" @>
79 |
80 | []
81 | let ``let with a given integer option type works`` () =
82 | fsiSession.Let "test" (Some 25)
83 | test <@ fsiSession.EvalExpression "test" = Some 25 @>
84 |
85 | []
86 | let ``check that default config produces no error output`` () =
87 | let _, _, err =
88 | withOutput (fun () ->
89 | ScriptHost.CreateNew(
90 | ["MYDEFINE"],
91 | preventStdOut = true,
92 | outWriter = ScriptHost.CreateForwardWriter (liveOut.Append >> ignore),
93 | errWriter = ScriptHost.CreateForwardWriter (liveErr.Append >> ignore)))
94 | test <@ System.String.IsNullOrWhiteSpace(err) @>
95 |
96 | []
97 | let ``check that defines work works`` () =
98 | fsiSession.EvalInteraction("""
99 | #if MYDEFINE
100 | let test = 125
101 | #else
102 | let test = 0
103 | #endif""")
104 | test <@ fsiSession.EvalExpression "test" = 125 @>
105 |
106 | []
107 | let ``check that fsi object works`` () =
108 | fsiSession.EvalInteraction ("""
109 | fsi.AddPrinter(fun (n:int) -> n.ToString())
110 | printfn "%d" 4
111 | """)
112 |
113 | []
114 | let ``check that compile time exceptions are wrapped`` () =
115 | Assert.Throws(fun () ->
116 | fsiSession.EvalInteraction ("""
117 | asdfasd
118 | """))
119 | |> ignore
120 |
121 | []
122 | let ``check that runtime exceptions are wrapped`` () =
123 | Assert.Throws(fun () ->
124 | fsiSession.EvalInteraction ("""
125 | ((failwith "game over") : unit)
126 | """))
127 | |> ignore
128 |
129 | []
130 | let ``check that we get print output`` () =
131 | let res = fsiSession.EvalInteractionWithOutput ("""
132 | printf "%s" "test" """)
133 | test <@ res.Output.ScriptOutput = "test" @>
134 |
135 | []
136 | let ``check that we can work with live output`` () =
137 | let _, out, err = withOutput (fun () ->
138 | let res = preventFsiSession.EvalInteractionWithOutput ("""
139 | printfn "%s" "test"
140 | eprintfn "%s" "test" """)
141 | test <@ fixNewLines res.Error.ScriptOutput = "test\n" @>)
142 | test <@ fixNewLines out = "test\n" @>
143 | test <@ fixNewLines err = "test\n" @>
144 |
145 | []
146 | let ``check that we can work with a forwarder`` () =
147 | let _, out, err = withOutput (fun () ->
148 | let res = forwardFsiSession.EvalInteractionWithOutput ("""
149 | printfn "%s" "test"
150 | eprintfn "%s" "test" """)
151 | test <@ fixNewLines res.Error.ScriptOutput = "test\n" @>)
152 | test <@ fixNewLines out = "test\n" @>
153 | test <@ fixNewLines err = "test\n" @>
154 |
155 | []
156 | let ``test Handle method`` () =
157 | match fsiSession.Handle fsiSession.EvalExpression "5 + 4" with
158 | | InvalidExpressionType _
159 | | InvalidCode _ -> Assert.Fail "expected 9"
160 | | Result r -> test <@ r = 9 @>
161 |
162 | match fsiSession.Handle fsiSession.EvalExpression "5 + 4" with
163 | | InvalidExpressionType e -> test <@ e.Value.IsSome @>
164 | | InvalidCode _
165 | | Result _ -> Assert.Fail "expected InvalidExpressionType failure"
166 |
167 | match fsiSession.Handle fsiSession.EvalExpression """failwith "test" : int """ with
168 | | InvalidCode _ -> ()
169 | | InvalidExpressionType _
170 | | Result _ -> Assert.Fail "expected InvalidCode failure"
171 |
172 | []
173 | let ``check that we can access System.IO`` () =
174 | File.WriteAllText("Test.txt", "content")
175 | try
176 | let res = fsiSession.EvalInteractionWithOutput ("""
177 | printf "%s" <| System.IO.File.ReadAllText("Test.txt") """)
178 | test <@ res.Output.ScriptOutput = "content" @>
179 | finally
180 | File.Delete("Test.txt")
181 |
182 | []
183 | let ``check that we can access System.Linq`` () =
184 | let res = fsiSession.EvalInteractionWithOutput ("""
185 | System.Linq.Enumerable.Average([1; 3]) |> int |> printf "%d" """)
186 | test <@ res.Output.ScriptOutput = "2" @>
187 |
188 | []
189 | let ``check that we can access System.Numerics`` () =
190 | let res = fsiSession.EvalInteractionWithOutput ("""
191 | typeof.Name |> printf "%s" """)
192 | test <@ res.Output.ScriptOutput = "BigInteger" @>
193 |
194 | []
195 | let ``Test that we can use objects after dispose`` () =
196 | let incFunc, getFunc =
197 | ( use fsiSession = ScriptHost.CreateNew(["MYDEFINE"])
198 | fsiSession.EvalInteraction("""let mutable t = 0""")
199 | fsiSession.EvalExpression unit>("fun () -> t <- t + 1"),
200 | fsiSession.EvalExpression int>("fun () -> t"))
201 |
202 | test <@ getFunc() = 0 @>
203 | test <@ getFunc() = 0 @>
204 | incFunc()
205 | test <@ getFunc() = 1 @>
206 | incFunc()
207 | incFunc()
208 | test <@ getFunc() = 3 @>
209 | test <@ getFunc() = 3 @>
210 |
211 | []
212 | let ``Test that we can call with full debug`` () =
213 | ( use fsiSession = ScriptHost.Create({ FsiOptions.Default with Debug = Some DebugMode.Full })
214 | let res = fsiSession.EvalInteractionWithOutput ("""
215 | System.Linq.Enumerable.Average([1; 3]) |> int |> printf "%d" """)
216 | test <@ res.Output.ScriptOutput = "2" @>)
217 |
218 | []
219 | let ``Test that we can call with no debug`` () =
220 | ( use fsiSession = ScriptHost.Create({ FsiOptions.Default with Debug = Some DebugMode.NoDebug })
221 | let res = fsiSession.EvalInteractionWithOutput ("""
222 | System.Linq.Enumerable.Average([1; 3]) |> int |> printf "%d" """)
223 | test <@ res.Output.ScriptOutput = "2" @>)
224 |
225 | []
226 | let ``Test that we can call with pdbonly debug`` () =
227 | ( use fsiSession = ScriptHost.Create({ FsiOptions.Default with Debug = Some DebugMode.PdbOnly })
228 | let res = fsiSession.EvalInteractionWithOutput ("""
229 | System.Linq.Enumerable.Average([1; 3]) |> int |> printf "%d" """)
230 | test <@ res.Output.ScriptOutput = "2" @>)
231 |
232 |
233 | []
234 | let ``Test that report local works`` () =
235 | ( use fsiSession = ScriptHost.CreateNew()
236 | match fsiSession.Handle fsiSession.EvalExpression "asdasdfasdffas" with
237 | | InvalidCode e -> test <@ e.Result.Error.FsiOutput.Contains "asdasdfasdffas" @>
238 | | InvalidExpressionType _
239 | | Result _ -> Assert.Fail "expected InvalidCode failure")
240 |
241 | []
242 | let ``Test that report global works`` () =
243 | ( use fsiSession = ScriptHost.CreateNew(reportGlobal = true)
244 | match fsiSession.Handle fsiSession.EvalExpression "asdasdfasdffas" with
245 | | InvalidCode e -> test <@ e.Result.Error.FsiOutput.Contains "asdasdfasdffas" @>
246 | | InvalidExpressionType _
247 | | Result _ -> Assert.Fail "expected InvalidCode failure")
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/Test.Yaaf.FSharp.Scripting.fsproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
5 | Debug
6 | Net40
7 | 2.0
8 | ed6905ed-539d-43fa-a48d-15bf4d6a1f80
9 | Library
10 | Test.Yaaf.FSharp.Scripting
11 | Test.Yaaf.FSharp.Scripting
12 | v4.0
13 | 4.3.1.0
14 | Yaaf.FSharp.Scripting.Tests
15 | ..\..\
17 |
18 |
19 | true
20 | full
21 | false
22 | false
23 | bin\Debug\
24 | DEBUG;TRACE
25 | 3
26 | Project
27 |
28 |
29 |
30 |
31 |
32 |
33 | pdbonly
34 | true
35 | true
36 | $(SolutionDir)/../build/test/net40
37 | TRACE
38 | 3
39 |
40 |
41 | true
42 | full
43 | false
44 | false
45 | v4.5
46 | bin\Debug\
47 | DEBUG;TRACE
48 | 3
49 | Project
50 |
51 |
52 |
53 |
54 |
55 |
56 | pdbonly
57 | true
58 | true
59 | v4.5
60 | $(SolutionDir)/../build/test/net45
61 | TRACE
62 | 3
63 |
64 |
66 | 11
67 |
68 |
78 |
85 |
86 |
91 | Yaaf.FSharp.Scripting
92 | {2d4e0476-7d33-449b-b895-ff1caf9dd712}
93 | True
94 |
95 |
96 |
97 |
98 |
99 |
100 | ..\..\..\packages\FSharp.Compiler.Service\lib\net40\FSharp.Compiler.Service.dll
101 | True
102 | True
103 |
104 |
105 |
106 |
107 |
108 |
109 | ..\..\..\packages\FSharp.Compiler.Service\lib\net45\FSharp.Compiler.Service.dll
110 | True
111 | True
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 | ..\..\..\packages\FSharp.Core\lib\net20\FSharp.Core.dll
121 | True
122 | True
123 |
124 |
125 |
126 |
127 |
128 |
129 | ..\..\..\packages\FSharp.Core\lib\portable-net45+netcore45\FSharp.Core.dll
130 | True
131 | True
132 |
133 |
134 |
135 |
136 |
137 |
138 | ..\..\..\packages\FSharp.Core\lib\net40\FSharp.Core.dll
139 | True
140 | True
141 |
142 |
143 |
144 |
145 |
146 |
147 | ..\..\..\packages\FSharp.Core\lib\portable-net45+monoandroid10+monotouch10+xamarinios10\FSharp.Core.dll
148 | True
149 | True
150 |
151 |
152 |
153 |
154 |
155 |
156 | ..\..\..\packages\FSharp.Core\lib\portable-net45+sl5+netcore45\FSharp.Core.dll
157 | True
158 | True
159 |
160 |
161 |
162 |
163 |
164 |
165 | ..\..\..\packages\FSharp.Core\lib\portable-net45+netcore45+wp8\FSharp.Core.dll
166 | True
167 | True
168 |
169 |
170 |
171 |
172 |
173 |
174 | ..\..\..\packages\FSharp.Core\lib\portable-net45+netcore45+wpa81+wp8\FSharp.Core.dll
175 | True
176 | True
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 | ..\..\..\packages\NUnit\lib\net35\nunit.framework.dll
186 | True
187 | True
188 |
189 |
190 |
191 |
192 |
193 |
194 | ..\..\..\packages\NUnit\lib\net20\NUnit.System.Linq.dll
195 | True
196 | True
197 |
198 |
199 | ..\..\..\packages\NUnit\lib\net20\nunit.framework.dll
200 | True
201 | True
202 |
203 |
204 |
205 |
206 |
207 |
208 | ..\..\..\packages\NUnit\lib\net40\nunit.framework.dll
209 | True
210 | True
211 |
212 |
213 |
214 |
215 |
216 |
217 | ..\..\..\packages\NUnit\lib\net45\nunit.framework.dll
218 | True
219 | True
220 |
221 |
222 |
223 |
224 |
225 |
226 | ..\..\..\packages\NUnit\lib\portable-net45+win8+wp8+wpa81+Xamarin.Mac+MonoAndroid10+MonoTouch10+Xamarin.iOS10\nunit.framework.dll
227 | True
228 | True
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 | ..\..\..\packages\Unquote\lib\net40\Unquote.dll
238 | True
239 | True
240 |
241 |
242 |
243 |
244 |
245 |
246 | ..\..\..\packages\Unquote\lib\net45\Unquote.dll
247 | True
248 | True
249 |
250 |
251 |
252 |
253 |
254 |
255 | ..\..\..\packages\Unquote\lib\portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1\Unquote.dll
256 | True
257 | True
258 |
259 |
260 |
261 |
262 |
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/UnquoteFix.fs:
--------------------------------------------------------------------------------
1 | /// We have the FSI-ASSEMBLY loaded, thats why we need to ensure that our Unquote 'test' method throws properly!
2 | []
3 | module Test.Yaaf.FSharp.Scripting.FsiUnquote
4 |
5 | open Swensen.Unquote
6 |
7 | open System
8 | open Microsoft.FSharp.Quotations
9 |
10 | let testFailed =
11 | let outputReducedExprsMsg =
12 | fun outputTestFailedMsg (reducedExprs:Expr list) additionalInfo ->
13 | let msg =
14 | sprintf "\n%s\n%s\n"
15 | (if additionalInfo |> String.IsNullOrWhiteSpace then "" else sprintf "\n%s\n" additionalInfo)
16 | (reducedExprs |> List.map decompile |> String.concat "\n")
17 | outputTestFailedMsg msg
18 | let outputNonFsiTestFailedMsg = (fun msg ->
19 | printfn "%s" msg
20 | NUnit.Framework.Assert.Fail(msg))
21 | outputReducedExprsMsg outputNonFsiTestFailedMsg
22 |
23 | let reduceFullyAndGetLast expr =
24 | let reducedExprs = expr |> reduceFully
25 | let lastExpr = reducedExprs |> List.rev |> List.head
26 | reducedExprs, lastExpr
27 |
28 | let inline test (expr:Expr) =
29 | let reducedExprs, lastExpr = reduceFullyAndGetLast expr
30 | match lastExpr with
31 | | DerivedPatterns.Bool(true) -> ()
32 | | _ ->
33 | //try
34 | testFailed reducedExprs ""
35 | //with
36 | //| e -> raise e //we catch and raise e here to hide stack traces for clean test framework output
37 |
38 | let inline expectedExnButWrongExnRaisedMsg ty1 ty2 = sprintf "Expected exception of type '%s', but '%s' was raised instead" ty1 ty2
39 | let inline expectedExnButNoExnRaisedMsg ty1 = sprintf "Expected exception of type '%s', but no exception was raised" ty1
40 | ///Test wether the given expr fails with the given expected exception (or a subclass thereof).
41 | let inline raises<'a when 'a :> exn> (expr:Expr) =
42 | let reducedExprs, lastExpr = reduceFullyAndGetLast expr
43 | match lastExpr with
44 | | Patterns.Value(lastValue,lastValueTy) when isNull lastValue |> not && typeof.IsAssignableFrom(lastValueTy) -> //it's an exception
45 | if typeof<'a>.IsAssignableFrom(lastValueTy) then () //it's the correct exception
46 | else //it's not the correct exception
47 | //try
48 | testFailed reducedExprs (expectedExnButWrongExnRaisedMsg typeof<'a>.Name (lastValueTy.Name))
49 | //with
50 | //| e -> raise e
51 | | _ -> //it's not an exception
52 | //try
53 | testFailed reducedExprs (expectedExnButNoExnRaisedMsg typeof<'a>.Name)
54 | //with
55 | //| e -> raise e
56 |
57 | ///Test wether the given expr fails with the given expected exception (or a subclass thereof) when the additional assertion on the exception object holds.
58 | let inline raisesWith<'a when 'a :> exn> (expr:Expr) (exnWhen: 'a -> Expr) =
59 | let reducedExprs, lastExpr = reduceFullyAndGetLast expr
60 | match lastExpr with
61 | | Patterns.Value(lastValue,lastValueTy) when isNull lastValue |> not && typeof.IsAssignableFrom(lastValueTy) -> //it's an exception
62 | if typeof<'a>.IsAssignableFrom(lastValueTy) then //it's the correct exception
63 | //but we also need to check the exnWhen condition is true
64 | let lastValue = lastValue :?> 'a
65 | let exnWhenExpr = exnWhen lastValue
66 | let exnWhenReducedExprs, exnWhenLastExpr = reduceFullyAndGetLast exnWhenExpr
67 | match exnWhenLastExpr with
68 | | DerivedPatterns.Bool(true) -> () //the exnWhen condition is true
69 | | _ ->
70 | //try
71 | testFailed reducedExprs (sprintf "The expected exception was raised, but the exception assertion failed:\n\nException Assertion:\n\n%s\n\nTest Expression:" (exnWhenReducedExprs |> List.map decompile |> String.concat "\n"))
72 | //with
73 | //| e -> raise e //we catch and raise e here to hide stack traces for clean test framework output
74 |
75 | else //it's not the correct exception
76 | //try
77 | testFailed reducedExprs (expectedExnButWrongExnRaisedMsg typeof<'a>.Name (lastValueTy.Name))
78 | //with
79 | //| e -> raise e
80 | | _ -> //it's not an exception
81 | //try
82 | testFailed reducedExprs (expectedExnButNoExnRaisedMsg typeof<'a>.Name)
83 | //with
84 | //| e -> raise e
85 |
86 | let inline (=?) x y = test <@ x = y @>
87 | let inline (
88 | let inline (>?) x y = test <@ x > y @>
89 | let inline (<=?) x y = test <@ x <= y @>
90 | let inline (>=?) x y = test <@ x >= y @>
91 | let inline (<>?) x y = test <@ x <> y @>
--------------------------------------------------------------------------------
/src/test/Test.Yaaf.FSharp.Scripting/paket.references:
--------------------------------------------------------------------------------
1 | NUnit
2 | NUnit.Runners
3 | Unquote
4 | FSharp.Compiler.Service
5 | FSharp.Core
--------------------------------------------------------------------------------
28 |
35 | -
29 |
- fsharp.org 30 |
- F# Compiler Services
31 |
- F# Formatting
32 |
@Properties["project-name"]
34 |36 |
37 |
72 |
38 | @RenderBody()
39 |
40 |
41 |
42 |
43 |
44 |
45 |
70 |
71 |
43 |
44 |
45 |
70 | %s