enso/app/gui2
Kaz Wesley a04385a6a4
New AST APIs (#8851)
Introduce new AST APIs. They will be used for synchronization in the next PR.

# Important Notes
- `Module.edit` now clones a YDoc containing all the module's data; the resulting `MutableModule` can be edited with mutation APIs.
- Every AST type now has a mutable subtype. These `MutableAst` types expose all editing operations that were previously in `MutableModule`, such as `replace`; they also provide field setters.
2024-01-26 11:32:35 +00:00
..
.vscode [gui2] Language Server binary protocol, and loading of visualization data (#7873) 2023-10-07 20:57:47 +00:00
e2e e2e tests for collapsing and entering nodes (#8758) 2024-01-18 13:45:18 +00:00
mock Refactor for YJs AST (#8840) 2024-01-24 19:22:05 +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 New AST APIs (#8851) 2024-01-26 11:32:35 +00:00
scripts Cleanup @/util folder (#8501) 2023-12-13 22:27:31 +00:00
shared Refactor for YJs AST (#8840) 2024-01-24 19:22:05 +00:00
src New AST APIs (#8851) 2024-01-26 11:32:35 +00:00
stories Fix gui2 typecheck (#8870) 2024-01-26 09:15:01 +01:00
templates Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
ydoc-server Refactor for YJs AST (#8840) 2024-01-24 19:22:05 +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 Re-organize lib/dashboard/ (#8587) 2024-01-10 16:22:11 +00:00
playwright.config.ts improve argument placeholder resolution for partial applications and … (#8794) 2024-01-18 13:13:31 +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 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 [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.