Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 4.36 KB

README.md

File metadata and controls

91 lines (68 loc) · 4.36 KB

Logo

Fesh

Fesh on nuget.org Build Standalone Build Hosting code size license

Fesh is an F# Editor & Scripting Host.
On Windows.

It is designed for embedding F# as application scripting tool.
But it works standalone just as well.

Screenshot

It is based on the excellent AvalonEdit, that is why it only works on Windows (for now).
The editor supports F# 8.0 and has modern IDE features like semantic syntax highlighting, type-info and autocomplete.
Unlike a typical F# REPL this editor has the input and the output in two separate windows.
Just like Don Syme always wanted it.
You can even color the output with Fescher.

Contrary to most F# editors, it uses FSharp.Compiler.Service in the same process as the UI.
There is no separate language server or FSI process.
Therefore, Fesh can easily be hosted in other apps to create an embedded application scripting tool.
This was in fact the primary motivation for creating Fesh.
It is public since 2024.
But I started prototyping it in 2017. I used it for scripting in Rhino3D professionally since 2019.
Initially I used the Tsunami F# editor, like seen in my talk on the Louvre Abu Dhabi Dome.
But it is no longer available. So I created Fesh.

For hosting there is the nuget package Fesh. See hosting examples Fesh.Rhino and Fesh.Revit.

How to install

Standalone

Build from the source with

dotnet build FeshStandalone.fsproj

or download the from Releases to any location, unblock and run Fesh.exe.

For hosting in another app

use the nuget package Fesh.
Or, to build the Fesh nuget package run:

dotnet build FeshHosting.fsproj

Features

Syntax Highlighting

Initial static syntax highlighting is done via AvalonEdit's regex based highlighting.
See SyntaxHighlightingFSharp.xshd.
The F# Compiler Service provides additional semantic highlighting.
If you want different colors go the menu: About -> Open and watch SyntaxHighlighting in VS Code.
You wil see any changes upon every save in VS Code.

Auto complete

Auto complete works on enter and dot, also when typing in the middle of a word.

Type info

The type info includes the inferred signature.
All of the xml docs and information about the path of the containing assembly.

Status bar

The statusbar at the bottom shows compiler error count, click on it to scroll to the first error.

Selection highlighting

Selected text is highlighted in both code and output window. The count is shown in the status bar.

Drag and drop

Drag any file or folder into the editor to get the full path as a string at the cursor position.
For *.dlls it will be at the top and prefixed with #r.
For *.fsx it will be at the top and prefixed with #load.

Font

The default font is Cascadia Mono.
Besides italic it also supports a cursive script mode. Fesh is using cursive for comments.
To enable ligatures set the font to Cascadia Code.
You can change the font in the 'Settings.txt' file at %APPDATA%\Local\Fesh\Settings.txt.
Or via the menu: About -> Open Settings Folder.

Changelog

see CHANGELOG.md