enso/app/gui2
Adam Obuchowicz 2e7d71d459
Refactor widgets to handle dynamic config in input (#8624)
* Merged ArgumentAst and ArgumentPlaceholder into single class.
* Created `AnyWidget` input being a "general use" widget input. Most wigets try to match with it; the `Argument` input is now solely for WidgetArgument(Name) or those handling arguments in a specific way (like selector which want to show on arg name click).
* dynamic config is now part of widget input, and is properly propagated through vector editor/function widgets.

# Important Notes
The widgets still does not work perfectly:
* The chosen options often don't have argument placeholders - that's because we don't display them for constructors. Needs to be added on our side, or engine should send us methodCall info for constructors.
* There are issues with engine's messages sent to us. This makes widgets does not set up (so there is no drop-down, or vector adds `_` instead of default). I'm investigating them and going to fill issues.
2024-01-03 13:37:52 +00:00
..
.vscode [gui2] Language Server binary protocol, and loading of visualization data (#7873) 2023-10-07 20:57:47 +00:00
e2e More E2E tests for Component Browser (#8559) 2024-01-03 09:12:38 +00:00
mock Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +00:00
parser-codegen [GUI2] Render widget arguments (#8339) 2023-11-22 14:43:58 +00:00
public Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
rust-ffi Parser TS bindings (#7881) 2023-10-11 13:04:38 +00:00
scripts Cleanup @/util folder (#8501) 2023-12-13 22:27:31 +00:00
shared Refactor widgets to handle dynamic config in input (#8624) 2024-01-03 13:37:52 +00:00
src Refactor widgets to handle dynamic config in input (#8624) 2024-01-03 13:37:52 +00:00
stories Preparing for AST-based synchronization (#8625) 2024-01-02 15:18:11 +00:00
templates Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
ydoc-server Preparing for AST-based synchronization (#8625) 2024-01-02 15:18:11 +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 [Gui2] Opening projects and language server connection (#7813) 2023-09-22 03:43:25 +00:00
.snyk E2E tests (#8239) 2023-11-27 15:48:37 +00:00
env.d.ts Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +00:00
env.story.d.ts [gui2] Component demos (#7945) 2023-10-29 19:02:07 +00:00
eslint.config.js Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
histoire.config.ts Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
index.html Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +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 Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +00:00
playwright.config.ts [GUI2] Widget update handlers (#8545) 2023-12-22 10:59:57 +00:00
README.md Documentation Panel (#8118) 2023-10-30 00:27:40 +00:00
tsconfig.app.json Set output evaluation context for a single node (#8440) 2023-12-15 10:29:15 +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 [gui2] Component demos (#7945) 2023-10-29 19:02:07 +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 [gui2] Component demos (#7945) 2023-10-29 19:02:07 +00:00
vite.config.ts Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +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.