commit | 642bb3ff1b5d0de96a51ffde500463517bcc11ea | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Wed Nov 16 17:48:20 2022 +0000 |
committer | Mitchell Kember <mkember@google.com> | Wed Nov 16 17:48:20 2022 +0000 |
tree | 6acacace21531cf7910ca57abbfb145b53c85798 | |
parent | e298eae20d7178e8c159a579bb2d899437dc5fe1 [diff] |
Add support for link sharing This CL adds the ability to share fidlbolt links. It encodes the entire FIDL text in the URL, using the lz-string library for compression. If you open a share link and close it without editing, it won't affect the local storage state. If you edit it, it will be saved to local storage (but you can still undo back to your previous state). This is reflected in the address bar: when you start typing, the query parameter goes away (and so if you refresh, it won't reload it). Change-Id: I2d132d7fd1406fd2b0d3495d8991554586fc9a6a Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/760143 Reviewed-by: Matt Hamrick <mjhamrick@google.com>
fidlbolt is web app for exploring FIDL code and bytes, inspired by Matt Godbolt's Compiler Explorer.
To run a local fidlbolt server:
fx build host_x64/{fidlc,fidlgen_{cpp,hlcpp,rust,go,dart}} zircon/tools
.make run
.http://localhost:8080
.If you don't want changes in the Fuchsia tree (e.g. rebuilding fidlc or changing FIDL libraries) to affect the running fidlbolt, run ./prepare_deployment.sh
and use make run DEPLOYMENT=1
instead.
The backend is written in Go. It uses net/http to serve static files and handle POST requests.
The frontend is written in Elm and TypeScript. It uses webpack for bundling.
To set up the frontend:
sudo apt-get install npm
.cd frontend && npm ci
(using ci
instead of install
ensures a repeatable build).Then, use one of the commands listed in npm run
:
npm run dev
: build in development modenpm run watch
: rebuild in development mode on every file changenpm run tc
: typecheck TypeScript filesnpm run lint
: run eslint on TypeScript filesnpm run fix
: format and fix lint issues in TypeScript and Elm filesnpm run build
: build in production modeThe build commands read files in frontend/src/
and generate output in frontend/dist/
.
If you are developing on Linux, ./watch.sh
provides an easy workflow. It automatically watches code in the frontend (using npm run watch
) and backend (using inotifywait), rebuilding and restarting the server as necessary. It does not perform hot/live reloading: you still need to refresh the browser manually to see changes.
Before making a CL, always run make format
.
The project uses Docker for containerized deployment.
To build and run a new image locally:
sudo apt-get install docker-ce
../prepare_deployment.sh
docker image build -t fidlbolt .
docker container run --publish 8080:8080 --detach --name fb fidlbolt
You might need to use sudo
with the Docker commands.