enso/app/gui2
Michał Wawrzyniec Urbańczyk 2d39e644b8
New GUI/IDE build script support (#7832)
This PR adds support for the new Vue-based GUI (aka `gui2`).

The user-facing changes are primarily:
* support for `./run gui2` and `./run ide2` commands (that build just the new GUI and the whole IDE package with new GUI embedded — respectively);
* the top-level `test` and `lint` commands will now invoke the relevant commands on the new GUI

---------

Co-authored-by: Paweł Grabarz <frizi09@gmail.com>
2023-10-03 20:07:20 +02:00
..
e2e [Gui2] Opening projects and language server connection (#7813) 2023-09-22 03:43:25 +00:00
public [GUI2] Module contents editing and synchronization (#7938) 2023-10-02 12:01:03 +00:00
rust-ffi Loading suggestion db (#7940) 2023-10-02 15:15:22 +02:00
shared New GUI/IDE build script support (#7832) 2023-10-03 20:07:20 +02:00
src New GUI/IDE build script support (#7832) 2023-10-03 20:07:20 +02:00
ydoc-server New GUI/IDE build script support (#7832) 2023-10-03 20:07:20 +02:00
.gitignore Vue visualizations (#7773) 2023-09-26 08:14:56 +00:00
.prettierignore Vue project title, execution mode selector, and breadcrumbs (#7726) 2023-09-07 15:02:55 +00:00
.prettierrc.json [Gui2] Opening projects and language server connection (#7813) 2023-09-22 03:43:25 +00:00
env.d.ts Loading suggestion db (#7940) 2023-10-02 15:15:22 +02:00
eslint.config.js [Gui2] Opening projects and language server connection (#7813) 2023-09-22 03:43:25 +00:00
index.html Vue visualizations (#7773) 2023-09-26 08:14:56 +00:00
node.env.d.ts Vue visualizations (#7773) 2023-09-26 08:14:56 +00:00
package.json New GUI/IDE build script support (#7832) 2023-10-03 20:07:20 +02:00
playwright.config.ts Add Vue gui project (#7696) 2023-09-04 22:27:33 +00:00
README.md Add Vue gui project (#7696) 2023-09-04 22:27:33 +00:00
tsconfig.app.json Loading suggestion db (#7940) 2023-10-02 15:15:22 +02:00
tsconfig.json [GUI2] Module contents editing and synchronization (#7938) 2023-10-02 12:01:03 +00:00
tsconfig.node.json [GUI2] Module contents editing and synchronization (#7938) 2023-10-02 12:01:03 +00:00
tsconfig.server.json [GUI2] Module contents editing and synchronization (#7938) 2023-10-02 12:01:03 +00:00
tsconfig.vitest.json [GUI2] Module contents editing and synchronization (#7938) 2023-10-02 12:01:03 +00:00
vite.config.ts Loading suggestion db (#7940) 2023-10-02 15:15:22 +02:00
vitest.config.ts Loading suggestion db (#7940) 2023-10-02 15:15:22 +02: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