mirror of
https://github.com/enso-org/enso.git
synced 2024-11-23 16:18:23 +03:00
523a32471e
Implementing most parts of the Documentation Panel in the new GUI. Known issues: - Links do not work (yet, covered by #7992) - Some pages are entirely empty – I’m investigating. Missing doc sections likely cause this, so we probably want to add some placeholder. - Tags do not look as in design. I tried implementing them correctly but didn't have enough time to finish everything. Some initial implementation is in place, though. I will create a separate task for them. https://github.com/enso-org/enso/assets/6566674/a656ae78-5d4c-45f4-a0a5-e07fa573253e
82 lines
2.5 KiB
Markdown
82 lines
2.5 KiB
Markdown
# enso-ide
|
|
|
|
This template should help get you started developing with Vue 3 in Vite.
|
|
|
|
## Recommended IDE Setup
|
|
|
|
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
|
|
|
|
## 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)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) 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](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) 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](https://vitejs.dev/config/).
|
|
|
|
## Project Setup
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
### Compile and Hot-Reload for Development
|
|
|
|
```sh
|
|
npm run dev
|
|
```
|
|
|
|
### Type-Check, Compile and Minify for Production
|
|
|
|
```sh
|
|
npm run build
|
|
```
|
|
|
|
### Run Unit Tests with [Vitest](https://vitest.dev/)
|
|
|
|
```sh
|
|
npm run test:unit
|
|
```
|
|
|
|
### Run End-to-End Tests with [Playwright](https://playwright.dev)
|
|
|
|
```sh
|
|
# 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](https://eslint.org/)
|
|
|
|
```sh
|
|
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.
|