Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 4.27 KB

README.md

File metadata and controls

76 lines (54 loc) · 4.27 KB
Raw

F# |> BABEL

The compiler that emits JavaScript you can be proud of!

Mono Build Status .NET Build Status

Fable brings together the power of the F# compiler and Babel to make JavaScript a true backend for F#. Some of its main features are:

  • Works directly on F# source code, no compilation to .NET bytecode needed
  • Optimizes F# code to generate as clean JavaScript as possible
  • Passes location data to Babel to generate source maps
  • Compatible with all Babel plugins and other JS development tools, like Webpack
  • Support for most of the F# core library and a bit of .NET Base Class Library
  • Tiny core library included (less than 10KB minified and gzipped) with no runtime
  • Organizes code using ES6 modules
  • Interacts seamlessly with other JavaScript libraries
  • Bonus: compile NUnit tests to Mocha

Usage

A beta version has been released to npm! You can install and run it just by typing:

npm install -g fable-compiler
fable path/to/your/project.fsproj

Note the package name is fable-compiler while the command is just fable

You must have F# 4.4 and node 4.4 or bigger installed in your computer.

You can find more detailed instruction about F# to JS compilation in the docs. Also you can have a look at the samples or download them from here.

Contributing

At the moment, the best way to contribute is to battle-test the project, report issues, create samples and help promoting it. A plugin system is also available to allow you extend Fable according to you needs.

Issues with the label discussion will be also added to ask the opinion of the community on different topics like the logo, roadmap, etc.

Caveats

  • Options are erased in compiled code. This has several benefits like removing overhead and interacting with native JS functions in a safer way (null will be None). However, it will lead to unexpected results if you do weird things like wrapping null in Some. For practical purposes, Fable considers null, undefined, None and unit to be the same thing.

  • Information about generic types is not included in the generated JavaScript, so code that depends on this information to be known at runtime for method dispatching may have unexpected behaviour.

  • Debugging the F# code is not perfect. For example, you may see the debugger jump directly to the last expression in many functions. This is normal and due to the optimizations performed on the generated JS code.

To know more, read Compatibility.

Acknowledgements

Of course, this project wouldn't have been possible without the fantastic work of the F# compiler and Babel teams. I hope they feel proud seeing how their work has met in a very unexpected way, giving developers even more possibilities to build great apps.

The awesome F# community has played a big role in making this possible. I've met incredible people and it's impossible to list all the names without forgetting anyone, but I'd like to give a particular mention to Zach Bray for his work on FunScript, Don Syme (the fact that the designer of the language himself shows interest in your work, no matter how humble it is, is really a big push!) and Krzysztof Cieślak (I always have to look up the name to spell it correctly) because he's shown that F# is a perfect fit for a big project targeting JS.

And finally I'd like to thank my partner (is it too old-fashioned to say wife?) for bearing with me everyday.