enso/app/gui2
Paweł Grabarz b286adaae4
Split ydoc server into separate module (#10735)
# Important Notes
The command to run the gui dev environment has been changed. Invoking the old command will print a message about that.
From now on, use `pnpm dev:gui2` in repository root.
2024-08-08 12:12:05 +00:00
..
.vscode [gui2] Language Server binary protocol, and loading of visualization data (#7873) 2023-10-07 20:57:47 +00:00
e2e Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
mock Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
project-manager-shim-middleware Fix Project Manager shim for GUI (#10653) 2024-07-24 12:08:16 +00:00
public Move to the Tab layout for Dashboard (#9918) 2024-06-19 15:24:11 +00:00
scripts Build Script Post-Gui1 Cleanup (#9376) 2024-03-12 20:25:51 +01:00
src Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
stories Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
templates Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
.gitignore Move to the Tab layout for Dashboard (#9918) 2024-06-19 15:24:11 +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
env.d.ts Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
eslint.config.js Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +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 Frontend adjustments for Stripe refactoring (#10054) 2024-05-31 09:59:25 +00:00
lib0-ext.d.ts Use ExternalId for NodeId and preserve it through argument deletions. (#10512) 2024-07-12 10:45:57 +00:00
LICENSE Fixed LICENSE Link. Added missing LICENSE file (#9804) 2024-05-01 19:15:52 +02:00
package.json Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
playwright.config.ts Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
README.md Migrate to pnpm (#10422) 2024-07-05 11:13:04 +00:00
shortcuts.md Add shortcuts.md (#10523) 2024-07-12 14:46:10 +00:00
tsconfig.app.json Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
tsconfig.app.vitest.json Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
tsconfig.json Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
tsconfig.node.json Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
tsconfig.scripts.json Fix GUI2 entrypoint (#8542) 2023-12-21 15:04:30 +00:00
vite.config.ts Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +00:00
vitest.config.ts Split ydoc server into separate module (#10735) 2024-08-08 12:12:05 +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

pnpm 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.