FSharpPacker — Convert FSX files into standalone…

Pitch

Description

Comments

About this project

FSharpPacker is a powerful tool that transforms FSX files into self-contained executables, simplifying deployment and execution. With simple commands and support for various configurations, it offers a flexible solution for F# developers looking to package their applications easily.

FSharpPacker is a powerful and versatile tool designed for developers who work with FSX files. It enables the packaging of F# scripts into self-contained executable files, simplifying the distribution and execution of F# applications. Whether you're building applications for Windows or other platforms, FSharpPacker streamlines the process with a straightforward command-line interface.

Features

Self-Contained Executables: By default, FSharpPacker generates executables that include the .NET runtime, ensuring your application runs seamlessly on any machine without requiring a separate .NET installation.
Target Framework Specification: Choose the target framework for your executable using the --framework option, allowing for greater flexibility in your development process. Supported frameworks include popular versions like net6.0 and net7.0.
AOT Compilation: Enable Ahead-of-Time (AOT) compilation for improved startup performance and reduced execution time. Use the --aot flag to take advantage of this powerful feature.
Single File Output: FSharpPacker allows you to produce single-file executables with a simple command, optimizing your application's portability.

Usage Example

Command-line usage is intuitive, allowing you to quickly pack your FSX files. Here’s how you can convert your FSX script into an executable:

fspack fsx-file.fsx [<additional arguments to dotnet publish>]

Example Commands:

Basic Packaging:

fspack FSharpPacker.Tests\Samples\LoadFile.fsx -o test -r win-x64

AOT Build:

fspack FSharpPacker.Tests\Samples\LoadFile.fsx -aot -o test-aot -r win-x64 -f net7.0

Single-File Executable:

fspack FSharpPacker.Tests/Samples/LoadFile.fsx -o test-single-file -r win-x64 -f net7.0 -sf -p:EnableCompressionInSingleFile=true

Features Supported from FSX Directives

FSharpPacker supports a range of FSX directives for robust functionality:

Directive	Status	Notes
`#load`	:white_check_mark:
`#r "path\file.dll"`	:white_check_mark:
`#r "nuget: package"`	:white_check_mark:
`#r "nuget: package, version"`	:white_check_mark:
`#i "nuget: source-feed"`	:white_check_mark:
`#quit`	:white_check_mark:
`#r "custom: custom-path"`	:white_large_square:	Requires deep involvement with FSharp.Compiler.Services

Ignored FSX Directives

Directive
`#help`
`#time`

Documentation and Additional Resources

For more details on FSharpPacker, including installation instructions and advanced usage, please refer to the official Nix documentation or run the help command:

fspack --help

FSharpPacker encourages efficient packaging of your F# scripts into executable files, making it an essential tool for F# developers looking to enhance their workflow.