language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-12-23 08:47:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat: full compatible with typst-preview extension (#371)

Browse source
This commit is contained in:
Myriad-Dreamin 2024-07-07 11:26:50 +08:00 • committed by GitHub
parent db314c2ea9
commit 1b57bec161
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 147 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

61
editors/neovim/Configuration.md
View file

@ -106,3 +106,64 @@ Set the print width for the formatter, which is a **soft limit** of characters p
- **Type**: `number`
- **Default**: `120`
## `preview`
Enable or disable preview features of Typst. Note: restarting the editor is required to change this setting.
- **Type**: `string`
- **Enum**:
- `enable`
- `disable`
- **Default**: `"enable"`
## `preview.refresh`
Refresh preview when the document is saved or when the document is changed
- **Type**: `string`
- **Enum**:
- `onSave`: Refresh preview on save
- `onType`: Refresh preview on type
- **Default**: `"onType"`
## `preview.scrollSync`
Configure scroll sync mode.
- **Type**: `string`
- **Enum**:
- `never`: Disable automatic scroll sync
- `onSelectionChangeByMouse`: Scroll preview to current cursor position when selection changes by mouse
- `onSelectionChange`: Scroll preview to current cursor position when selection changes by mouse or keyboard (any source)
- **Default**: `"onSelectionChangeByMouse"`
## `preview.partialRendering`
Only render visible part of the document. This can improve performance but still being experimental.
- **Type**: `boolean`
- **Default**: `true`
## `preview.invertColors`
Invert colors of the preview (useful for dark themes without cost). Please note you could see the origin colors when you hover elements in the preview.
- **Type**: `string`
- **Enum**:
- `never`: Disable color inversion of the preview
- `auto`: Invert colors smartly by detecting dark/light themes in browser environment or by `typst query` your document
- `always`: Always invert colors of the preview
- **Default**: `"never"`
## `preview.cursorIndicator`
(Experimental) Show typst cursor indicator in preview.
- **Type**: `boolean`
## `preview.showInActivityBar`
(Experimental) Show a preview panel in activity bar.
- **Type**: `boolean`

22
editors/vscode/Configuration.md
View file

@ -107,7 +107,17 @@ Set the print width for the formatter, which is a **soft limit** of characters p
- **Type**: `number`
- **Default**: `120`
## `typst-preview.refresh`
## `tinymist.preview`
Enable or disable preview features of Typst. Note: restarting the editor is required to change this setting.
- **Type**: `string`
- **Enum**:
- `enable`
- `disable`
- **Default**: `"enable"`
## `tinymist.preview.refresh`
Refresh preview when the document is saved or when the document is changed
@ -117,7 +127,7 @@ Refresh preview when the document is saved or when the document is changed
- `onType`: Refresh preview on type
- **Default**: `"onType"`
## `typst-preview.scrollSync`
## `tinymist.preview.scrollSync`
Configure scroll sync mode.
@ -128,14 +138,14 @@ Configure scroll sync mode.
- `onSelectionChange`: Scroll preview to current cursor position when selection changes by mouse or keyboard (any source)
- **Default**: `"onSelectionChangeByMouse"`
## `typst-preview.partialRendering`
## `tinymist.preview.partialRendering`
Only render visible part of the document. This can improve performance but still being experimental.
- **Type**: `boolean`
- **Default**: `true`
## `typst-preview.invertColors`
## `tinymist.preview.invertColors`
Invert colors of the preview (useful for dark themes without cost). Please note you could see the origin colors when you hover elements in the preview.
@ -146,13 +156,13 @@ Invert colors of the preview (useful for dark themes without cost). Please note
- `always`: Always invert colors of the preview
- **Default**: `"never"`
## `typst-preview.cursorIndicator`
## `tinymist.preview.cursorIndicator`
(Experimental) Show typst cursor indicator in preview.
- **Type**: `boolean`
## `typst-preview.showInActivityBar`
## `tinymist.preview.showInActivityBar`
(Experimental) Show a preview panel in activity bar.

40
editors/vscode/package.json
View file

@ -42,15 +42,15 @@
"when": "resourceLangId == typst"
},
{
"id": "typst-preview.content-preview",
"id": "tinymist.preview.content-preview",
"type": "webview",
"name": "Content",
"when": "config.typst-preview.showInActivityBar && resourceLangId == typst"
"when": "(config.tinymist.preview.showInActivityBar || config.typst-preview.showInActivityBar) && resourceLangId == typst"
},
{
"id": "typst-preview.outline",
"id": "tinymist.preview.outline",
"name": "Outline",
"when": "config.typst-preview.showInActivityBar && resourceLangId == typst"
"when": "(config.tinymist.preview.showInActivityBar || config.typst-preview.showInActivityBar) && resourceLangId == typst"
}
]
},
@ -191,7 +191,17 @@
"type": "number",
"default": 120
},
"typst-preview.sysInputs": {
"tinymist.preview": {
"title": "Enable preview features",
"description": "Enable or disable preview features of Typst. Note: restarting the editor is required to change this setting.",
"type": "string",
"default": "enable",
"enum": [
"enable",
"disable"
]
},
"tinymist.preview.sysInputs": {
"type": "object",
"items": {
"type": "string"
@ -200,13 +210,13 @@
"description": "key-value pairs visible through `sys.inputs`, corresponds to `--input` argument of typst cli",
"markdownDeprecationMessage": "The configuration item is ignored. Please see `tinymist.typstExtraArgs` for inputs."
},
"typst-preview.systemFonts": {
"tinymist.preview.systemFonts": {
"type": "boolean",
"default": true,
"description": "Whether to load system fonts. If disabled, only fonts in `typst-preview.fontPaths` is loaded",
"markdownDeprecationMessage": "The configuration item is ignored. Please use `tinymist.systemFonts` instead."
},
"typst-preview.fontPaths": {
"tinymist.preview.fontPaths": {
"type": "array",
"items": {
"type": "string",
@ -217,7 +227,7 @@
"description": "List of *additional* paths to font assets used by typst-preview.",
"markdownDeprecationMessage": "The configuration item is ignored. Please use `tinymist.fontPaths` instead."
},
"typst-preview.refresh": {
"tinymist.preview.refresh": {
"title": "Refresh preview",
"description": "Refresh preview when the document is saved or when the document is changed",
"type": "string",
@ -231,7 +241,7 @@
"Refresh preview on type"
]
},
"typst-preview.scrollSync": {
"tinymist.preview.scrollSync": {
"description": "Configure scroll sync mode.",
"type": "string",
"enum": [
@ -246,12 +256,12 @@
"Scroll preview to current cursor position when selection changes by mouse or keyboard (any source)"
]
},
"typst-preview.partialRendering": {
"tinymist.preview.partialRendering": {
"description": "Only render visible part of the document. This can improve performance but still being experimental.",
"type": "boolean",
"default": true
},
"typst-preview.invertColors": {
"tinymist.preview.invertColors": {
"description": "Invert colors of the preview (useful for dark themes without cost). Please note you could see the origin colors when you hover elements in the preview.",
"type": "string",
"enum": [
@ -266,17 +276,17 @@
"Always invert colors of the preview"
]
},
"typst-preview.cursorIndicator": {
"tinymist.preview.cursorIndicator": {
"description": "(Experimental) Show typst cursor indicator in preview.",
"type": "boolean",
"default": false
},
"typst-preview.showInActivityBar": {
"tinymist.preview.showInActivityBar": {
"description": "(Experimental) Show a preview panel in activity bar.",
"type": "boolean",
"default": false
},
"typst-preview.pinPreviewFile": {
"tinymist.preview.pinPreviewFile": {
"description": "Declare current previewing file as entrypoint for typst-lsp or tinymist. This will make typst-lsp or tinymist to use this file as entrypoint instead of the file opened in vscode. This can improve diagnostics messages and auto completion but still being experimental.",
"type": "boolean",
"default": false,
@ -658,7 +668,7 @@
"view/title": [
{
"command": "typst-preview.noteOutline",
"when": "view == typst-preview.outline",
"when": "view == tinymist.preview.outline",
"group": "navigation"
}
]

36
editors/vscode/src/extension.ts
View file

@ -36,20 +36,25 @@ import {
import { DisposeList } from "./util";
import { client, setClient } from "./lsp";
export function activate(context: ExtensionContext): Promise<void> {
const typstPreviewExtension = vscode.extensions.getExtension("mgt19937.typst-preview");
if (typstPreviewExtension) {
void vscode.window.showWarningMessage(
"Tinymist Says:\n\nTypst Preview extension is already integrated into Tinymist. Please disable Typst Preview extension to avoid conflicts."
);
}
let previewIsEnabled = false;
export function activate(context: ExtensionContext): Promise<void> {
let config: Record<string, any> = JSON.parse(
JSON.stringify(workspace.getConfiguration("tinymist"))
);
previewIsEnabled = config.preview === "enable";
enableOnEnter = !!config.onEnterEvent;
if (previewIsEnabled) {
const typstPreviewExtension = vscode.extensions.getExtension("mgt19937.typst-preview");
if (typstPreviewExtension) {
void vscode.window.showWarningMessage(
"Tinymist Says:\n\nTypst Preview extension is already integrated into Tinymist. Please disable Typst Preview extension to avoid conflicts."
);
}
}
{
const keys = Object.keys(config);
let values = keys.map((key) => config[key]);
@ -60,12 +65,14 @@ export function activate(context: ExtensionContext): Promise<void> {
}
}
// test compat-mode preview extension
// previewActivate(context, true);
if (previewIsEnabled) {
// test compat-mode preview extension
// previewActivate(context, true);
// integrated preview extension
previewSetIsTinymist(config);
previewActivate(context, false);
// integrated preview extension
previewSetIsTinymist(config);
previewActivate(context, false);
}
return startClient(context, config).catch((e) => {
void window.showErrorMessage(`Failed to activate tinymist: ${e}`);
@ -243,7 +250,10 @@ async function startClient(context: ExtensionContext, config: Record<string, any
);
await client.start();
previewPreload(context);
if (previewIsEnabled) {
previewPreload(context);
}
// Watch all non typst files.
// todo: more general ways to do this.

38
editors/vscode/src/preview.ts
View file

@ -34,14 +34,20 @@ export function previewActivate(context: vscode.ExtensionContext, isCompat: bool
const provider = new ContentPreviewProvider(context, context.extensionUri, html);
resolveContentPreviewProvider(provider);
context.subscriptions.push(
vscode.window.registerWebviewViewProvider("typst-preview.content-preview", provider)
vscode.window.registerWebviewViewProvider(
isCompat ? "typst-preview.content-preview" : "tinymist.preview.content-preview",
provider
)
);
});
{
const outlineProvider = new OutlineProvider(context.extensionUri);
resolveOutlineProvider(outlineProvider);
context.subscriptions.push(
vscode.window.registerTreeDataProvider("typst-preview.outline", outlineProvider)
vscode.window.registerTreeDataProvider(
isCompat ? "typst-preview.outline" : "tinymist.preview.outline",
outlineProvider
)
);
}
@ -95,6 +101,15 @@ export function previewDeactivate() {
previewDeactivateCompat();
}
function getPreviewConfCompat<T>(s: string) {
const t = vscode.workspace.getConfiguration().get<T>(`tinymist.preview.${s}`);
if (t !== undefined) {
return t;
}
return vscode.workspace.getConfiguration().get<T>(`typst-preview.${s}`);
}
export async function launchPreviewInWebView({
context,
task,
@ -166,15 +181,10 @@ async function launchPreviewLsp(task: LaunchInBrowserTask | LaunchInWebViewTask)
const taskId = Math.random().toString(36).substring(7);
const filePath = bindDocument.uri.fsPath;
const refreshStyle =
vscode.workspace.getConfiguration().get<string>("typst-preview.refresh") || "onSave";
const refreshStyle = getPreviewConfCompat<string>("refresh") || "onSave";
const scrollSyncMode =
ScrollSyncModeEnum[
vscode.workspace.getConfiguration().get<ScrollSyncMode>("typst-preview.scrollSync") ||
"never"
];
const enableCursor =
vscode.workspace.getConfiguration().get<boolean>("typst-preview.cursorIndicator") || false;
ScrollSyncModeEnum[getPreviewConfCompat<ScrollSyncMode>("scrollSync") || "never"];
const enableCursor = getPreviewConfCompat<boolean>("cursorIndicator") || false;
const disposes = new DisposeList();
registerPreviewTaskDispose(taskId, disposes);
const { dataPlanePort, staticServerPort } = await launchCommand();
@ -227,14 +237,10 @@ async function launchPreviewLsp(task: LaunchInBrowserTask | LaunchInWebViewTask)
async function launchCommand() {
console.log(`Preview Command ${filePath}`);
const partialRenderingArgs = vscode.workspace
.getConfiguration()
.get<boolean>("typst-preview.partialRendering")
const partialRenderingArgs = getPreviewConfCompat<boolean>("partialRendering")
? ["--partial-rendering"]
: [];
const ivArgs = vscode.workspace
.getConfiguration()
.get<string>("typst-preview.invertColors");
const ivArgs = getPreviewConfCompat<string>("invertColors");
const invertColorsArgs = ivArgs ? ["--invert-colors", ivArgs] : [];
const previewInSlideModeArgs = task.mode === "slide" ? ["--preview-mode=slide"] : [];
const { dataPlanePort, staticServerPort } = await commandStartPreview([