Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dlesbre/vossii-fl

fl support for visual studio code
https://github.com/dlesbre/vossii-fl

extension visual-studio-code voss

Last synced: about 2 months ago
JSON representation

fl support for visual studio code

Host: GitHub
URL: https://github.com/dlesbre/vossii-fl
Owner: dlesbre
License: apache-2.0
Created: 2021-04-21T11:09:00.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-05-22T12:40:46.000Z (7 months ago)
Last Synced: 2024-05-22T13:53:59.771Z (7 months ago)
Topics: extension, visual-studio-code, voss
Language: JavaScript
Homepage: https://github.com/TeamVoss/VossII
Size: 78.1 KB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Language support for fl

This extension adds language support for [Voss II](https://github.com/TeamVoss/VossII)'s functional language fl to Visual Studio Code.

Tested for VossII version 1.0 (built on [2021-11-22](https://github.com/TeamVoss/VossII/commit/6607e740c0396776fc5a6c39db60c774a10b50b9)).

## Features

Features include:

- Basic syntaxic highlighting for fl (tested in Dark+ and Light+ themes)
- Basic syntaxic highlighting for bifrost (Jeremy's language used to compile assembly like code to hfl)
- Commands to send files/lines/selections to an fl interpreter with
predefined shortcuts
- Tooltips generated from fl's help texts
- Go to definition when pressing `f12` while having the cursor over
a function name/operator

> Note that appart from syntax highlighting, feature require to have
an fl interpreter running and symbols defined to work properly.
Running your current file frequently is advised

Commands and shortcuts:

| Command | Effect | Shortcut |
| ------------------------ | ----------------------------------------------------------------------------------- | ---------------------------------- |
| fl: start fl | Starts the interpreter | Automaticaly when opening fl files |
| fl: stop fl | Stops the interpreter | |
| fl: help | Displays help on the word/operator under the cursor in the fl interpreter | |
| fl: restart and run file | Restarts the interpreter and runs current file | `f5` |
| fl: run file | Runs the current file in the interpreter | `f6` |
| fl: run line | Runs the current line in the interpreter | `f7` |
| fl: run selection | Runs the current selection (or word under cursor) in the interpreter | `f8` |
| fl: run paragraph | Runs the current paragraph (text block separated by empty lines) in the interpreter | `f9` |

> Commands can be run by typing their name in the command palette (`Ctrl+Shift+P`).

> Shortcuts can be reassigned in `File > Preferences > Keyboard Shortcuts`

## Requirements

The syntax highlighting has no requirements.
All other functionnalities require to have
[Voss II](https://github.com/TeamVoss/VossII) installed and
the path to the fl interpreter specified in settings.

## Extension Settings

This extension contributes the following settings:

* `vossii-fl.path`: path to the fl interpreter (default `"fl"`)
* `vossii-fl.run_on_startup`: Automaticaly run `fl` when opening a
file/workspace with fl files (default on)
* `vossii-fl.fl_setup`: fl code to run whenever starting fl
(default `set_font font_larger;`)
* `vossii-fl.save_file_on_run`: behavior when running unsaved files.
Chose between `Ask me` (default), `Autosave` and `Don't save` (runs the last save).
* `vossii-fl.temporary_files_root`: path and prefix of temporary files used to
communicate with fl (default `/tmp/fl_`)

## Known Issues

* When running a selection/line, `DIR` will be the workspace folder and not
the file root as expected (this isn't a problem when running files)
* Getting tooltips/definition may not work on first try.
If so, move mouse out and back over or hit `f12` again.
* Can only get tooltips/go to definition for global function, both fail
for types or local variables.