mirror of https://github.com/enso-org/enso.git synced 2024-12-23 13:02:07 +03:00

History

somebody1234 1fd3a037ad Avoid relative imports whenever possible (#8074 ) - Change imports from `'./'` relative imports to `@/` or `shared/` whenever possible - Imports in `shared/` and `ydoc-server` have been avoided for now in case they don't work with `@/` imports. - Deduplicate `events.ts`, remove `useDocumentEvent` in favor of `useEvent(document,` (and same for `useDocumentEventConditional` - Replace incorrect doc comments (`//` and `///`) with correct doc comments (`/*`) # Important Notes None		2023-10-16 15:56:24 +00:00
..
.vscode	[gui2] Language Server binary protocol, and loading of visualization data (#7873 )	2023-10-07 20:57:47 +00:00
e2e	[Gui2] Opening projects and language server connection (#7813 )	2023-09-22 03:43:25 +00:00
parser-codegen	Avoid relative imports whenever possible (#8074 )	2023-10-16 15:56:24 +00:00
public	[gui2] Language Server binary protocol, and loading of visualization data (#7873 )	2023-10-07 20:57:47 +00:00
rust-ffi	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +00:00
shared	Avoid relative imports whenever possible (#8074 )	2023-10-16 15:56:24 +00:00
src	Avoid relative imports whenever possible (#8074 )	2023-10-16 15:56:24 +00:00
ydoc-server	[gui2] Language Server binary protocol, and loading of visualization data (#7873 )	2023-10-07 20:57:47 +00:00
.gitignore	[gui2] Language Server binary protocol, and loading of visualization data (#7873 )	2023-10-07 20:57:47 +00:00
.prettierignore	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +00:00
.prettierrc.json	[Gui2] Opening projects and language server connection (#7813 )	2023-09-22 03:43:25 +00:00
env.d.ts	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +00:00
eslint.config.js	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +00:00
index.html	Vue visualizations (#7773 )	2023-09-26 08:14:56 +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	CodeMirror highlighting (#8075 )	2023-10-16 14:04:43 +00: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	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +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] Fix and add tests for delta format translation. (#7968 )	2023-10-04 10:53:54 +00:00
tsconfig.node.json	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +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
vite.config.ts	Avoid relative imports whenever possible (#8074 )	2023-10-16 15:56:24 +00:00
vitest.config.ts	Parser TS bindings (#7881 )	2023-10-11 13:04:38 +00:00

README.md

enso-ide

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

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:

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)
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