Running a LanguageTool server is resource intensive, so if you find this plugin useful, please consider donating to help me keep it alive!" }, - "hintTitle":"About", - "hintDesc":"plugin-sample-vite-svelte
@frostime
@88250
@zxkmm" + "server": { + "title": "LanguageTool server", + "description": "The URL of the LanguageTool server, with the trailing slash. Some suggestions:\n
https://lt.massive.box/https://languagetool.org/api/https://api.languagetoolplus.com/http://localhost:8081/en-US,de-DE or en-GB,de-DE"
+ },
+ "enabledByDefault": {
+ "title": "Enable grammar checking by default",
+ "description": "If turned on, grammar checking is enabled for all documents, and must be manually disabled for each document where it's not needed.\nIf turned off, grammar checking is disabled for all documents, and must be manually enabled for each document where it's needed." + }, + "defaultLanguage": { + "title": "Default language for documents", + "description": "When a language is not manually set for a document, this one will be used for grammar suggestions.
If you select auto-detection, some blocks may be recognized incorrectly." + }, + "analytics": { + "title": "Analytics", + "description": "Enable to send anonymous usage data to the developer. Privacy Policy" + }, + "customDictionary": { + "title": "Custom dictionary", + "description": "A comma-separated list of words that will not trigger the grammar checker. For example:
hello,SiYuanAfter editing and saving, reload SiYuan to apply." + }, + "experimentalCorrect": { + "title": "[Feature preview] Apply corrections when selected", + "description": "[Feature preview] This feature will modify the content of your documents when used, and can alter them significantly without the ability to roll the changes back. This feature is not recommended for production workspaces.
When a correction is chosen, apply it to the document instead of just having copied to your clipboard." + } + }, + "errors": { + "builtInEnabled": "The built-in spell checker is enabled, and may conflict with the SySpell Plugin and cause confusion. Disable it in Settings > Editor.", + "cantRenderLabel": "Can't provide grammar suggestions for this block", + "cantRender": "This block contains elements, such as images or tables, that don't work well with the SySpell system.", + "waitingForSuggestions": "Grammar suggestions for this block aren't ready yet, please close the menu and open it again after a few seconds.", + "correctionNotEnabled": "The correction has been copied to your clipboard. Suggestions can be auto-applied when selected. Visit the plugin's settings to enable.", + "checkServer": "Failed to contact grammar checking server, make sure it's correctly set in the plugin settings.", + "fatal": "The grammar checking plugin will quit now. Please restart SiYuan.", + "notImplementedNotebookSettings": "Notebook-wide grammar checking settings aren't implemented yet, they will be added in a future version. Thanks for your patience!" + }, + "docMenu": { + "documentStatus": "Document status", + "language": "Language", + "status": "Status", + "enabled": "Enabled", + "disabled": "Disabled", + "toggleSpellCheck": "Toggle grammar checking", + "setDocumentLanguage": "Set document language", + "autodetectLanguage": "Autodetect [block by block]" + }, + "textMenu": { + "addToDictionary": "Add to dictionary", + "addedToDictionary": "Added to dictionary: " + } } \ No newline at end of file diff --git a/public/i18n/zh_CN.json b/public/i18n/zh_CN.json deleted file mode 100644 index 6600f6a..0000000 --- a/public/i18n/zh_CN.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "addTopBarIcon": "使用插件添加一个顶栏按钮", - "cancel": "取消", - "save": "保存", - "byeMenu": "再见，菜单！", - "helloPlugin": "你好，插件！", - "byePlugin": "再见，插件！", - "showDialog": "弹出一个对话框", - "removedData": "数据已删除", - "confirmRemove": "确认删除 ${name} 中的数据？", - "insertEmoji": "插入表情", - "removeSpace": "移除空格", - "getTab": "在日志中打印出已打开的所有自定义页签", - "name": "思源", - "hello": { - "makesure": "使用这个模板之前，请阅读官方教程, 确保自己已经理解了插件的基本开发流程。" - }, - "hintTitle": "关于", - "hintDesc": "🔗 plugin-sample-vite-svelte
💻 @frostime
💻 @88250
💻 @zxkmm" -} \ No newline at end of file diff --git a/src/analytics.ts b/src/analytics.ts new file mode 100644 index 0000000..8f35e06 --- /dev/null +++ b/src/analytics.ts @@ -0,0 +1,47 @@ +import {getBackend, getFrontend} from "siyuan"; +import packageJson from '../package.json' assert { type: 'json' }; + +export class Analytics { + + private readonly enabled: boolean; + + private static readonly ENDPOINT = 'https://stats.massive.box/api/send_noua'; + private static readonly WEBSITE_ID = '6963975c-c7e7-495f-a4f0-fa1a0d3e64ac'; + + constructor(enabled: boolean) { + this.enabled = enabled; + } + + async sendEvent(name: string, addData?: Record
-
+ `,
+ // spell check - https://fonts.google.com/icons?selected=Material+Symbols+Outlined:spellcheck
+ `
+ `,
+ // language - https://fonts.google.com/icons?selected=Material+Symbols+Outlined:language_chinese_quick
+ `
+ `,
+ // toggle - https://fonts.google.com/icons?selected=Material+Symbols+Outlined:toggle_on
+ `
+ `,
+ // autodetect - https://fonts.google.com/icons?selected=Material+Symbols+Outlined:network_intelligence
+ `
+ `,
+ // error - https://fonts.google.com/icons?selected=Material+Symbols+Outlined
+ `
+ `,
+ // add - https://fonts.google.com/icons?selected=Material+Symbols+Outlined:add
+ `
+ `
+ ]
+
+}
\ No newline at end of file
diff --git a/src/index.scss b/src/index.scss
deleted file mode 100644
index e69de29..0000000
diff --git a/src/index.ts b/src/index.ts
index 614e0a4..7227a9b 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,1011 +1,122 @@
-import {
- Plugin,
- showMessage,
- confirm,
- Dialog,
- Menu,
- openTab,
- adaptHotkey,
- getFrontend,
- getBackend,
- // Setting,
- // fetchPost,
- Protyle,
- openWindow,
- IOperation,
- Constants,
- openMobileFileById,
- lockScreen,
- ICard,
- ICardData,
- Custom,
- exitSiYuan,
- getModelByDockType,
- getAllEditor,
- Files,
- platformUtils,
- openSetting,
- openAttributePanel,
- saveLayout
-} from "siyuan";
-import "./index.scss";
-import { IMenuItem } from "siyuan/types";
-
-import HelloExample from "@/hello.svelte";
-import SettingExample from "@/setting-example.svelte";
-
-import { SettingUtils } from "./libs/setting-utils";
-import { svelteDialog } from "./libs/dialog";
-
-const STORAGE_NAME = "menu-config";
-const TAB_TYPE = "custom_tab";
-const DOCK_TYPE = "dock_tab";
-
-export default class PluginSample extends Plugin {
-
- private custom: () => Custom;
- private isMobile: boolean;
- private blockIconEventBindThis = this.blockIconEvent.bind(this);
- private settingUtils: SettingUtils;
+import {Plugin, showMessage} from 'siyuan';
+import {ProtyleHelpers} from "@/protyleHelpers";
+import {Icons} from "@/icons";
+import {Settings} from "@/settings";
+import {SettingUtils} from "@/libs/setting-utils";
+import {Analytics} from "@/analytics";
+import {SuggestionEngine} from "@/suggestions";
+import {Menus} from "@/menus";
- updateProtyleToolbar(toolbar: Array) {
- toolbar.push("|");
- toolbar.push({
- name: "insert-smail-emoji",
- icon: "iconEmoji",
- hotkey: "⇧⌘I",
- tipPosition: "n",
- tip: this.i18n.insertEmoji,
- click(protyle: Protyle) {
- protyle.insert("😊");
- }
- });
- return toolbar;
- }
+export default class SpellCheckPlugin extends Plugin {
+
+ private menus: Menus
+
+ public settingsUtil: SettingUtils;
+ public suggestions: SuggestionEngine
+ public analytics: Analytics
+ public i18nx: any; // This object is just a copy of i18n, but with type "any" to not trigger type errors
+
+ public static ENABLED_ATTR = 'custom-spellcheck-enable'
+ public static LANGUAGE_ATTR = 'custom-spellcheck-language'
async onload() {
- this.data[STORAGE_NAME] = { readonlyText: "Readonly" };
- console.log("loading plugin-sample", this.i18n);
+ this.i18nx = this.i18n
+ new Icons(this);
+ this.settingsUtil = await Settings.init(this)
+ this.analytics = new Analytics(this.settingsUtil.get('analytics'));
+ this.suggestions = new SuggestionEngine(this)
+ this.menus = new Menus(this)
- const frontEnd = getFrontend();
- this.isMobile = frontEnd === "mobile" || frontEnd === "browser-mobile";
- // 图标的制作参见帮助文档
- this.addIcons(`
-
-
- `);
+ void this.analytics.sendEvent('load')
- let tabDiv = document.createElement("div");
- let app = null;
- this.custom = this.addTab({
- type: TAB_TYPE,
- init() {
- app = new HelloExample({
- target: tabDiv,
- props: {
- app: this.app,
- blockID: this.data.blockID
- }
- });
- this.element.appendChild(tabDiv);
- console.log(this.element);
- },
- beforeDestroy() {
- console.log("before destroy tab:", TAB_TYPE);
- },
- destroy() {
- app?.$destroy();
- console.log("destroy tab:", TAB_TYPE);
- }
- });
+ const style = document.createElement('style');
+ style.innerHTML = `
+ .underline-overlay {
+ position: absolute;
+ top: 0;
+ left: 0;
+ pointer-events: none;
+ z-index: 2;
+ }
+ .error-underline {
+ position: absolute;
+ height: 2px;
+ background-image:
+ radial-gradient(circle at 2px 1px, #ff4444 1px, transparent 1px),
+ radial-gradient(circle at 6px 1px, #ff4444 1px, transparent 1px);
+ background-size: 8px 2px;
+ background-repeat: repeat-x;
+ background-position: 0 bottom;
+ }`
+ window.document.head.appendChild(style);
- this.addCommand({
- langKey: "showDialog",
- hotkey: "⇧⌘O",
- callback: () => {
- this.showDialog();
- },
- });
-
- this.addCommand({
- langKey: "getTab",
- hotkey: "⇧⌘M",
- globalCallback: () => {
- console.log(this.getOpenedTab());
- },
- });
-
- this.addDock({
- config: {
- position: "LeftBottom",
- size: { width: 200, height: 0 },
- icon: "iconSaving",
- title: "Custom Dock",
- hotkey: "⌥⌘W",
- },
- data: {
- text: "This is my custom dock"
- },
- type: DOCK_TYPE,
- resize() {
- console.log(DOCK_TYPE + " resize");
- },
- update() {
- console.log(DOCK_TYPE + " update");
- },
- init: (dock) => {
- if (this.isMobile) {
- dock.element.innerHTML = `
-
`;
- } else {
- dock.element.innerHTML = `appId:
-
- ${app?.appId}
-
-
- API demo:
-
-
- System current time: {time}
-
-
-
- Protyle demo: id = {blockID}
-
-
-
-
diff --git a/src/icons.ts b/src/icons.ts
new file mode 100644
index 0000000..2189f92
--- /dev/null
+++ b/src/icons.ts
@@ -0,0 +1,43 @@
+import {Plugin} from 'siyuan';
+
+export class Icons {
+
+ constructor(p: Plugin) {
+ this.icons.forEach(icon =>
+ p.addIcons(icon)
+ )
+
+ }
+
+ private icons = [
+ // info - https://fonts.google.com/icons?selected=Material+Symbols+Outlined:info
+ `
- ${dock.data.text}
-
-
-
`;
- }
- },
- destroy() {
- console.log("destroy dock:", DOCK_TYPE);
- }
- });
-
- this.settingUtils = new SettingUtils({
- plugin: this, name: STORAGE_NAME
- });
- this.settingUtils.addItem({
- key: "Input",
- value: "",
- type: "textinput",
- title: "Readonly text",
- description: "Input description",
- action: {
- // Called when focus is lost and content changes
- callback: () => {
- // Return data and save it in real time
- let value = this.settingUtils.takeAndSave("Input");
- console.log(value);
- }
- }
- });
- this.settingUtils.addItem({
- key: "InputArea",
- value: "",
- type: "textarea",
- title: "Readonly text",
- description: "Input description",
- // Called when focus is lost and content changes
- action: {
- callback: () => {
- // Read data in real time
- let value = this.settingUtils.take("InputArea");
- console.log(value);
- }
- }
- });
- this.settingUtils.addItem({
- key: "Check",
- value: true,
- type: "checkbox",
- title: "Checkbox text",
- description: "Check description",
- action: {
- callback: () => {
- // Return data and save it in real time
- let value = !this.settingUtils.get("Check");
- this.settingUtils.set("Check", value);
- console.log(value);
- }
- }
- });
- this.settingUtils.addItem({
- key: "Select",
- value: 1,
- type: "select",
- title: "Select",
- description: "Select description",
- options: {
- 1: "Option 1",
- 2: "Option 2"
- },
- action: {
- callback: () => {
- // Read data in real time
- let value = this.settingUtils.take("Select");
- console.log(value);
- }
- }
- });
- this.settingUtils.addItem({
- key: "Slider",
- value: 50,
- type: "slider",
- title: "Slider text",
- description: "Slider description",
- direction: "column",
- slider: {
- min: 0,
- max: 100,
- step: 1,
- },
- action: {
- callback: () => {
- // Read data in real time
- let value = this.settingUtils.take("Slider");
- console.log(value);
- }
- }
- });
- this.settingUtils.addItem({
- key: "Btn",
- value: "",
- type: "button",
- title: "Button",
- description: "Button description",
- button: {
- label: "Button",
- callback: () => {
- showMessage("Button clicked");
- }
- }
- });
- this.settingUtils.addItem({
- key: "Custom Element",
- value: "",
- type: "custom",
- direction: "row",
- title: "Custom Element",
- description: "Custom Element description",
- //Any custom element must offer the following methods
- createElement: (currentVal: any) => {
- let div = document.createElement('div');
- div.style.border = "1px solid var(--b3-theme-primary)";
- div.contentEditable = "true";
- div.textContent = currentVal;
- return div;
- },
- getEleVal: (ele: HTMLElement) => {
- return ele.textContent;
- },
- setEleVal: (ele: HTMLElement, val: any) => {
- ele.textContent = val;
- }
- });
- this.settingUtils.addItem({
- key: "Hint",
- value: "",
- type: "hint",
- title: this.i18n.hintTitle,
- description: this.i18n.hintDesc,
- });
-
- try {
- this.settingUtils.load();
- } catch (error) {
- console.error("Error loading settings storage, probably empty config json:", error);
+ if(window.siyuan.config.editor.spellcheck) {
+ showMessage(this.i18nx.errors.builtInEnabled, -1, 'error')
}
+ this.eventBus.on('ws-main', async (event) => {
- this.protyleSlash = [{
- filter: ["insert emoji 😊", "插入表情 😊", "crbqwx"],
- html: `
-
-
-
- Custom Dock
-
-
-
-
- ${dock.data.text}
-
- ${this.i18n.insertEmoji}
`,
- id: "insertEmoji",
- callback(protyle: Protyle) {
- protyle.insert("😊");
- }
- }];
+ if (event.detail.cmd != 'transactions') { return }
- this.protyleOptions = {
- toolbar: ["block-ref",
- "a",
- "|",
- "text",
- "strong",
- "em",
- "u",
- "s",
- "mark",
- "sup",
- "sub",
- "clear",
- "|",
- "code",
- "kbd",
- "tag",
- "inline-math",
- "inline-memo",
- ],
- };
+ const operation = event.detail.data[0].doOperations[0]
+ const action = operation.action
+ const blockID = operation.id
+
+ if(action != 'update') { return }
+
+ await this.suggestions.suggestAndRender(blockID)
+ void this.suggestions.forAllBlocksSuggest(this.suggestions.documentID, false, true, false)
+
+ })
+
+ this.eventBus.on('open-menu-content', async (event) => {
+
+ if(!this.suggestions.documentEnabled) { return }
+ void this.analytics.sendEvent('menu-open-any');
+ const blockID = ProtyleHelpers.getNodeId(event.detail.range.startContainer.parentElement)
+
+ const suggNo = this.suggestions.getSuggestionNumber(blockID, event.detail.range)
+ this.menus.addCorrectionsToParagraphMenu(blockID, suggNo, event.detail.menu)
+
+ })
+
+ this.eventBus.on('open-menu-doctree', async (event) => {
+ console.log(event)
+ const docID = ProtyleHelpers.getNodeId(event.detail.elements[0]) // @TODO this is ugly, why does the event not carry the docID?
+ void this.menus.addSettingsToDocMenu(docID, event.detail.menu)
+ })
+
+ this.eventBus.on('switch-protyle', async (event) => {
+
+ const docID = event.detail.protyle.block.id
+ const settings = await ProtyleHelpers.getDocumentSettings(docID, this.settingsUtil.get('enabledByDefault'), this.settingsUtil.get('defaultLanguage'))
+
+ this.suggestions.documentID = docID
+ this.suggestions.documentEnabled = settings.enabled
+ this.suggestions.documentLanguage = settings.language
+
+ this.suggestions.clearStorage()
+ void this.suggestions.forAllBlocksSuggest(docID, true, true, false)
+
+ const activeEditor = document.querySelector('.fn__flex-1.protyle:not([class*="fn__none"])')
+ new ResizeObserver(this.reRenderSuggestions.bind(this)).observe(activeEditor)
+
+ })
- console.log(this.i18n.helloPlugin);
}
- onLayoutReady() {
- const topBarElement = this.addTopBar({
- icon: "iconFace",
- title: this.i18n.addTopBarIcon,
- position: "right",
- callback: () => {
- if (this.isMobile) {
- this.addMenu();
- } else {
- let rect = topBarElement.getBoundingClientRect();
- // 如果被隐藏，则使用更多按钮
- if (rect.width === 0) {
- rect = document.querySelector("#barMore").getBoundingClientRect();
- }
- if (rect.width === 0) {
- rect = document.querySelector("#barPlugins").getBoundingClientRect();
- }
- this.addMenu(rect);
- }
- }
- });
-
- const statusIconTemp = document.createElement("template");
- statusIconTemp.innerHTML = ``;
- statusIconTemp.content.firstElementChild.addEventListener("click", () => {
- confirm("⚠️", this.i18n.confirmRemove.replace("${name}", this.name), () => {
- this.removeData(STORAGE_NAME).then(() => {
- this.data[STORAGE_NAME] = { readonlyText: "Readonly" };
- showMessage(`[${this.name}]: ${this.i18n.removedData}`);
- });
- });
- });
- this.addStatusBar({
- element: statusIconTemp.content.firstElementChild as HTMLElement,
- });
- // this.loadData(STORAGE_NAME);
- this.settingUtils.load();
- console.log(`frontend: ${getFrontend()}; backend: ${getBackend()}`);
-
- console.log(
- "Official settings value calling example:\n" +
- this.settingUtils.get("InputArea") + "\n" +
- this.settingUtils.get("Slider") + "\n" +
- this.settingUtils.get("Select") + "\n"
- );
+ private reRenderSuggestions() {
+ void this.suggestions.forAllBlocksSuggest(this.suggestions.documentID, false, true, false)
}
- async onunload() {
- console.log(this.i18n.byePlugin);
- showMessage("Goodbye SiYuan Plugin");
- console.log("onunload");
+ onunload() {
+ void this.analytics.sendEvent('unload');
}
uninstall() {
- console.log("uninstall");
+ void this.analytics.sendEvent('uninstall');
}
- async updateCards(options: ICardData) {
- options.cards.sort((a: ICard, b: ICard) => {
- if (a.blockID < b.blockID) {
- return -1;
- }
- if (a.blockID > b.blockID) {
- return 1;
- }
- return 0;
- });
- return options;
- }
- /**
- * A custom setting pannel provided by svelte
- */
- openSetting(): void {
- let dialog = new Dialog({
- title: "SettingPannel",
- content: ``,
- width: "800px",
- destroyCallback: (options) => {
- console.log("destroyCallback", options);
- //You'd better destroy the component when the dialog is closed
- pannel.$destroy();
- }
- });
- let pannel = new SettingExample({
- target: dialog.element.querySelector("#SettingPanel"),
- });
- }
-
- private eventBusPaste(event: any) {
- // 如果需异步处理请调用 preventDefault， 否则会进行默认处理
- event.preventDefault();
- // 如果使用了 preventDefault，必须调用 resolve，否则程序会卡死
- event.detail.resolve({
- textPlain: event.detail.textPlain.trim(),
- });
- }
-
- private eventBusLog({ detail }: any) {
- console.log(detail);
- }
-
- private blockIconEvent({ detail }: any) {
- detail.menu.addItem({
- id: "pluginSample_removeSpace",
- iconHTML: "",
- label: this.i18n.removeSpace,
- click: () => {
- const doOperations: IOperation[] = [];
- detail.blockElements.forEach((item: HTMLElement) => {
- const editElement = item.querySelector('[contenteditable="true"]');
- if (editElement) {
- editElement.textContent = editElement.textContent.replace(/ /g, "");
- doOperations.push({
- id: item.dataset.nodeId,
- data: item.outerHTML,
- action: "update"
- });
- }
- });
- detail.protyle.getInstance().transaction(doOperations);
- }
- });
- }
-
- private showDialog() {
- const docId = this.getEditor().protyle.block.rootID;
- svelteDialog({
- title: `SiYuan ${Constants.SIYUAN_VERSION}`,
- width: this.isMobile ? "92vw" : "720px",
- constructor: (container: HTMLElement) => {
- return new HelloExample({
- target: container,
- props: {
- app: this.app,
- blockID: docId
- }
- });
- }
- });
- }
-
- private addMenu(rect?: DOMRect) {
- const menu = new Menu("topBarSample", () => {
- console.log(this.i18n.byeMenu);
- });
- menu.addItem({
- icon: "iconSettings",
- label: "Open SiYuan Setting",
- click: () => {
- openSetting(this.app);
- }
- });
- menu.addItem({
- icon: "iconSettings",
- label: "Open Plugin Setting",
- click: () => {
- this.openSetting();
- }
- });
- menu.addSeparator();
- menu.addItem({
- icon: "iconDrag",
- label: "Open Attribute Panel",
- click: () => {
- openAttributePanel({
- nodeElement: this.getEditor().protyle.wysiwyg.element.firstElementChild as HTMLElement,
- protyle: this.getEditor().protyle,
- focusName: "custom",
- });
- }
- });
- menu.addItem({
- icon: "iconInfo",
- label: "Dialog(open doc first)",
- accelerator: this.commands[0].customHotkey,
- click: () => {
- this.showDialog();
- }
- });
- menu.addItem({
- icon: "iconFocus",
- label: "Select Opened Doc(open doc first)",
- click: () => {
- (getModelByDockType("file") as Files).selectItem(this.getEditor().protyle.notebookId, this.getEditor().protyle.path);
- }
- });
- if (!this.isMobile) {
- menu.addItem({
- icon: "iconFace",
- label: "Open Custom Tab(open doc first)",
- click: () => {
- const tab = openTab({
- app: this.app,
- custom: {
- icon: "iconFace",
- title: "Custom Tab",
- data: {
- // text: platformUtils.isHuawei() ? "Hello, Huawei!" : "This is my custom tab",
- blockID: this.getEditor().protyle.block.rootID,
- },
- id: this.name + TAB_TYPE
- },
- });
- console.log(tab);
- }
- });
- menu.addItem({
- icon: "iconImage",
- label: "Open Asset Tab(First open the Chinese help document)",
- click: () => {
- const tab = openTab({
- app: this.app,
- asset: {
- path: "assets/paragraph-20210512165953-ag1nib4.svg"
- }
- });
- console.log(tab);
- }
- });
- menu.addItem({
- icon: "iconFile",
- label: "Open Doc Tab(open doc first)",
- click: async () => {
- const tab = await openTab({
- app: this.app,
- doc: {
- id: this.getEditor().protyle.block.rootID,
- }
- });
- console.log(tab);
- }
- });
- menu.addItem({
- icon: "iconSearch",
- label: "Open Search Tab",
- click: () => {
- const tab = openTab({
- app: this.app,
- search: {
- k: "SiYuan"
- }
- });
- console.log(tab);
- }
- });
- menu.addItem({
- icon: "iconRiffCard",
- label: "Open Card Tab",
- click: () => {
- const tab = openTab({
- app: this.app,
- card: {
- type: "all"
- }
- });
- console.log(tab);
- }
- });
- menu.addItem({
- icon: "iconLayout",
- label: "Open Float Layer(open doc first)",
- click: () => {
- this.addFloatLayer({
- refDefs: [{ refID: this.getEditor().protyle.block.rootID }],
- x: window.innerWidth - 768 - 120,
- y: 32,
- isBacklink: false
- });
- }
- });
- menu.addItem({
- icon: "iconOpenWindow",
- label: "Open Doc Window(open doc first)",
- click: () => {
- openWindow({
- doc: { id: this.getEditor().protyle.block.rootID }
- });
- }
- });
- } else {
- menu.addItem({
- icon: "iconFile",
- label: "Open Doc(open doc first)",
- click: () => {
- openMobileFileById(this.app, this.getEditor().protyle.block.rootID);
- }
- });
- }
- menu.addItem({
- icon: "iconLock",
- label: "Lockscreen",
- click: () => {
- lockScreen(this.app);
- }
- });
- menu.addItem({
- icon: "iconQuit",
- label: "Exit Application",
- click: () => {
- exitSiYuan();
- }
- });
- menu.addItem({
- icon: "iconDownload",
- label: "Save Layout",
- click: () => {
- saveLayout(() => {
- showMessage("Layout saved");
- });
- }
- });
- menu.addItem({
- icon: "iconScrollHoriz",
- label: "Event Bus",
- type: "submenu",
- submenu: [{
- icon: "iconSelect",
- label: "On ws-main",
- click: () => {
- this.eventBus.on("ws-main", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off ws-main",
- click: () => {
- this.eventBus.off("ws-main", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On click-blockicon",
- click: () => {
- this.eventBus.on("click-blockicon", this.blockIconEventBindThis);
- }
- }, {
- icon: "iconClose",
- label: "Off click-blockicon",
- click: () => {
- this.eventBus.off("click-blockicon", this.blockIconEventBindThis);
- }
- }, {
- icon: "iconSelect",
- label: "On click-pdf",
- click: () => {
- this.eventBus.on("click-pdf", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off click-pdf",
- click: () => {
- this.eventBus.off("click-pdf", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On click-editorcontent",
- click: () => {
- this.eventBus.on("click-editorcontent", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off click-editorcontent",
- click: () => {
- this.eventBus.off("click-editorcontent", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On click-editortitleicon",
- click: () => {
- this.eventBus.on("click-editortitleicon", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off click-editortitleicon",
- click: () => {
- this.eventBus.off("click-editortitleicon", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On click-flashcard-action",
- click: () => {
- this.eventBus.on("click-flashcard-action", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off click-flashcard-action",
- click: () => {
- this.eventBus.off("click-flashcard-action", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-noneditableblock",
- click: () => {
- this.eventBus.on("open-noneditableblock", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-noneditableblock",
- click: () => {
- this.eventBus.off("open-noneditableblock", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On loaded-protyle-static",
- click: () => {
- this.eventBus.on("loaded-protyle-static", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off loaded-protyle-static",
- click: () => {
- this.eventBus.off("loaded-protyle-static", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On loaded-protyle-dynamic",
- click: () => {
- this.eventBus.on("loaded-protyle-dynamic", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off loaded-protyle-dynamic",
- click: () => {
- this.eventBus.off("loaded-protyle-dynamic", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On switch-protyle",
- click: () => {
- this.eventBus.on("switch-protyle", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off switch-protyle",
- click: () => {
- this.eventBus.off("switch-protyle", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On destroy-protyle",
- click: () => {
- this.eventBus.on("destroy-protyle", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off destroy-protyle",
- click: () => {
- this.eventBus.off("destroy-protyle", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-doctree",
- click: () => {
- this.eventBus.on("open-menu-doctree", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-doctree",
- click: () => {
- this.eventBus.off("open-menu-doctree", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-blockref",
- click: () => {
- this.eventBus.on("open-menu-blockref", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-blockref",
- click: () => {
- this.eventBus.off("open-menu-blockref", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-fileannotationref",
- click: () => {
- this.eventBus.on("open-menu-fileannotationref", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-fileannotationref",
- click: () => {
- this.eventBus.off("open-menu-fileannotationref", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-tag",
- click: () => {
- this.eventBus.on("open-menu-tag", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-tag",
- click: () => {
- this.eventBus.off("open-menu-tag", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-link",
- click: () => {
- this.eventBus.on("open-menu-link", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-link",
- click: () => {
- this.eventBus.off("open-menu-link", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-image",
- click: () => {
- this.eventBus.on("open-menu-image", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-image",
- click: () => {
- this.eventBus.off("open-menu-image", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-av",
- click: () => {
- this.eventBus.on("open-menu-av", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-av",
- click: () => {
- this.eventBus.off("open-menu-av", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-content",
- click: () => {
- this.eventBus.on("open-menu-content", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-content",
- click: () => {
- this.eventBus.off("open-menu-content", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-breadcrumbmore",
- click: () => {
- this.eventBus.on("open-menu-breadcrumbmore", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-breadcrumbmore",
- click: () => {
- this.eventBus.off("open-menu-breadcrumbmore", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-menu-inbox",
- click: () => {
- this.eventBus.on("open-menu-inbox", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-menu-inbox",
- click: () => {
- this.eventBus.off("open-menu-inbox", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On input-search",
- click: () => {
- this.eventBus.on("input-search", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off input-search",
- click: () => {
- this.eventBus.off("input-search", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On paste",
- click: () => {
- this.eventBus.on("paste", this.eventBusPaste);
- }
- }, {
- icon: "iconClose",
- label: "Off paste",
- click: () => {
- this.eventBus.off("paste", this.eventBusPaste);
- }
- }, {
- icon: "iconSelect",
- label: "On open-siyuan-url-plugin",
- click: () => {
- this.eventBus.on("open-siyuan-url-plugin", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-siyuan-url-plugin",
- click: () => {
- this.eventBus.off("open-siyuan-url-plugin", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On open-siyuan-url-block",
- click: () => {
- this.eventBus.on("open-siyuan-url-block", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off open-siyuan-url-block",
- click: () => {
- this.eventBus.off("open-siyuan-url-block", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On opened-notebook",
- click: () => {
- this.eventBus.on("opened-notebook", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off opened-notebook",
- click: () => {
- this.eventBus.off("opened-notebook", this.eventBusLog);
- }
- }, {
- icon: "iconSelect",
- label: "On closed-notebook",
- click: () => {
- this.eventBus.on("closed-notebook", this.eventBusLog);
- }
- }, {
- icon: "iconClose",
- label: "Off closed-notebook",
- click: () => {
- this.eventBus.off("closed-notebook", this.eventBusLog);
- }
- }]
- });
- menu.addSeparator();
- menu.addItem({
- icon: "iconSparkles",
- label: this.data[STORAGE_NAME].readonlyText || "Readonly",
- type: "readonly",
- });
- if (this.isMobile) {
- menu.fullscreen();
- } else {
- menu.open({
- x: rect.right,
- y: rect.bottom,
- isLeft: true,
- });
- }
- }
-
- private getEditor() {
- const editors = getAllEditor();
- if (editors.length === 0) {
- showMessage("please open doc first");
- return;
- }
- return editors[0];
- }
-}
+}
\ No newline at end of file
diff --git a/src/languagetool.ts b/src/languagetool.ts
new file mode 100644
index 0000000..bc4ee97
--- /dev/null
+++ b/src/languagetool.ts
@@ -0,0 +1,80 @@
+import {PluginSettings} from "@/settings";
+
+export type Suggestion = {
+ message: string
+ shortMessage: string
+ replacements: Array<{
+ value: string
+ type: string
+ }>
+ offset: number
+ length: number
+ context: {
+ text: string
+ offset: number
+ length: number
+ }
+ sentence: string
+ type: {
+ typeName: string
+ }
+ rule: {
+ id: string
+ description: string
+ issueType: string
+ category: {
+ id: string
+ name: string
+ }
+ isPremium: boolean
+ confidence: number
+ }
+ ignoreForIncompleteSentence: boolean
+ contextForSureMatch: number
+}
+
+export type Language = { name: string; code: string; longCode: string; }
+interface HTTPError extends Error {
+ status?: number;
+}
+
+export class LanguageTool {
+
+ public static async check(text: string, language: string, settings: PluginSettings): Promise+ ${this.plugin.i18nx.docMenu.status}: ${settings.enabled ? this.plugin.i18nx.docMenu.enabled : this.plugin.i18nx.docMenu.disabled}
+ ${this.plugin.i18nx.docMenu.language}: ${settings.language} + `, 5000, 'info') + void this.plugin.analytics.sendEvent('docmenu-click-info'); + } + }) + + menu.addItem({ + icon: 'toggle', + label: this.plugin.i18nx.docMenu.toggleSpellCheck, + click: async () => { + void this.plugin.analytics.sendEvent('docmenu-click-toggle'); + const attrs = await getBlockAttrs(docID) + const settings = await ProtyleHelpers.getDocumentSettings(docID, this.plugin.settingsUtil.get('enabledByDefault'), this.plugin.settingsUtil.get('defaultLanguage')) + if(settings == null) { + void this.plugin.analytics.sendEvent('docmenu-click-info-notebook'); + showMessage(this.plugin.i18nx.errors.notImplementedNotebookSettings, 5000, 'info') + return + } + attrs[SpellCheckPlugin.ENABLED_ATTR] = settings.enabled ? 'false' : 'true' + await setBlockAttrs(docID, attrs) + location.reload() + } + }) + + menu.addItem({ + icon: 'language', + label: this.plugin.i18nx.docMenu.setDocumentLanguage, + click: async (_, ev: MouseEvent) => { + void this.plugin.analytics.sendEvent('docmenu-click-setlang-1'); + const languages = await LanguageTool.getLanguages(
-
-
-
-
-
diff --git a/src/settings.ts b/src/settings.ts
new file mode 100644
index 0000000..39d80fc
--- /dev/null
+++ b/src/settings.ts
@@ -0,0 +1,159 @@
+import {SettingUtils} from "@/libs/setting-utils";
+import {showMessage} from 'siyuan';
+import {LanguageTool} from "@/languagetool";
+import SpellCheckPlugin from "@/index";
+
+export type PluginSettings = {
+ server: string
+ username: string
+ apiKey: string
+ picky: boolean
+ motherTongue: string
+ preferredVariants: string
+ enabledByDefault: boolean
+ defaultLanguage: string
+ preferredLanguages: string
+ analytics: boolean
+}
+
+
+export class Settings {
+
+ static async init(plugin: SpellCheckPlugin): Promise
- { console.debug("Click:", detail.key); }}
- >
-
- { console.debug("Click:", detail.key); }}
- >
-
-
-
- 💡 This is our default settings.
-
-