F# Template for create and publishing Fable Libraries
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.paket
Content
.editorconfig
.gitattributes
.gitignore
.travis.yml
Fable.Template.Library.csproj
LICENSE.md
README.md
RELEASE_NOTES.md
appveyor.yml
build.cmd
build.fsx
build.sh
paket.dependencies
paket.lock

README.md

Fable.Template.Library

F# Template for create and publishing Fable Libraries

Getting started

Grab the template from nuget:

dotnet new -i "Fable.Template.Library::*"

Use the new template:

dotnet new fable-library -n CoolFableLibrary
cd CoolFableLibrary
./build.sh

Builds

MacOS/Linux Windows
Travis Badge Build status
Build History Build History

Nuget

Stable Prerelease
NuGet Badge NuGet Badge

Building

Make sure the following requirements are installed in your system:

Then you just need to type ./build.cmd or ./build.sh

A note about Fable Libraries vs Fable Bindings

There are two kinds of Fable packages:

  • JS Bindings: These don't contain any actual code, only signatures and attributes normally generated by ts2fable. They're just used to provide a type-safe to interact with a JS library from Fable.
  • Libraries: These contain F# code that will be compiled to JS by Fable when being referenced by a consumer project.

The distinction is important because Fable can read metadata from .dll assemblies (like signatures and attributes) but not executable code, for that it needs the F# sources. For JS bindings without actual code you don't need to worry as they can be distributed as any other Nuget package. However, Fable libraries need a couple of extra steps:

  • First, the package must contain a folder named fable with the F# sources (and if necessary other files like JS scripts).
  • The fable folder must contain an .fsproj file with the same name as the Nuget package.

This is not difficult to do and usually only requires adding a tag to your project file (example), but you need to make sure all the sources get into the package with the proper directory structure. Also, take into account Fable will just make a simple XML parsing to extract the source files from the .fsproj, so you should avoid MSBuild conditionals, etc.

Because Fable will compile your sources you must be careful with compiler directives too (like #if MY_SYMBOL, etc). Though you can use this to your advantage and do some logging in debug mode (#if DEBUG). And remember also that Fable will always define the FABLE_COMPILER symbol when compiling to JS.