Integrating Fable Into Legacy Project
Let's say you have an older website but want to integrate Fable into that website. Most javascript tutorials seem to be under the impression you would like to do greenfield or SPA type applications. Also it may be the case that terminology across these languages is becoming difficult to map to and from.
In our scenario here, we have a multipage application that has the notion of a javascript file per page. Something like:
tree
.
├── pages
│ ├── feature1
│ │ ├── details.cshtml
│ │ └── list.cshtml
│ └── feature2
│ ├── dashboard.cshtml
│ └── ticker.cshtml
└── scripts
├── feature1
│ ├── details.js
│ └── list.js
├── feature2
│ ├── dashboard.js
│ └── ticker.js
└── someGlobalFileBecauseLegacy.js
What we want to do is start migrating those javascript files to F# Fable but not have to retool our entire stack. To do this we'll need a combo of different techniques.
We'll need to use webpack because bundling is a good idea. Webpack doesn't know anything about Fable but, it allows people a way to teach webpack about how to process files called loaders The problem is that fable-loader expects a single entrypoint. Now what exactly is an entrypoint? In a single page application it's basically the file with the notion of a main function. In our case it will be every single page. And to achieve our goal of 1 javascript file per page, we'd need to create an fsproj per page. Seems overkill. Well theres another way to go about it. You can "prime" fable's compiler server with the fsproj then selectively compile them! We'll see how to do that in a bit.
Let's quickly look at the project structure for this
.
├── FableTestSplitter.fsproj
├── Main.fs
├── scripts
│ ├── feature1
│ │ └── list.fs
│ └── feature2
│ └── dashboard.fs
├── SomeSharedCode.fs
└── paket.references
This mimics the first couple files we want to replace in our legacy app.
Now let's run webpack. To get started we'll need to use the fable dotnet tool and we'll need to run it from the directory with our fsproj file. cd src && dotnet restore then dotnet fable npm-run webpack.
The output...
Bundling for development...
Parsing ./FableTestSplitter.fsproj...
fable: Compiled src/scripts/feature1/list.fs
fable: Compiled src/scripts/feature2/dashboard.fs
fable: Compiled src/SomeSharedCode.fs
fable: Compiled ../../../.nuget/packages/fable.elmish.react/1.0.1/fable/react.fs
fable: Compiled ../../../.nuget/packages/fable.elmish/1.0.1/fable/program.fs
fable: Compiled ../../../.nuget/packages/fable.elmish.react/1.0.1/fable/common.fs
fable: Compiled ../../../.nuget/packages/fable.elmish/1.0.1/fable/cmd.fs
Hash: 41212c65ea894a9324fb
Version: webpack 3.10.0
Time: 5106ms
Asset Size Chunks Chunk Names
scripts/feature2/dashboard.bundle.js 6.13 kB 0 [emitted] scripts/feature2/dashboard
scripts/feature1/list.bundle.js 1.57 kB 1 [emitted] scripts/feature1/list
vendor.bundle.js 1.19 MB 2 [emitted] [big] vendor
scripts/feature2/dashboard.bundle.js.map 2.4 kB 0 [emitted] scripts/feature2/dashboard
scripts/feature1/list.bundle.js.map 1.16 kB 1 [emitted] scripts/feature1/list
vendor.bundle.js.map 1.33 MB 2 [emitted] vendor
And what the tree looks like:
../dist/
├── scripts
│ ├── feature1
│ │ ├── list.bundle.js
│ │ └── list.bundle.js.map
│ └── feature2
│ ├── dashboard.bundle.js
│ └── dashboard.bundle.js.map
├── vendor.bundle.js
└── vendor.bundle.js.map
So now we have javascript suitable to be used in the browser. Cool! So what magic did we use to achieve this output? In the webpack.config.js , we'll need to set multiple entry points dynamically by using the glob pattern matching:
var pageJs =
glob.sync("./src/scripts/**/*.fs")
.reduce(
(acc, fileToPack) => {
let outFile =
fileToPack
.split('scripts/')[1] //Get only the page specific files
.replace(/\.[^/.]+$/, "") //Remove the extension
acc["scripts/" + outFile] = fileToPack
return acc;
}, {})
This will basically create an object similar to:
{
"scripts/feature1/list" : "./src/scripts/feature1/list.fs",
"scripts/feature2/dashboard : "./src/scripts/feature2/dashboard.fs"
}
Then to tell webpack to output each entrypoint by name we have to use this [name].bundle.js template.
module.exports = {
entry: pageJs,
output: {
filename: '[name].bundle.js',
path: __dirname + '/dist'
}, ... rest of file
However if we don't "prime" the fable server with the fsproj first you get a message like "dashboard.fs doesn't belong to any of loaded projects". So to do that, we'll post the "path" of our fsproj to fable's server
let msg = {
path: resolve("./src/FableTestSplitter.fsproj")
}
let preppedFableWithProject = fableUtils.client.send(port, JSON.stringify(msg)).then(() => {
Webpack allows you to set the config as a promise so we're able to do this async call easily. There's also other properties we can set for this call to fable server but for now this gets the job done.
Then to pack up all the vendor stuff into a common library we'll use the CommonChunkPlugin
plugins: [
new webpack.optimize.CommonsChunkPlugin({
name: "vendor",
//https://jeremygayed.com/dynamic-vendor-bundling-in-webpack-528993e48aab
minChunks: ({
resource
}) => {
return /node_modules/.test(resource) //put into vendor chunk if node_modules
||
/.nuget/.test(resource);
}
})
],
This will pull all nuget and node_module depedencies into a vendor bundle so we only have to reference it once.
Now you can just copy these files into your old legacy output and reference them like you would normally!
Requirements
- dotnet SDK 2.0 or higher
- node.js 6.11 or higher
- A JS package manager: yarn or npm
npm comes bundled with node.js, but we recommend to use at least npm 5. If you have npm installed, you can upgrade it by running
npm install -g npm.
Although is not a Fable requirement, on macOS and Linux you'll need Mono for other F# tooling like Paket or editor support.
Editor
The project can be used by editors compatible with the new .fsproj format, like VS Code + Ionide, Emacs with fsharp-mode or Rider. Visual Studio for Mac is also compatible but in the current version the package auto-restore function conflicts with Paket so you need to disable it: Preferences > Nuget > General.
Installing the template
In a terminal, run dotnet new -i Fable.Template to install or update the template to the latest version.
Creating a new project with the template
In a terminal, run dotnet new fable to create a project in the current directory. Type dotnet new fable -n MyApp instead to create a subfolder named MyApp and put the new project there.
The project will have the name of the directory. You may get some issues if the directory name contains some special characters like hyphens
Building and running the app
In the commands below, yarn is the tool of choice. If you want to use npm, just replace
yarnbynpmin the commands.
- Install JS dependencies:
yarn install - Move to
srcfolder:cd src - Install F# dependencies:
dotnet restore - Start Fable daemon and Webpack dev server:
dotnet fable yarn-start - In your browser, open: http://localhost:8080/
dotnet fable yarn-start(ornpm-start) is used to start the Fable daemon and run a script in package.json concurrently. It's a shortcut ofyarn-run [SCRIPT_NAME], e.g.dotnet fable yarn-run start.
If you are using VS Code + Ionide, you can also use the key combination: Ctrl+Shift+B (Cmd+Shift+B on macOS) instead of typing the dotnet fable yarn-start command. This also has the advantage that Fable-specific errors will be highlighted in the editor along with other F# errors.
Any modification you do to the F# code will be reflected in the web page after saving. When you want to output the JS code to disk, run dotnet fable yarn-build and you'll get a minified JS bundle in the public folder.
JS Output
This template uses babel-preset-env to output JS code whose syntax is compatible with a wide range of browsers. Currently it's set to support browsers with at least 1% of market share. To change this (for example, if you don't need to support IE), replace this line with a query understood by browserl.ist.
To replace objects and APIs that may be missing in old browsers, the index.html file submits a request to cdn.polyfill.io that tailors the polyfill according to the user's browser.
Project structure
Paket
Paket is the package manager used for F# dependencies. It doesn't need a global installation, the binary is included in the .paket folder. Other Paket related files are:
- paket.dependencies: contains all the dependencies in the repository.
- paket.references: there should be one such a file next to each
.fsprojfile. - paket.lock: automatically generated, but should be committed to source control, see why.
- Nuget.Config: prevents conflicts with Paket in machines with some Nuget configuration.
Paket dependencies will be installed in the
packagesdirectory. See Paket website for more info.
yarn/npm
- package.json: contains the JS dependencies together with other info, like development scripts.
- yarn.lock: is the lock file created by yarn.
- package-lock.json: is the lock file understood by npm 5, if you use it instead of yarn.
JS dependencies will be installed in
node_modules. See yarn and/or npm websites for more info.
Webpack
Webpack is a bundler, which links different JS sources into a single file making deployment much easier. It also offers other features, like a static dev server that can automatically refresh the browser upon changes in your code or a minifier for production release. Fable interacts with Webpack through the fable-loader.
- webpack.config.js: is the configuration file for Webpack. It allows you to set many things: like the path of the bundle, the port for the development server or Babel options. See Webpack website for more info.
Make sure to resolve all the paths as well as Babel options to make sure all the files referenced by Fable will be found by Babel/Webpack.
F# source files
The template only contains two F# source files: the project (.fsproj) and a source file (.fs) in src folder.
Where to go from here
Check more Fable samples, use another template like Fable.Template.Elmish.React or SAFE.Template, and check the awesome-fable for a curated list of resources provided by the community.