mirror of
https://github.com/Myriad-Dreamin/tinymist.git
synced 2025-12-23 08:47:50 +00:00
Tinymist [ˈtaɪni mɪst] is an integrated language service for Typst [taɪpst].
|
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| contrib | ||
| crates | ||
| docs | ||
| editors | ||
| scripts | ||
| syntaxes/textmate | ||
| tests | ||
| tools | ||
| typ/templates | ||
| .gitignore | ||
| .prettierignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| yarn.lock | ||
Tinymist
Tinymist [ˈtaɪni mɪst] is an integrated language service for Typst [taɪpst]. You can also call it "微霭" [wēi ǎi] in Chinese.
It contains:
- an analyzing library for Typst, see tinymist-query.
- a CLI for Typst, see tinymist.
- which provides a language server for Typst, see Langauge Features.
- which provides a preview server for Typst, see Preview Feature.
- a VSCode extension for Typst, see Tinymist VSCode Extension.
Features
Language service (LSP) features:
- Semantic highlighting
- Also known as "syntax highlighting".
- Diagnostics
- Also known as "error checking" or "error reporting".
- Document highlight
- Highlight all break points in a loop context.
- (Todo) Highlight all exit points in a function context.
- (Todo) Highlight all captures in a closure context.
- (Todo) Highlight all occurrences of a symbol in a document.
- Document symbols
- Also known as "document outline" or "table of contents" in Typst.
- Folding ranges
- You can collapse code/content blocks and headings.
- Goto definitions
- Right-click on a symbol and select "Go to Definition".
- Or ctrl+click on a symbol.
- References
- Right-click on a symbol and select "Go to References" or "Find References".
- Or ctrl+click on a symbol.
- Hover tips
- Also known as "hovering tooltip".
- Inlay hints
- Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects.
- Color Provider
- View all inlay colorful label for color literals in your document.
- Change the color literal's value by a color picker or its code presentation.
- Code Lens
- Should give contextual buttons along with code. For example, a button for exporting your document to various formats at the start of the document.
- Rename symbols
- Help with function and method signatures
- Workspace Symbols
- Code Action
- Increasing/Decreasing heading levels.
- experimental/onEnter
- Enter inside triple-slash comments automatically inserts
/// - Enter in the middle or after a trailing space in
//inserts// - Enter inside
//!doc comments automatically inserts//!
- Enter inside triple-slash comments automatically inserts
Extra features:
- Compiles to PDF on save (configurable to as-you-type, or other options)
- Provides code lenses for exporting to various formats (PDF, SVG, PNG, etc.)
- Provides a status bar item to show the current document's compilation status and words count.
- Editor tools:
- View a list of templates in template gallery. (
tinymist.showTemplateGallery) - Click a button in template gallery to initialize a new project with a template. (
tinymist.initTemplateandtinymist.initTemplateInPlace) - Trace execution in current document. (
tinymist.profileCurrentFile)
- View a list of templates in template gallery. (
Installation
Follow the instructions to enable tinymist in your favorite editor.
Documentation
See Online Documentation.
Packaging
Roadmap
After development for two months, most of the features are implemented. There are still some features to be implemented, but I would like to leave them in typst v0.12.0. I'll also pick some of them to implement on my weekends. Also please feel free to contribute if you are interested in the following features.
- Documentation and refactoring: It is my current focus.
- Spell checking: There is already a branch but no suitable (default) spell checking library is found.
- Periscope renderer: It is disabled since vscode reject to render SVGs containing foreignObjects.
- Inlay hint: It is disabled by default because of performance issues.
- Find references of labels, dictionary fields, and named function arguments.
- Go to definition of dictionary fields and named function arguments.
- Autocompletion for raw language tags.
- Improve symbol view's appearance.
Contributing
Please read the CONTRIBUTING.md file for contribution guidelines.
Acknowledgements
- Partially code is inherited from typst-lsp
- The integrating offline handwritten-stroke recognizer is powered by Detypify.
- The integrating preview service is powered by typst-preview.