mirror of
https://github.com/enso-org/enso.git
synced 2024-12-22 05:21:31 +03:00
4af33f077b
#### New documentation panel: - Shows documentation of currently-entered method. - Open/close with Ctrl+D or the extended menu. - Renders markdown; supports WYSIWYG editing. - Formatting can be added by typing the same markdown special characters that will appear in the source code, e.g.: - `# Heading` - `## Subheading` - `*emphasis*` - Panel left edge can be dragged to resize similarly to visualization container. https://github.com/enso-org/enso/assets/1047859/6feb5d23-1525-48f7-933e-c9371312decf #### Node comments are now markdown:  #### Top bar extended menu improvements: - Now closes after any menu action except +/- buttons, and on defocus/Esc. - Editor/doc-panel buttons now colored to indicate whether editor/panel is open. https://github.com/enso-org/enso/assets/1047859/345af322-c1a8-4717-8ffc-a5c919494fed Closes #9786. # Important Notes New APIs: - `DocumentationEditor` component: Lazily-loads and instantiates the implementation component (`MilkdownEditor`). - `AstDocumentation` component: Connects a `DocumentationEditor` to the documentation of an `Ast` node. - `ResizeHandles` component: Supports reuse of the resize handles used by the visualization container. - `graphStore.undoManager`: Facade for the Y.UndoManager in the project store. |
||
|---|---|---|
| .. | ||
| .vscode | ||
| e2e | ||
| mock | ||
| parser-codegen | ||
| public | ||
| rust-ffi | ||
| scripts | ||
| shared | ||
| src | ||
| stories | ||
| templates | ||
| ydoc-server | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .snyk | ||
| env.d.ts | ||
| env.story.d.ts | ||
| eslint.config.js | ||
| histoire.config.ts | ||
| index.html | ||
| LICENSE | ||
| node.env.d.ts | ||
| package.json | ||
| playwright.config.ts | ||
| README.md | ||
| tsconfig.app.json | ||
| tsconfig.app.vitest.json | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| tsconfig.scripts.json | ||
| tsconfig.server.json | ||
| tsconfig.server.vitest.json | ||
| tsconfig.story.json | ||
| vite.config.ts | ||
| vite.ydoc-server-polyglot.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
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.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.