enso/app/gui2
Kaz Wesley d7689b3357
Show images in documentation (#10205)
Render markdown image syntax in documentation. Relative URLs are fetched from the project directory; absolute URLs are hotlinked from wherever they point.

Syntax and URL resolution:
```
# In New_Project27/src/Main.enso

## Main method docs
- Image at `New_Project27/src/image.jpg`: ![Image](image.jpg)
- Image at `New_Project27/image.png`: ![Image](../image.png)
- Image at `New_Project27/src/image.jpg`: ![Image](/src/image.jpg)
- Image at `New_Project27/image.png`: ![Image](/image.png)
main =
42
```

https://github.com/enso-org/enso/assets/1047859/3f873f3f-31b1-44bf-ae3e-2f467f2d546d

Closes #10058.

# Important Notes
Stacked on #10064.
2024-06-10 14:15:36 +00:00
..
.vscode [gui2] Language Server binary protocol, and loading of visualization data (#7873) 2023-10-07 20:57:47 +00:00
e2e Show images in documentation (#10205) 2024-06-10 14:15:36 +00:00
mock Show images in documentation (#10205) 2024-06-10 14:15:36 +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 Consider currently written path when opening file browser (#10076) 2024-05-30 07:25:25 +00:00
src Show images in documentation (#10205) 2024-06-10 14:15:36 +00:00
stories Moving nodes or camera with arrows (#10179) 2024-06-06 16:47:02 +00:00
templates Read custom visualizations (#8180) 2023-11-03 20:09:45 +00:00
ydoc-server Start Ydoc with the language server (#9862) 2024-05-28 13:51:42 +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
env.d.ts Consider currently written path when opening file browser (#10076) 2024-05-30 07:25:25 +00:00
env.story.d.ts [gui2] Component demos (#7945) 2023-10-29 19:02:07 +00:00
eslint.config.js Run ydoc-server with GraalVM (#9528) 2024-05-02 06:28:57 +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
LICENSE Fixed LICENSE Link. Added missing LICENSE file (#9804) 2024-05-01 19:15:52 +02: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 Show images in documentation (#10205) 2024-06-10 14:15:36 +00:00
playwright.config.ts Display argument placeholders for autoscoped constructors (#9737) 2024-04-24 13:40:42 +02: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 Implement new design for tooltips in GUI (#10172) 2024-06-07 01:48:11 +00:00
vite.ydoc-server-polyglot.config.ts Start Ydoc with the language server (#9862) 2024-05-28 13:51:42 +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.