From 8275080858e4b0d82b13d74177ff6b2400f5b908 Mon Sep 17 00:00:00 2001 From: SteveGilham Date: Sat, 17 Aug 2024 14:25:00 +0100 Subject: [PATCH] [skip ci] Update release notes & project documentation --- AltCover.DotNet/DotNet.fs | 2 +- AltCover.Engine/TypeSafe.fsi | 12 +++---- AltCover.PowerShell/CoverageFormats.fs | 2 +- ReleaseNotes.md | 4 ++- docs/AltCover.Base/AltCover.Base-apidoc.md | 3 ++ .../AltCover.Cake/CollectOptions-apidoc.md | 1 + .../CollectOptions/Packages-apidoc.md | 14 ++++++++ .../AltCover/Options.Collect-apidoc.md | 1 + .../Options.Collect/Packages-apidoc.md | 12 +++++++ docs/AltCover.Engine/Abstract-fsapidoc.md | 1 + docs/AltCover.Engine/AltCover-fsapidoc.md | 1 + .../Abstract.ICollectOptions-apidoc.md | 1 + .../Packages-apidoc.md | 14 ++++++++ .../AltCover.CollectOptions-apidoc.md | 1 + .../Packages-apidoc.md | 14 ++++++++ .../AltCover/Collect-apidoc.md | 1 + .../AltCover/Collect/Packages-apidoc.md | 14 ++++++++ .../Primitive.CollectOptions-apidoc.md | 1 + .../CollectOptions-apidoc.md | 6 ++-- .../Packages-apidoc.md | 14 ++++++++ .../AltCover/TypeSafe-apidoc.md | 2 ++ .../TypeSafe.CollectOptions-apidoc.md | 1 + .../CollectOptions-apidoc.md | 3 +- .../Packages-apidoc.md | 15 +++++++++ .../AltCover/TypeSafe.Package-apidoc.md | 20 ++++++++++++ .../TypeSafe.Package/AsString-apidoc.md | 18 +++++++++++ .../TypeSafe.Package/NewPackage-apidoc.md | 12 +++++++ .../AltCover/TypeSafe.Packages-apidoc.md | 24 ++++++++++++++ .../TypeSafe.Packages.Packages-apidoc.md | 14 ++++++++ .../AltCover/TypeSafe.Packages.Tags-apidoc.md | 19 +++++++++++ .../NoPackage-apidoc.md | 12 +++++++ .../TypeSafe.Packages.Tags/Packages-apidoc.md | 12 +++++++ .../TypeSafe.Packages/AsStrings-apidoc.md | 18 +++++++++++ .../TypeSafe.Packages/NewPackages-apidoc.md | 13 ++++++++ .../TypeSafe.Packages/get_NoPackage-apidoc.md | 12 +++++++ docs/AltCover.Engine/Primitive-fsapidoc.md | 1 + docs/AltCover.Engine/Tasks-fsapidoc.md | 1 + docs/AltCover.Engine/TypeSafe-fsapidoc.md | 17 ++++++++++ .../Abstract-fsapidoc.md | 1 + .../AltCover-fsapidoc.md | 1 + .../Primitive-fsapidoc.md | 1 + .../TypeSafe-fsapidoc.md | 17 ++++++++++ .../ConvertToCoberturaCommand-apidoc.md | 1 + .../Package-apidoc.md | 14 ++++++++ .../InvokeAltCoverCommand-apidoc.md | 1 + .../InvokeAltCoverCommand/Package-apidoc.md | 14 ++++++++ .../ConvertToCobertura-apidoc.md | 3 +- .../CoverageFormats-fsapidoc.md | 2 +- docs/PowerShell-integration.md | 32 ++++++++++++++++--- docs/Usage.md | 4 ++- docs/`dotnet-test`-integration.md | 1 + 51 files changed, 404 insertions(+), 21 deletions(-) create mode 100644 docs/AltCover.Base/AltCover.Base-apidoc.md create mode 100644 docs/AltCover.Cake/AltCover.Cake/CollectOptions/Packages-apidoc.md create mode 100644 docs/AltCover.DotNet/AltCover/Options.Collect/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/Abstract.ICollectOptions/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/AltCover.CollectOptions/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/Collect/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/Primitive.CollectOptions/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Package/AsString-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Package/NewPackage-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages.Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/NoPackage-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/Packages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages/NewPackages-apidoc.md create mode 100644 docs/AltCover.Engine/AltCover/TypeSafe.Packages/get_NoPackage-apidoc.md create mode 100644 docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand/Package-apidoc.md create mode 100644 docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Package-apidoc.md diff --git a/AltCover.DotNet/DotNet.fs b/AltCover.DotNet/DotNet.fs index 5f4e3ce82..3d001d28f 100644 --- a/AltCover.DotNet/DotNet.fs +++ b/AltCover.DotNet/DotNet.fs @@ -145,7 +145,7 @@ module DotNet = "AvoidMethodWithUnusedGenericTypeRule", Justification = "It just be like that")>] let internal toCollectListArgArgumentList (collect: Abstract.ICollectOptions) = - [ fromList, "Packages", collect.Packages ] //=`"pipe `'|'` separated list of method name regexs" + [ fromList, "Packages", collect.Packages ] //=`"pipe `'|'` separated list of source root paths" let internal toSharedFromValueArgumentList (verbosity: System.Diagnostics.TraceLevel) diff --git a/AltCover.Engine/TypeSafe.fsi b/AltCover.Engine/TypeSafe.fsi index aabf4fc3e..65d49eb55 100644 --- a/AltCover.Engine/TypeSafe.fsi +++ b/AltCover.Engine/TypeSafe.fsi @@ -118,7 +118,7 @@ namespace AltCoverFake.DotNet.Testing // ### Cobertura package roots // ``` /// - /// Corresponds to a value after `-- ` on the command line + /// Corresponds to a cobertura package source root /// [] type Package = @@ -128,13 +128,13 @@ namespace AltCoverFake.DotNet.Testing | Package of System.String with /// - /// Returns the string to be used in the effective command line + /// Returns the string to be used as a package root /// - ///the string to be used in the effective command line + ///the string to be used as a package root member AsString : unit -> System.String end /// - /// Corresponds to the values after `-- ` on the command line + /// Corresponds to a collection of cobertura package source roots /// [] type Packages = @@ -148,9 +148,9 @@ namespace AltCoverFake.DotNet.Testing | NoPackage with /// - /// Returns the strings to be used in the effective command line + /// Returns the strings to be used to be used as package roots /// - ///the strings to be used in the effective command line + ///the strings to be used as package roots member AsStrings : unit -> seq end // ``` diff --git a/AltCover.PowerShell/CoverageFormats.fs b/AltCover.PowerShell/CoverageFormats.fs index db91836bd..4f0111f95 100644 --- a/AltCover.PowerShell/CoverageFormats.fs +++ b/AltCover.PowerShell/CoverageFormats.fs @@ -249,7 +249,7 @@ type ConvertToCoberturaCommand() = member val OutputFile: string = String.Empty with get, set /// - /// Output as file path + /// Package source roots /// [ diff --git a/docs/AltCover.Cake/AltCover.Cake/CollectOptions-apidoc.md b/docs/AltCover.Cake/AltCover.Cake/CollectOptions-apidoc.md index 6af22c4ba..a87bee70d 100644 --- a/docs/AltCover.Cake/AltCover.Cake/CollectOptions-apidoc.md +++ b/docs/AltCover.Cake/AltCover.Cake/CollectOptions-apidoc.md @@ -17,6 +17,7 @@ public class CollectOptions | [ExposeReturnCode](CollectOptions/ExposeReturnCode-apidoc) { get; } | Gets whether to expose a program return code (overridden by the MSBuild integration) | | virtual [LcovReport](CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` | | virtual [OutputFile](CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` | +| [Packages](CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` | | [RecorderDirectory](CollectOptions/RecorderDirectory-apidoc) { get; } | Gets the recorder directory (overridden by the MSBuild integration) | | virtual [SummaryFormat](CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` | | virtual [Threshold](CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` | diff --git a/docs/AltCover.Cake/AltCover.Cake/CollectOptions/Packages-apidoc.md b/docs/AltCover.Cake/AltCover.Cake/CollectOptions/Packages-apidoc.md new file mode 100644 index 000000000..9dce5e750 --- /dev/null +++ b/docs/AltCover.Cake/AltCover.Cake/CollectOptions/Packages-apidoc.md @@ -0,0 +1,14 @@ +# CollectOptions.Packages property + +Corresponds to command line option `-p, --package=VALUE` + +```csharp +public IEnumerable Packages { get; } +``` + +## See Also + +* class [CollectOptions](../CollectOptions-apidoc) +* namespace [AltCover.Cake](../../AltCover.Cake-apidoc) + + diff --git a/docs/AltCover.DotNet/AltCover/Options.Collect-apidoc.md b/docs/AltCover.DotNet/AltCover/Options.Collect-apidoc.md index 73f94acca..359f55379 100644 --- a/docs/AltCover.DotNet/AltCover/Options.Collect-apidoc.md +++ b/docs/AltCover.DotNet/AltCover/Options.Collect-apidoc.md @@ -15,6 +15,7 @@ public class Collect | [ExposeReturnCode](Options.Collect/ExposeReturnCode-apidoc) { get; set; } | | | [LcovReport](Options.Collect/LcovReport-apidoc) { get; set; } | | | [OutputFile](Options.Collect/OutputFile-apidoc) { get; set; } | | +| [Packages](Options.Collect/Packages-apidoc) { get; set; } | | | [RecorderDirectory](Options.Collect/RecorderDirectory-apidoc) { get; set; } | | | [SummaryFormat](Options.Collect/SummaryFormat-apidoc) { get; set; } | | | [Threshold](Options.Collect/Threshold-apidoc) { get; set; } | | diff --git a/docs/AltCover.DotNet/AltCover/Options.Collect/Packages-apidoc.md b/docs/AltCover.DotNet/AltCover/Options.Collect/Packages-apidoc.md new file mode 100644 index 000000000..46e04223f --- /dev/null +++ b/docs/AltCover.DotNet/AltCover/Options.Collect/Packages-apidoc.md @@ -0,0 +1,12 @@ +# Options.Collect.Packages property + +```csharp +public IEnumerable Packages { get; set; } +``` + +## See Also + +* class [Collect](../Options.Collect-apidoc) +* namespace [AltCover](../../AltCover.DotNet-apidoc) + + diff --git a/docs/AltCover.Engine/Abstract-fsapidoc.md b/docs/AltCover.Engine/Abstract-fsapidoc.md index 5829a372f..a67e6a0df 100644 --- a/docs/AltCover.Engine/Abstract-fsapidoc.md +++ b/docs/AltCover.Engine/Abstract-fsapidoc.md @@ -34,6 +34,7 @@ The members correspond to the like-named command line options for `AltCover Runn abstract member LcovReport : String with get abstract member Threshold : String with get abstract member Cobertura : String with get + abstract member Packages : IEnumerable with get abstract member OutputFile : String with get abstract member CommandLine : IEnumerable with get abstract member ExposeReturnCode : bool with get diff --git a/docs/AltCover.Engine/AltCover-fsapidoc.md b/docs/AltCover.Engine/AltCover-fsapidoc.md index e20c5931f..a6f79b603 100644 --- a/docs/AltCover.Engine/AltCover-fsapidoc.md +++ b/docs/AltCover.Engine/AltCover-fsapidoc.md @@ -55,6 +55,7 @@ The members correspond to the like-named command line options for `AltCover Runn member LcovReport : System.String member Threshold : System.String member Cobertura : System.String + member Packages : seq member OutputFile : System.String member CommandLine : seq member ExposeReturnCode : bool diff --git a/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions-apidoc.md b/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions-apidoc.md index 3dbdc5816..a9754d703 100644 --- a/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions-apidoc.md @@ -30,6 +30,7 @@ public interface ICollectOptions | [ExposeReturnCode](Abstract.ICollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [LcovReport](Abstract.ICollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` | | [OutputFile](Abstract.ICollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` | +| [Packages](Abstract.ICollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` | | [RecorderDirectory](Abstract.ICollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` | | [SummaryFormat](Abstract.ICollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` | | [Threshold](Abstract.ICollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions/Packages-apidoc.md b/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions/Packages-apidoc.md new file mode 100644 index 000000000..310a6bfbe --- /dev/null +++ b/docs/AltCover.Engine/AltCover/Abstract.ICollectOptions/Packages-apidoc.md @@ -0,0 +1,14 @@ +# Abstract.ICollectOptions.Packages property + +Corresponds to command line option `-p, --package=VALUE` + +```csharp +public IEnumerable Packages { get; } +``` + +## See Also + +* interface [ICollectOptions](../Abstract.ICollectOptions-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/AltCover.CollectOptions-apidoc.md b/docs/AltCover.Engine/AltCover/AltCover.CollectOptions-apidoc.md index 2992d006a..29cbca340 100644 --- a/docs/AltCover.Engine/AltCover/AltCover.CollectOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/AltCover.CollectOptions-apidoc.md @@ -19,6 +19,7 @@ public abstract class CollectOptions : IEquatable, IStructuralEq | [ExposeReturnCode](AltCover.CollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [LcovReport](AltCover.CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` | | [OutputFile](AltCover.CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` | +| [Packages](AltCover.CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` | | [RecorderDirectory](AltCover.CollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` | | [SummaryFormat](AltCover.CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` | | [Threshold](AltCover.CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/AltCover.CollectOptions/Packages-apidoc.md b/docs/AltCover.Engine/AltCover/AltCover.CollectOptions/Packages-apidoc.md new file mode 100644 index 000000000..7246124cf --- /dev/null +++ b/docs/AltCover.Engine/AltCover/AltCover.CollectOptions/Packages-apidoc.md @@ -0,0 +1,14 @@ +# AltCover.CollectOptions.Packages property + +Corresponds to command line option `-p, --package=VALUE` + +```csharp +public IEnumerable Packages { get; } +``` + +## See Also + +* class [CollectOptions](../AltCover.CollectOptions-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/Collect-apidoc.md b/docs/AltCover.Engine/AltCover/Collect-apidoc.md index 254d8278f..a12eae0b3 100644 --- a/docs/AltCover.Engine/AltCover/Collect-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Collect-apidoc.md @@ -17,6 +17,7 @@ public class Collect : Task | [ExposeReturnCode](Collect/ExposeReturnCode-apidoc) { get; set; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [LcovReport](Collect/LcovReport-apidoc) { get; set; } | Corresponds to command line option `-l, --lcovReport=VALUE` | | [OutputFile](Collect/OutputFile-apidoc) { get; set; } | Corresponds to command line option `-o, --outputFile=VALUE` | +| [Packages](Collect/Packages-apidoc) { get; set; } | Corresponds to command line option `-p, --package=VALUE` | | [RecorderDirectory](Collect/RecorderDirectory-apidoc) { get; set; } | Corresponds to command line option `-r, --recorderDirectory=VALUE`; a required parameter | | [Summary](Collect/Summary-apidoc) { get; } | Task output calue, the summary of coverage. | | [SummaryFormat](Collect/SummaryFormat-apidoc) { get; set; } | Corresponds to command line option `--teamcity[=VALUE]` | diff --git a/docs/AltCover.Engine/AltCover/Collect/Packages-apidoc.md b/docs/AltCover.Engine/AltCover/Collect/Packages-apidoc.md new file mode 100644 index 000000000..7ecdedf0f --- /dev/null +++ b/docs/AltCover.Engine/AltCover/Collect/Packages-apidoc.md @@ -0,0 +1,14 @@ +# Collect.Packages property + +Corresponds to command line option `-p, --package=VALUE` + +```csharp +public string[] Packages { get; set; } +``` + +## See Also + +* class [Collect](../Collect-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/Primitive.CollectOptions-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.CollectOptions-apidoc.md index 987f84974..aa0225605 100644 --- a/docs/AltCover.Engine/AltCover/Primitive.CollectOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Primitive.CollectOptions-apidoc.md @@ -18,6 +18,7 @@ public sealed class CollectOptions : IEquatable, IStructuralEqua | [ExposeReturnCode](Primitive.CollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [LcovReport](Primitive.CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` | | [OutputFile](Primitive.CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` | +| [Packages](Primitive.CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` | | [RecorderDirectory](Primitive.CollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` | | [SummaryFormat](Primitive.CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` | | [Threshold](Primitive.CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/CollectOptions-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/CollectOptions-apidoc.md index 807222c1a..3d76d2e5c 100644 --- a/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/CollectOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/CollectOptions-apidoc.md @@ -2,9 +2,9 @@ ```csharp public CollectOptions(string recorderDirectory, string workingDirectory, string executable, - string lcovReport, string threshold, string cobertura, string outputFile, - IEnumerable commandLine, bool exposeReturnCode, string summaryFormat, - TraceLevel verbosity) + string lcovReport, string threshold, string cobertura, IEnumerable packages, + string outputFile, IEnumerable commandLine, bool exposeReturnCode, + string summaryFormat, TraceLevel verbosity) ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/Packages-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/Packages-apidoc.md new file mode 100644 index 000000000..f54a33a4d --- /dev/null +++ b/docs/AltCover.Engine/AltCover/Primitive.CollectOptions/Packages-apidoc.md @@ -0,0 +1,14 @@ +# Primitive.CollectOptions.Packages property + +Corresponds to command line option `-p, --package=VALUE` + +```csharp +public IEnumerable Packages { get; } +``` + +## See Also + +* class [CollectOptions](../Primitive.CollectOptions-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe-apidoc.md index 7dd9526d5..4db625905 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe-apidoc.md @@ -22,6 +22,8 @@ public static class TypeSafe | abstract class [FilterItem](TypeSafe.FilterItem-apidoc) | Corresponds to a filter entry | | abstract class [Filters](TypeSafe.Filters-apidoc) | Corresponds to a collection of filter entries | | abstract class [Flag](TypeSafe.Flag-apidoc) | Corresponds to a yes/no choice | +| class [Package](TypeSafe.Package-apidoc) | Corresponds to a cobertura package source root | +| abstract class [Packages](TypeSafe.Packages-apidoc) | Corresponds to a collection of cobertura package source roots | | class [PrepareOptions](TypeSafe.PrepareOptions-apidoc) | Command line options for `AltCover` | | class [ReportFormat](TypeSafe.ReportFormat-apidoc) | Corresponds to the desired format of the XML report | | class [StaticFormat](TypeSafe.StaticFormat-apidoc) | Corresponds to a an option for treating trivial methods | diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions-apidoc.md index ce5f32d2b..b1ddd12b4 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions-apidoc.md @@ -18,6 +18,7 @@ public sealed class CollectOptions : IEquatable, IStructuralEqua | [ExposeReturnCode](TypeSafe.CollectOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [LcovReport](TypeSafe.CollectOptions/LcovReport-apidoc) { get; } | Corresponds to command line option `-l, --lcovReport=VALUE` | | [OutputFile](TypeSafe.CollectOptions/OutputFile-apidoc) { get; } | Corresponds to command line option `-o, --outputFile=VALUE` | +| [Packages](TypeSafe.CollectOptions/Packages-apidoc) { get; } | Corresponds to command line option `-p, --package=VALUE` | | [RecorderDirectory](TypeSafe.CollectOptions/RecorderDirectory-apidoc) { get; } | Corresponds to command line option `-r, --recorderDirectory=VALUE` | | [SummaryFormat](TypeSafe.CollectOptions/SummaryFormat-apidoc) { get; } | Corresponds to command line option `--teamcity[=VALUE]` | | [Threshold](TypeSafe.CollectOptions/Threshold-apidoc) { get; } | Corresponds to command line option `-t, --threshold=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/CollectOptions-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/CollectOptions-apidoc.md index 769c0db2b..2172f6cbb 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/CollectOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/CollectOptions-apidoc.md @@ -3,7 +3,7 @@ ```csharp public CollectOptions(DirectoryPath recorderDirectory, DirectoryPath workingDirectory, FilePath executable, FilePath lcovReport, Threshold threshold, FilePath cobertura, - FilePath outputFile, CommandLine commandLine, Flag exposeReturnCode, + Packages packages, FilePath outputFile, CommandLine commandLine, Flag exposeReturnCode, SummaryFormat summaryFormat, TraceLevel verbosity) ``` @@ -12,6 +12,7 @@ public CollectOptions(DirectoryPath recorderDirectory, DirectoryPath workingDire * class [DirectoryPath](../TypeSafe.DirectoryPath-apidoc) * class [FilePath](../TypeSafe.FilePath-apidoc) * class [Threshold](../TypeSafe.Threshold-apidoc) +* class [Packages](../TypeSafe.Packages-apidoc) * class [CommandLine](../TypeSafe.CommandLine-apidoc) * class [Flag](../TypeSafe.Flag-apidoc) * class [SummaryFormat](../TypeSafe.SummaryFormat-apidoc) diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/Packages-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/Packages-apidoc.md new file mode 100644 index 000000000..bcba389af --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.CollectOptions/Packages-apidoc.md @@ -0,0 +1,15 @@ +# TypeSafe.CollectOptions.Packages property + +Corresponds to command line option `-p, --package=VALUE` + +```csharp +public Packages Packages { get; } +``` + +## See Also + +* class [Packages](../TypeSafe.Packages-apidoc) +* class [CollectOptions](../TypeSafe.CollectOptions-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md new file mode 100644 index 000000000..ae1d4a2a4 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md @@ -0,0 +1,20 @@ +# TypeSafe.Package class + +Corresponds to a value after `-- ` on the command line + +```csharp +public sealed class Package : IEquatable, IStructuralEquatable +``` + +## Public Members + +| name | description | +| --- | --- | +| static [NewPackage](TypeSafe.Package/NewPackage-apidoc)(…) | | +| [AsString](TypeSafe.Package/AsString-apidoc)() | Returns the string to be used as a package root | +## See Also + +* class [TypeSafe](./TypeSafe-apidoc) +* namespace [AltCover](../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Package/AsString-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Package/AsString-apidoc.md new file mode 100644 index 000000000..c6caead84 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Package/AsString-apidoc.md @@ -0,0 +1,18 @@ +# TypeSafe.Package.AsString method + +Returns the string to be used as a package root + +```csharp +public string AsString() +``` + +## Return Value + +the string to be used as a package root + +## See Also + +* class [Package](../TypeSafe.Package-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Package/NewPackage-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Package/NewPackage-apidoc.md new file mode 100644 index 000000000..5f78e85cd --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Package/NewPackage-apidoc.md @@ -0,0 +1,12 @@ +# TypeSafe.Package.NewPackage method + +```csharp +public static Package NewPackage(string item) +``` + +## See Also + +* class [Package](../TypeSafe.Package-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md new file mode 100644 index 000000000..6a7e0c110 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md @@ -0,0 +1,24 @@ +# TypeSafe.Packages class + +Corresponds to the values after `-- ` on the command line + +```csharp +public abstract class Packages : IEquatable, IStructuralEquatable +``` + +## Public Members + +| name | description | +| --- | --- | +| static [get_NoPackage](TypeSafe.Packages/get_NoPackage-apidoc)() | | +| static [NewPackages](TypeSafe.Packages/NewPackages-apidoc)(…) | | +| [AsStrings](TypeSafe.Packages/AsStrings-apidoc)() | Returns the strings to be used to be used as package roots | +| class [Packages](TypeSafe.Packages.Packages-apidoc) | Strongly typed string collection | +| static class [Tags](TypeSafe.Packages.Tags-apidoc) | | + +## See Also + +* class [TypeSafe](./TypeSafe-apidoc) +* namespace [AltCover](../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Packages-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Packages-apidoc.md new file mode 100644 index 000000000..fd8a85e25 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Packages-apidoc.md @@ -0,0 +1,14 @@ +# TypeSafe.Packages.Packages class + +Strongly typed string collection + +```csharp +public class Packages : Packages +``` + +## See Also + +* class [Packages](./TypeSafe.Packages-apidoc) +* namespace [AltCover](../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags-apidoc.md new file mode 100644 index 000000000..e51fd8a9d --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags-apidoc.md @@ -0,0 +1,19 @@ +# TypeSafe.Packages.Tags class + +```csharp +public static class Tags +``` + +## Public Members + +| name | description | +| --- | --- | +| const [NoPackage](TypeSafe.Packages.Tags/NoPackage-apidoc) | | +| const [Packages](TypeSafe.Packages.Tags/Packages-apidoc) | | + +## See Also + +* class [Packages](./TypeSafe.Packages-apidoc) +* namespace [AltCover](../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/NoPackage-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/NoPackage-apidoc.md new file mode 100644 index 000000000..e9d5cb123 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/NoPackage-apidoc.md @@ -0,0 +1,12 @@ +# TypeSafe.Packages.Tags.NoPackage field + +```csharp +public const int NoPackage; +``` + +## See Also + +* class [Tags](../TypeSafe.Packages.Tags-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/Packages-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/Packages-apidoc.md new file mode 100644 index 000000000..990bd2daa --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages.Tags/Packages-apidoc.md @@ -0,0 +1,12 @@ +# TypeSafe.Packages.Tags.Packages field + +```csharp +public const int Packages; +``` + +## See Also + +* class [Tags](../TypeSafe.Packages.Tags-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md new file mode 100644 index 000000000..091e85990 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md @@ -0,0 +1,18 @@ +# TypeSafe.Packages.AsStrings method + +Returns the strings to be used to be used as package roots + +```csharp +public IEnumerable AsStrings() +``` + +## Return Value + +the strings to be used to be used as package roots + +## See Also + +* class [Packages](../TypeSafe.Packages-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages/NewPackages-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/NewPackages-apidoc.md new file mode 100644 index 000000000..428821561 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/NewPackages-apidoc.md @@ -0,0 +1,13 @@ +# TypeSafe.Packages.NewPackages method + +```csharp +public static Packages NewPackages(IEnumerable item) +``` + +## See Also + +* class [Package](../TypeSafe.Package-apidoc) +* class [Packages](../TypeSafe.Packages-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages/get_NoPackage-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/get_NoPackage-apidoc.md new file mode 100644 index 000000000..ae1375032 --- /dev/null +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/get_NoPackage-apidoc.md @@ -0,0 +1,12 @@ +# TypeSafe.Packages.get_NoPackage method + +```csharp +public static Packages get_NoPackage() +``` + +## See Also + +* class [Packages](../TypeSafe.Packages-apidoc) +* namespace [AltCover](../../AltCover.Engine-apidoc) + + diff --git a/docs/AltCover.Engine/Primitive-fsapidoc.md b/docs/AltCover.Engine/Primitive-fsapidoc.md index e51a65c74..d3d651d3e 100644 --- a/docs/AltCover.Engine/Primitive-fsapidoc.md +++ b/docs/AltCover.Engine/Primitive-fsapidoc.md @@ -36,6 +36,7 @@ The members correspond to the like-named command line options for `AltCover Runn LcovReport: System.String Threshold: System.String Cobertura: System.String + Packages : seq OutputFile: System.String CommandLine: seq ExposeReturnCode: bool diff --git a/docs/AltCover.Engine/Tasks-fsapidoc.md b/docs/AltCover.Engine/Tasks-fsapidoc.md index eb7a07880..3d3f35839 100644 --- a/docs/AltCover.Engine/Tasks-fsapidoc.md +++ b/docs/AltCover.Engine/Tasks-fsapidoc.md @@ -75,6 +75,7 @@ type Collect = member LcovReport : string with get, set member Threshold : string with get, set member Cobertura : string with get, set + member Packages : string array with get, set member OutputFile : string with get, set member CommandLine : string array with get, set member ExposeReturnCode : bool with get, set diff --git a/docs/AltCover.Engine/TypeSafe-fsapidoc.md b/docs/AltCover.Engine/TypeSafe-fsapidoc.md index 94027c493..4e56884a5 100644 --- a/docs/AltCover.Engine/TypeSafe-fsapidoc.md +++ b/docs/AltCover.Engine/TypeSafe-fsapidoc.md @@ -54,6 +54,22 @@ This holds the strongly-typed equivalent of the command line options member AsStrings : unit -> seq end ``` +### Cobertura package roots +``` + [] + type Package = + | Package of System.String + with + member AsString : unit -> System.String + end + [] + type Packages = + | Packages of seq + | NoPackage + with + member AsStrings : unit -> seq + end +``` ### Coverage thresholds ``` [] @@ -193,6 +209,7 @@ The members correspond to the like-named command line options for `AltCover Runn LcovReport: FilePath Threshold: Threshold Cobertura: FilePath + Packages : Packages OutputFile: FilePath CommandLine: CommandLine ExposeReturnCode: Flag diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md index 2f4dbaac5..153f0cf76 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md @@ -34,6 +34,7 @@ The members correspond to the like-named command line options for `AltCover Runn abstract member LcovReport : String with get abstract member Threshold : String with get abstract member Cobertura : String with get + abstract member Packages : IEnumerable with get abstract member OutputFile : String with get abstract member CommandLine : IEnumerable with get abstract member ExposeReturnCode : bool with get diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md index 9a1cfa14d..fc9fa3250 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md @@ -68,6 +68,7 @@ The members correspond to the like-named command line options for `AltCover Runn member LcovReport : System.String member Threshold : System.String member Cobertura : System.String + member Packages : seq member OutputFile : System.String member CommandLine : seq member ExposeReturnCode : bool diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md index ec143d25e..ed9f1ceaf 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md @@ -36,6 +36,7 @@ The members correspond to the like-named command line options for `AltCover Runn LcovReport: System.String Threshold: System.String Cobertura: System.String + Packages : seq OutputFile: System.String CommandLine: seq ExposeReturnCode: bool diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md index 68f59fa7f..c0d73a077 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md @@ -54,6 +54,22 @@ This holds the strongly-typed equivalent of the command line options member AsStrings : unit -> seq end ``` +### Cobertura package roots +``` + [] + type Package = + | Package of System.String + with + member AsString : unit -> System.String + end + [] + type Packages = + | Packages of seq + | NoPackage + with + member AsStrings : unit -> seq + end +``` ### Coverage thresholds ``` [] @@ -193,6 +209,7 @@ The members correspond to the like-named command line options for `AltCover Runn LcovReport: FilePath Threshold: Threshold Cobertura: FilePath + Packages : Packages OutputFile: FilePath CommandLine: CommandLine ExposeReturnCode: Flag diff --git a/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand-apidoc.md index 90089bfa6..0ed8dfe7f 100644 --- a/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand-apidoc.md +++ b/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand-apidoc.md @@ -21,6 +21,7 @@ public class ConvertToCoberturaCommand : PSCmdlet | [ConvertToCoberturaCommand](ConvertToCoberturaCommand/ConvertToCoberturaCommand-apidoc)() | The default constructor. | | [InputFile](ConvertToCoberturaCommand/InputFile-apidoc) { get; set; } | Input as file path | | [OutputFile](ConvertToCoberturaCommand/OutputFile-apidoc) { get; set; } | Output as file path | +| [Package](ConvertToCoberturaCommand/Package-apidoc) { get; set; } | Package source roots | | [XDocument](ConvertToCoberturaCommand/XDocument-apidoc) { get; set; } | Input as `XDocument` value | | override [ProcessRecord](ConvertToCoberturaCommand/ProcessRecord-apidoc)() | Create transformed document | diff --git a/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand/Package-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand/Package-apidoc.md new file mode 100644 index 000000000..6b3645682 --- /dev/null +++ b/docs/AltCover.PowerShell/AltCover.Commands/ConvertToCoberturaCommand/Package-apidoc.md @@ -0,0 +1,14 @@ +# ConvertToCoberturaCommand.Package property + +Package source roots + +```csharp +public string[] Package { get; set; } +``` + +## See Also + +* class [ConvertToCoberturaCommand](../ConvertToCoberturaCommand-apidoc) +* namespace [AltCover.Commands](../../AltCover.PowerShell-apidoc) + + diff --git a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md index fdc0714e0..1e1fc1a85 100644 --- a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md +++ b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md @@ -49,6 +49,7 @@ public class InvokeAltCoverCommand : PSCmdlet | [MethodTopLevel](InvokeAltCoverCommand/MethodTopLevel-apidoc) { get; set; } | Names to mark a function as "top level" | | [OutputDirectory](InvokeAltCoverCommand/OutputDirectory-apidoc) { get; set; } | Folder or folders to receive the instrumented assemblies and their companions (default: sub-folder `__Instrumented` of the current directory; or `__Saved` if `-Inplace` is set). | | [OutputFile](InvokeAltCoverCommand/OutputFile-apidoc) { get; set; } | Write the recorded coverage to this file rather than overwriting the original report file. | +| [Package](InvokeAltCoverCommand/Package-apidoc) { get; set; } | Package roots for cobertura reports | | [PathFilter](InvokeAltCoverCommand/PathFilter-apidoc) { get; set; } | Source file paths to exclude from instrumentation | | [Portable](InvokeAltCoverCommand/Portable-apidoc) { get; set; } | Portable operation - coverage report, control file and recorded data co-located with the recorder assembly | | [RecorderDirectory](InvokeAltCoverCommand/RecorderDirectory-apidoc) { get; set; } | The folder containing the instrumented code to monitor (including the `AltCover.Recorder.g.dll` generated by previous a use of the .net core `AltCover`). | diff --git a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Package-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Package-apidoc.md new file mode 100644 index 000000000..fd564e98a --- /dev/null +++ b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Package-apidoc.md @@ -0,0 +1,14 @@ +# InvokeAltCoverCommand.Package property + +Package roots for cobertura reports + +```csharp +public string[] Package { get; set; } +``` + +## See Also + +* class [InvokeAltCoverCommand](../InvokeAltCoverCommand-apidoc) +* namespace [AltCover.Commands](../../AltCover.PowerShell-apidoc) + + diff --git a/docs/AltCover.Toolkit/AltCover/CoverageFormats/ConvertToCobertura-apidoc.md b/docs/AltCover.Toolkit/AltCover/CoverageFormats/ConvertToCobertura-apidoc.md index 6dbaefef4..1e22887d4 100644 --- a/docs/AltCover.Toolkit/AltCover/CoverageFormats/ConvertToCobertura-apidoc.md +++ b/docs/AltCover.Toolkit/AltCover/CoverageFormats/ConvertToCobertura-apidoc.md @@ -7,12 +7,13 @@ Takes either OpenCover or classic NCover format input as an `XDocument`, as an a Writes the Cobertura report to the object pipeline as an `XDocument`, and optionally to a file. ```csharp -public static XDocument ConvertToCobertura(XDocument document) +public static XDocument ConvertToCobertura(XDocument document, IEnumerable packages) ``` | parameter | description | | --- | --- | | document | The report to convert. | +| packages | Possibly empty list of package root folders. | ## Return Value diff --git a/docs/AltCover.Toolkit/CoverageFormats-fsapidoc.md b/docs/AltCover.Toolkit/CoverageFormats-fsapidoc.md index ebaed643c..55929b4c2 100644 --- a/docs/AltCover.Toolkit/CoverageFormats-fsapidoc.md +++ b/docs/AltCover.Toolkit/CoverageFormats-fsapidoc.md @@ -13,7 +13,7 @@ namespace AltCover document:System.Xml.Linq.XDocument -> stream:System.IO.Stream -> unit val ConvertToCobertura : - document:System.Xml.Linq.XDocument -> System.Xml.Linq.XDocument + document:System.Xml.Linq.XDocument -> packages : string seq -> System.Xml.Linq.XDocument val ConvertToJson : document:System.Xml.Linq.XDocument -> string diff --git a/docs/PowerShell-integration.md b/docs/PowerShell-integration.md index c0cebce57..ff24e5f79 100644 --- a/docs/PowerShell-integration.md +++ b/docs/PowerShell-integration.md @@ -567,9 +567,9 @@ Creates a Cobertura format report from other report formats. SYNTAX ``` -ConvertTo-Cobertura [-XDocument] [[-OutputFile] ] [] +ConvertTo-Cobertura [-XDocument] [[-OutputFile] ] [[-Package] ] [] -ConvertTo-Cobertura [-InputFile] [[-OutputFile] ] [] +ConvertTo-Cobertura [-InputFile] [[-OutputFile] ] [[-Package] ] [] ``` @@ -615,6 +615,17 @@ Accept pipeline input? false Accept wildcard characters? false ``` +#### `-Package ` +Output as file path + +``` +Required? false +Position? 2 +Default value +Accept pipeline input? false +Accept wildcard characters? false +``` + #### `` This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, @@ -1114,9 +1125,9 @@ SYNTAX ``` Invoke-AltCover [-Runner] -RecorderDirectory [-Cobertura ] [-CommandLine ] [-DropReturnCode ] [-Executable ] [-LcovReport -] [-OutputFile ] [-SummaryFormat {Default | N | O | C | R | B | RPlus | BPlus}] -[-Threshold ] [-Verbosity {Off | Error | Warning | Info | Verbose}] [-WorkingDirectory -] [] +] [-OutputFile ] [-Package ] [-SummaryFormat {Default | N | O | C | R | B +| RPlus | BPlus}] [-Threshold ] [-Verbosity {Off | Error | Warning | Info | Verbose}] +[-WorkingDirectory ] [] Invoke-AltCover [-AssemblyExcludeFilter ] [-AssemblyFilter ] [-AttributeFilter ] [-AttributeTopLevel ] [-BranchCover ] [-CallContext @@ -1239,6 +1250,17 @@ Accept pipeline input? false Accept wildcard characters? false ``` +#### `-Package ` +Package roots for cobertura reports + +``` +Required? false +Position? named +Default value +Accept pipeline input? false +Accept wildcard characters? false +``` + #### `-OutputFile ` Write the recorded coverage to this file rather than overwriting the original report file. diff --git a/docs/Usage.md b/docs/Usage.md index a8f182b7d..b5750cb3e 100644 --- a/docs/Usage.md +++ b/docs/Usage.md @@ -10,7 +10,7 @@ The full command line is ``` AltCover [/i[nputDirectory]=VALUE] [/o[utputDirectory]=VALUE] [/y|symbolDirectory=VALUE] [/d[ependency]=VALUE] [/k[ey]=VALUE] [/sn|strongNameKey=VALUE] [/r[eport]=VALUE] [/f[ileFilter]=VALUE] [/p[athFilter]=VALUE] [/s|assemblyFilter=VALUE] [/e|assemblyExcludeFilter=VALUE] [/t[ypeFilter]=VALUE] [/m[ethodFilter]=VALUE] [/a[ttributeFilter]=VALUE] [/attributetoplevel=VALUE] [/typetoplevel=VALUE] [/methodtoplevel=VALUE] [--l[ocalSource]] [/c[allContext]=VALUE] [/reportFormat=VALUE] [--inplace] [--save] [--zipfile] [--methodpoint] [--single] [--linecover] [--branchcover] [--dropReturnCode] [--sourcelink] [--defer] [--v[isibleBranches]] [/showstatic[=VALUE]] [--showGenerated] [--trivia] [--portable] [-q] [--verbose] [--?|help|h] [-- ] [...] or -AltCover Runner [/r[ecorderDirectory]=VALUE] [/w[orkingDirectory]=VALUE] [/x|executable=VALUE] [--collect] [/l[covReport]=VALUE] [/t[hreshold]=VALUE] [/c[obertura]=VALUE] [/o[utputFile]=VALUE] [--dropReturnCode] [/summary|teamcity[=VALUE]] [-q] [--verbose] [--?|help|h] [-- ] [...] +AltCover Runner [/r[ecorderDirectory]=VALUE] [/w[orkingDirectory]=VALUE] [/x|executable=VALUE] [--collect] [/l[covReport]=VALUE] [/t[hreshold]=VALUE] [/c[obertura]=VALUE] [/p[ackage]=VALUE] [/o[utputFile]=VALUE] [--dropReturnCode] [/summary|teamcity[=VALUE]] [-q] [--verbose] [--?|help|h] [-- ] [...] or AltCover ImportModule or @@ -181,6 +181,8 @@ or such methods. -c, --cobertura=VALUE Optional: File for Cobertura format version of the collected data + -p, --package=VALUE Optional, multiple: package root path for + Cobertura reports -o, --outputFile=VALUE Optional: write the recorded coverage to this file rather than overwriting the original report file. --dropReturnCode Optional: Do not report any non-zero return code diff --git a/docs/`dotnet-test`-integration.md b/docs/`dotnet-test`-integration.md index a0718636f..844d93f31 100644 --- a/docs/`dotnet-test`-integration.md +++ b/docs/`dotnet-test`-integration.md @@ -54,6 +54,7 @@ And if you want more control over what happens to the files, then is is still po * `/p:AltCoverCobertura=`"path to cobertura format result" * `/p:AltCoverThreshold=`"coverage threshold required" * `/p:AltCoverSummaryFormat=[BROCN+]` one or more of TeamCity Block format/TeamCity bRanch format/Classic OpenCover/CRAP score or none at all; `+` means the same as `OC` which is also the default +* `/p:AltCoverPackages=`"pipe `'|'` separated list of source root paths" * `/p:AltCoverVerbosity=`"Levels of output -- Verbose, Info (default), Warning, Error, or Off" * `/p:AltCoverShowSummary=true|[ConsoleColor]` to echo the coverage summary to stdout (in the colour of choice, modulo what else your build process might be doing) if the string is a valid ConsoleColor name) N.B. if this option is present, with any non-empty value then the summary will be echoed * `/p:AltCoverForce=true|false` to force delete any left-over `__Instrumented*` (or `__Saved*`, if `InPlace` is set) folders from previous runs