FAKE - F# Make
Fake Namespace
| Type | Description |
| Checksum | Allow to calculate checksum |
| ChecksumHashAlgorithm |
| Module | Description |
| AdditionalSyntax | Provides functions and operators to deal with FAKE targets and target dependencies. |
| AndroidPublisher | |
| AppVeyor | Contains code to configure FAKE for AppVeyor integration |
| Appcast | Contains code to configure FAKE for Appcast handling |
| ArchiveHelper | Provides utility tasks for storing and compressing files in archives. |
| AssemblyInfoFile | Contains tasks to generate AssemblyInfo files for C# and F#. There is also a tutorial about the AssemblyInfo tasks available. |
| AssemblyInfoHelper | Generates an AssemblyInfo file |
| AzureHelper | Contains tasks to control the local Azure Emulator |
| BitbucketPipelines | Contains code to configure FAKE for Bitbucket Pipelines integration |
| Boot | Implements support for boostrapping FAKE scripts. A bootstrapping
|
| BowerHelper | Contains function to run bower tasks |
| BuildServerHelper | Contains functions which allow build scripts to interact with a build server. |
| CacheHelper | Contains functions which allows to deal with a cache. |
| ChangeLogHelper | Contains helpers which allow to parse Change log text files. These files have to be in a format as described on http://keepachangelog.com/en/0.3.0/ |
| ChangeWatcher | This module contains helpers to react to file system events. |
| Choco | Contains tasks which allow to call Chocolatey |
| ConfigurationHelper | Contains functions which allow to read and write config files. |
| CscHelper | Contains tasks to compile C# source files with CSC.EXE (C# Compiler). |
| DocFxHelper | Contains helper functions to run the documentation tool "docfx". |
| DocuHelper | Contains helper functions to run the XML documentation tool "docu". |
| DotCover | Contains a task which can be used to run DotCover on .NET assemblies. |
| DotNetCli | Contains a task which can be used to run dotnet CLI commands. |
| DynamicsCRMHelper | Contains various functions for interacting with Dynamics CRM. So far there is support for exporting and importing solutions, zipping and unzipping using the Solution Packager, as well as publishing customizations. |
| DynamicsNav | Contains helper function which allow to interact with Microsoft Dynamics NAV. |
| DynamicsNavFile | Provides an abstraction over Dynamics NAV object files. |
| EnvironmentHelper | This module contains functions which allow to read and write environment variables and build parameters |
| FSIHelper | Contains helper functions which allow to interact with the F# Interactive. |
| FSharpFormatting | Contains tasks which allow to run FSharp.Formatting for generating documentation. |
| FileHelper | Contains helper function which allow to deal with files and directories. |
| FileSystem | This module contains a file pattern globbing implementation. |
| FileSystemHelper | Contains helpers which allow to interact with the file system. |
| FileUtils | Shell-like functions. Similar to Ruby's FileUtils. |
| FixieHelper | Contains tasks to run Fixie unit tests. |
| FscHelper | Contains tasks to compiles F# source file with the FSharp.Compiler.Service. There is also a tutorial about the F# compiler tasks available. |
| FtpHelper | Contains helpers which allow to upload a whole folder/specific file into a FTP Server.
Uses |
| FuchuHelper | |
| FxCopHelper | Contains a task which can be used to run FxCop on .NET assemblies. There is also a tutorial for this task available. |
| GACHelper | This module contains helper function for the GAC |
| GitVersionHelper | Containts helper function for GitVersion - a tool to help you achieve Semantic Versioning on your project. To install GitVersion.exe on Windows, start PowerShell as Administrator and run choco install gitversion.portable -s https://chocolatey.org/api/v2" For Mac and Unix, install the NuGet version. |
| Globbing | This module contains a file pattern globbing implementation. |
| HTMLHelpWorkShopHelper | Contains a task which allows to use HTML Help Workshop in order to compile a help project. |
| HipChatNotificationHelper | Contains a task to send notification messages to a HipChat room |
| HockeyAppHelper | Contains tasks to interact with HockeyApp |
| ILMergeHelper | Contains task a task which allows to merge .NET assemblies with ILMerge. |
| MSBuildHelper | Contains tasks which allow to use MSBuild (or xBuild on Linux/Unix) to build .NET project files or solution files. |
| MSIHelper | Contains tasks which allow to run msiexec in order to install or uninstall msi files. |
| MSTest | Contains tasks to run MSTest unit tests. |
| MSpecHelper | Contains a task to run machine.specifications tests. |
| MageHelper | Contains helper functions which allow FAKE to call the Manifest Generation and Editing Tool, in short 'MAGE'. The intentional use is the creation of a clickonce application. |
| MessageHelper | Contains helper function which allow FAKE to interact with other applications via message files. |
| MsBuildLogger | Contains Logger implementations for MsBuild. |
| NCoverHelper | Contains a task which can be used to run NCover on .NET assemblies. |
| NDepend | Contains a task which allows to run NDepend on .NET project files. |
| NGenHelper | This module contains helper function for the ngen.exe |
| NUnitCommon | Contains types and utility functions relaited to running NUnit unit tests. |
| NUnitParallel | Contains tasks to run NUnit unit tests in parallel. |
| NUnitSequential | Contains tasks to run NUnit unit tests. |
| NUnitXml | Contains types and functions for working with NUnit unit tests result xml. |
| NpmHelper | Contains function to run npm tasks |
| NuGetHelper | Contains helper functions and task which allow to inspect, create and publish NuGet packages. There is also a tutorial about nuget package creating available. |
| NuGetVersion | |
| OctoTools | Contains tasks which can be used for automated deployment via Octopus Deploy. There is also a tutorial about the Octopus deployment helper available. |
| Office365ConnectorHelper | Contains a task to send notification messages to a Office 356 Connector webhook |
| OpenCoverHelper | Contains a task which can be used to run OpenCover on .NET assemblies. |
| Paket | Contains helper functions and task which allow to inspect, create and publish NuGet packages with Paket. |
| PaketTemplate | Contains helper functions and task which allow it to generate a paket.template file for Paket |
| PermissionsHelper | Contains functions which allow to deal with permissions. |
| PicklesHelper | Contains tasks to run the Pickles living documentation generator |
| ProcessHelper | Contains functions which can be used to start other tools. |
| ProcessTestRunner | Allows to execute processes as unit tests. |
| PsExecHelper | Contains functions for working with Sysinternals PsExec |
| REST | Contains functions to execute typical HTTP/REST calls. |
| RaygunHelper | Enables deployment tracking using Raygun.io Thin wrapper around the Raygun HTTP deployment API |
| RegAsmHelper | Contains a task which can be used to run regasm .NET assembly |
| RegistryHelper | Contains functions which allow to read and write information from/to the registry. |
| ReleaseNotesHelper | Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted. |
| ReportGeneratorHelper | Contains a task which can be used to run ReportGenerator, which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats. |
| RestorePackageHelper | Contains tasks which allow to restore NuGet packages from a NuGet package feed like nuget.org. There is also a tutorial about nuget package restore available. |
| RoboCopyHelper | Contains a task to use robocopy on Windows. |
| RoundhouseHelper | Contains tasks to run RoundhousE database migrations. |
| SCPHelper | Conatins a task which allows to perform file copies using SCP, which is based on the Secure Shell (SSH) protocol. |
| SSHHelper | Conatins a task which allows to perform SSH operations |
| SemVerHelper | Contains helpers which allow to deal with Semantic Versioning (SemVer). |
| ServiceControllerHelpers | Contains tasks which allow to control NT services. |
| SignToolHelper | Contains a task to sign assemblies using the SignTool. |
| SlackNotificationHelper | Contains a task to send notification messages to a Slack webhook |
| SonarQubeHelper | Contains a task to run the msbuild runner of Sonar Qube analyzer. |
| SpecFlowHelper | Contains a task which allows to run SpecFlow tests. |
| Squirrel | Contains types and utility functions related to creating Squirrel installer. |
| StringHelper | Contains basic functions for string manipulation. |
| StrongNamingHelper | This module contains helper function for Microsoft's sn.exe |
| StyleCopHelper | |
| SxsHelper | Module that enables creating and embedding Side-by-Side interop manifests for registration free deployment of Com-.net interop projects |
| TargetHelper | Contains infrastructure code and helper functions for FAKE's target feature. |
| TaskRunnerHelper | Contains a helper which can be used to implement timeouts and retries. |
| TeamCityHelper | Contains helper functions which allow FAKE to communicate with a TeamCity agent |
| TeamCityRESTHelper | Contains functions which allow FAKE to interact with the TeamCity REST API. |
| TemplateHelper | Contains basic templating functions. Used in other helpers. |
| TestFlightHelper | Contains tasks to upload apps to TestFlight |
| TraceHelper | This module contains function which allow to trace build output |
| TraceListener | Defines default listeners for build output traces |
| TypeScript | Contains code to call the typescript compiler. There is also a tutorial for this task available. |
| UnitTestCommon | This module contains types and functions that are common for unit test helpers. |
| UnitTestHelper | This module contains functions which allow to report unit test results to build servers. |
| UserInputHelper | This module contains functions which allow to interactively input values |
| VSSHelper | Contains helper functions for Microsoft Visual SourceSafe |
| VSTest | Contains tasks to run VSTest unit tests. |
| Vb6Helper | Enables building of Visual Basic 6 projects Also includes a do-it-all function that will embed interop side-by-side manifest to executables from Vb6 using functions from the Side-by-side helper module |
| VersionHelper | |
| WiXHelper | Contains tasks to create msi installers using the WiX toolset |
| XCopyHelper | Contains a task to use XCOPY on Windows. |
| XDTHelper | Contains functions used to transform config (or any XML) files using Microsoft's XML Document Transformations. |
| XMLHelper | Contains functions to read and write XML files. |
| XUnit2Helper | DEPRECATED. See Contains tasks to run xUnit unit tests. |
| XUnitHelper | DEPRECATED. See Contains tasks to run xUnit unit tests. |
| XamarinHelper | Contains tasks for building Xamarin.iOS and Xamarin.Android apps |
| XpkgHelper | Contains tasks to create packages in Xamarin's xpkg format |
| YarnHelper | Contains function to run yarn tasks |
| ZipHelper | This module contains helper function to create and extract zip archives. |
Fake.Azure Namespace
| Module | Description |
| CloudServices | Contains tasks to package Azure Cloud Services. |
| Kudu | Contains tasks to stage and deploy Azure website and webjobs using source code deployment with Kudu Sync. |
| WebJobs | Contains tasks to package and deploy Azure Web Jobs via the Kudu Zip controller |
Fake.CMakeSupport Namespace
| Type | Description |
| CMakeBuildParams | The CMakeBuild parameter type. |
| CMakeGenerateParams | The CMakeGenerate parameter type. |
| CMakeValue | The possible variable value types for CMake variables. |
| CMakeVariable | A CMake variable. |
| Module | Description |
| CMake | Contains tasks which allow to use CMake to build CMakeLists files.
See |
Fake.Git Namespace
| Module | Description |
| Branches | Contains helper functions which allow to deal with git branches. |
| CommandHelper | Contains helpers which allow to interact with git via the command line. |
| Commit | Contains helper functions which allow to commit to git repositories. |
| CommitMessage | Contains helper functions which allow to get and set the git commit message. |
| FileStatus | Contains helper functions which can be used to retrieve file status information from git. |
| Information | Contains helper functions which can be used to retrieve status information from git. |
| Merge | Contains helper functions which allow to deal with git merge. |
| Rebase | Contains helper functions which allow to deal with git rebase. |
| Repository | Contains functions which allow basic operations on git repositories. All operations assume that the CommandHelper can find git.exe. |
| Reset | Contains helper functions which allow to deal with git reset. |
| SHA1 | Contains functions which allow the SHA1 of a file with git and without it. |
| SanityChecks | Contains helper function which can be used for sanity checks. |
| Staging | Contains helper functions which allow to deal with git's staging area. |
| Stash | Contains helper functions which allow to deal with git stash. |
| Submodule | Contains helper functions which allow to deal with git submodules. |
Fake.MSBuild Namespace
| Module | Description |
| ProjectSystem | Contains project file comparison tools for MSBuild project files. |
| SpecsRemovement | Contains functions which allow to remove side-by-side specs during the build. |
Fake.NuGet Namespace
| Module | Description |
| Install | Contains tasks for installing NuGet packages using the nuget.exe install command. |
| Update | Contains tasks for updating NuGet packages including assembly hint paths in the project files using the nuget.exe update command. |
Fake.Sql Namespace
| Module | Description |
| DacPac | Contains helpers around deploying databases. |
Fake.Testing Namespace
| Module | Description |
| Expecto | Contains tasks to run expecto v2 unit tests. |
| NUnit3 | |
| XUnit | Contains tasks to run xUnit v1 unit tests. |
| XUnit2 | Contains tasks to run xUnit v2 unit tests. |
Test.FAKECore Namespace
| Type | Description |
| FSharpFuncUtil |
Yaaf.FSharp.Scripting Namespace
| Type | Description |
| OutputData |
| Module | Description |
| Log |