RELEASE NOTES · Follow us on Twitter!
Fable is an F# to JavaScript compiler powered by Babel, designed to produce readable and standard code. Check the website for more information and if you find the project useful, don't forget to give us a star!
Check this document.
Make sure the following requirements are installed in your system:
- dotnet SDK 2.0 or higher
- node.js 6.11 or higher
- yarn
- Mono if you're on Linux or macOS.
Then you just need to type ./build.cmd
or ./build.sh
depending on your system to build a local copy of Fable and run the test suite. After that, if you want to quickly try changes to Fable source, please check src/tools/QuickTest.fs
.
Many of you are making really useful contributions that you also need for your own projects, however a new release may take several days. If you need the latest features you can tell fable-compiler
to use a local build. For this, use the cli.path
option. For example when using the fable-loader
you can include the following in your webpack.config.js:
module: {
rules: [
{
test: /\.fs(x|proj)?$/,
use: {
loader: "fable-loader",
options: {
cli: {
// This should be the path to your local clone of Fable
path: "../Fable/src/dotnet/Fable.Compiler"
}
}
}
}
]
}
ATTENTION: Remember to build fable-library files beforehand. This can be done just by building the whole project (see "Building" above) or running the FableLibrary
FAKE target (after this, if you edit one of the src/js/fable-library JS or TS files, you can run the FableLibraryTypescriptOnly
which is faster).
Just by using Fable you're already contributing! You can help a lot the community by sharing examples and experiences in your personal blog and sending a PR to fable-awesome.
Send bug reports (ideally with minimal code to reproduce the problem) and feature requests to the GitHub repository. Issues with the label discussion
will be also added to ask the opinion of the community on different topics like roadmap, etc. For more immediate comments you can use the Gitter chat.
If you are up to contribute a fix or a feature yourself, you're more than welcome! Please send first an issue or a minimal Work In Progess PR so we can discuss the implementation details in advance. We're planning to add documentation for developers directly in the code, either as README files in each directory or as comments in the source. This is currently an ongoing effort.