7c5124094e
Part of #10526 (without TS structures: interfaces, type aliases etc.) Added lints checking for jsdocs presence (and their format) and generated stub with TODO for missing ones. Now only 344 docs are missing 🙃 # Important Notes Many changes are just automated, but they are in the middle commit. So recommended way of reviewing is review `Add jsdoc to eslint config` for checking config changes, and then `Some of the missing documentation and fixes`. |
||
|---|---|---|
| .. | ||
| .vscode | ||
| e2e | ||
| mock | ||
| project-manager-shim-middleware | ||
| public | ||
| scripts | ||
| src | ||
| stories | ||
| templates | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .snyk | ||
| env.d.ts | ||
| eslint.config.js | ||
| histoire.config.ts | ||
| index.html | ||
| lib0-ext.d.ts | ||
| LICENSE | ||
| package.json | ||
| playwright.config.ts | ||
| README.md | ||
| shortcuts.md | ||
| tsconfig.app.json | ||
| tsconfig.app.vitest.json | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| tsconfig.scripts.json | ||
| vite.config.ts | ||
| vitest.config.ts | ||
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
- Run
Extensions: Show Built-in Extensionsfrom VSCode's command palette - Find
TypeScript and JavaScript Language Features, right click and selectDisable (Workspace)
- Run
- Reload the VSCode window by running
Developer: Reload Windowfrom the command palette.
Customize configuration
See Vite Configuration Reference.
Project Setup
pnpm install
Compile and Hot-Reload for Development
pnpm -w dev:gui
Type-Check, Compile and Minify for Production
pnpm build
Run Unit Tests with Vitest
# Run once
pnpm test:unit
# Run in watch mode
pnpm test-dev:unit
Run End-to-End Tests with Playwright
# Install browsers for the first run
pnpm exec playwright install
# Runs the end-to-end tests
pnpm test:e2e
# Runs the tests only on Chromium
pnpm test:e2e -- --project=chromium
# Runs the tests of a specific file
pnpm test:e2e -- tests/example.spec.ts
# Runs the tests in watch mode, open the testing UI
pnpm test-dev:e2e
Format code with ESLint and Prettier
pnpm format
Icons license
We use two Twemoji SVG icons for our documentation panel, you can find them at:
src/assets/icon-important.svgsrc/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.