enso/app/gui2
Paweł Grabarz 922ac66baf
working hot reload for widget definitions (#9657)
Fixed a long-standing annoyance that widgets weren't fully hot-reloadable. Now when the widget definition (e.g. `score` function) is modified, it is hot-reloaded and new version immediately takes effect.

https://github.com/enso-org/enso/assets/919491/8e6d5a67-68ec-4353-8235-32657b32e2ec

# Important Notes
Because of how HMR API works, it needs to be passed from each widget module to the `widgetDefinition` function as an argument. When not provided, the definition will not be hot-reloadable (but the widget will still work as it used to).
2024-04-11 14:11:34 +00:00
..
.vscode [gui2] Language Server binary protocol, and loading of visualization data (#7873) 2023-10-07 20:57:47 +00:00
e2e Store graph viewport in client local storage (#9651) 2024-04-09 12:02:11 +00:00
mock Store graph viewport in client local storage (#9651) 2024-04-09 12:02:11 +00:00
parser-codegen Syntactic synchronization, automatic parentheses, metadata in Ast (#8893) 2024-02-02 10:22:18 +01:00
public Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
rust-ffi Bump Rust Toolchain (#9517) 2024-03-24 23:45:55 +00:00
scripts Build Script Post-Gui1 Cleanup (#9376) 2024-03-12 20:25:51 +01:00
shared Store graph viewport in client local storage (#9651) 2024-04-09 12:02:11 +00:00
src working hot reload for widget definitions (#9657) 2024-04-11 14:11:34 +00:00
stories Store graph viewport in client local storage (#9651) 2024-04-09 12:02:11 +00:00
templates Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
ydoc-server Improve gui app disposal handling and close all network connections (#9579) 2024-04-04 13:49:54 +00:00
.gitignore Fixes for Enso Font in GUI2 (#8508) 2023-12-13 22:17:12 +00:00
.prettierignore Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +00:00
.prettierrc.json Vue dependency update, better selection performance, visible quotes in text inputs (#9204) 2024-03-06 15:34:07 +00:00
.snyk E2E tests (#8239) 2023-11-27 15:48:37 +00:00
config.yaml Remove gui1 codebase (#9242) 2024-03-07 02:20:21 +00:00
env.d.ts Fix file browser on Linux and Windows (#9538) 2024-03-25 17:07:04 +00:00
env.story.d.ts [gui2] Component demos (#7945) 2023-10-29 19:02:07 +00:00
eslint.config.js Vue dependency update, better selection performance, visible quotes in text inputs (#9204) 2024-03-06 15:34:07 +00:00
histoire.config.ts Vue dependency update, better selection performance, visible quotes in text inputs (#9204) 2024-03-06 15:34:07 +00:00
index.html Change window title (#9676) 2024-04-11 10:59:49 +00:00
node.env.d.ts [gui2] Language Server binary protocol, and loading of visualization data (#7873) 2023-10-07 20:57:47 +00:00
package.json Color picker (#9570) 2024-04-02 11:27:13 +00:00
playwright.config.ts Vue dependency update, better selection performance, visible quotes in text inputs (#9204) 2024-03-06 15:34:07 +00:00
README.md Documentation Panel (#8118) 2023-10-30 00:27:40 +00:00
tsconfig.app.json cleanup GUI entrypoints and mocking (#9403) 2024-03-14 17:05:26 +00:00
tsconfig.app.vitest.json [GUI2] Fix and add tests for delta format translation. (#7968) 2023-10-04 10:53:54 +00:00
tsconfig.json Re-organize lib/dashboard/ (#8587) 2024-01-10 16:22:11 +00:00
tsconfig.node.json Set output evaluation context for a single node (#8440) 2023-12-15 10:29:15 +00:00
tsconfig.scripts.json Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +00:00
tsconfig.server.json [GUI2] Fix and add tests for delta format translation. (#7968) 2023-10-04 10:53:54 +00:00
tsconfig.server.vitest.json [GUI2] Fix and add tests for delta format translation. (#7968) 2023-10-04 10:53:54 +00:00
tsconfig.story.json cleanup GUI entrypoints and mocking (#9403) 2024-03-14 17:05:26 +00:00
vite.config.ts Directory management on Local (Project Manager) backend (#9353) 2024-03-27 14:42:23 +00:00
vitest.config.ts Highlight matches in CB (#8098) 2023-10-19 15:08:56 +00:00

enso-ide

This template should help get you started developing with Vue 3 in Vite.

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Playwright

# Install browsers for the first run
npx playwright install

# When testing on CI, must build the project first
npm run build

# Runs the end-to-end tests
npm run test:e2e
# Runs the tests only on Chromium
npm run test:e2e -- --project=chromium
# Runs the tests of a specific file
npm run test:e2e -- tests/example.spec.ts
# Runs the tests in debug mode
npm run test:e2e -- --debug

Lint with ESLint

npm run lint

Icons license

We use two Twemoji SVG icons for our documentation panel, you can find them at:

  • src/assets/icon-important.svg
  • src/assets/icon-info.svg

Twemoji SVG icons are licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/. Copyright 2020 Twitter, Inc and other contributors.