obsidian-plugin/noheartpen_obsidian-monokakido-copilot-plugin
1
0
Fork 0
mirror of https://github.com/noheartpen/obsidian-monokakido-copilot-plugin.git synced 2026-07-22 05:48:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update: 0.0.1

Browse source
This commit is contained in:
noheartpen 2025-04-27 19:44:24 +09:00
parent 1e58635cce
commit 27b3238481
14 changed files with 2943 additions and 239 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
.github/workflows/release.yml vendored Normal file
View file

@ -0,0 +1,35 @@
name: Release Obsidian plugin
on:
push:
tags:
- "*"
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: "18.x"
- name: Build plugin
run: |
npm install
npm run build
- name: Create release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
tag="${GITHUB_REF#refs/tags/}"
gh release create "$tag" \
--title="$tag" \
--draft \
main.js manifest.json styles.css

22
LICENSE
View file

@ -1,5 +1,21 @@
Copyright (C) 2020-2025 by Dynalist Inc.
MIT License
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
Copyright (c) 2025 NoHeartPen
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

29
README.ja.md Normal file
View file

@ -0,0 +1,29 @@
# Obsidian Monokakido Copilot Plugin
`Option`キーをダブルクリックすると、[辞書 by 物書堂](https://www.monokakido.jp/ja/dictionaries/app/index.html) で検索します。
## 利用方法
必要なのは`Option`キーを**ダブル**押すだけだ。
## インストール方法
### From within Obsidian
Obsidian v0.15.0+ から、Obsidian 内でこのプラグインを有効にするには、以下のようにします：
1. 設定からコミュニティプラグインを開きます。
2. セーフモードがオフであることを確認します。
3. コミュニティプラグインの閲覧をクリックします。
4. このプラグインを検索します。
5. インストールをクリック。
6. インストールが完了したら、有効化を押すことで、パッチは使用可能な状態になります。
### 手動でプラグインをインストール
1. GitHub リポジトリの Releases から Latest Release をダウンロードします。
2. vault の plugins フォルダ `.<vault>/.obsidian/plugins/monokakido-copilot` にファイルを置きます。
3. Obsidian をリロードします。
4. セーフモードについてプロンプトが表示されたら、セーフモードを無効にしてプラグインを有効にすることができます。それ以外の場合は、設定からコミュニティプラグインに移動し、セーフモードがオフになっていることを確認し、そこからプラグインを有効にしてください。
> 注意： .obsidian フォルダは隠されている可能性があります。macOS では、Command+Shift+Dot を押すと、Finder でフォルダを表示できるはずです。

101
README.md
View file

@ -1,94 +1,31 @@
# Obsidian Sample Plugin
# Obsidian Monokakido Copilot Plugin
This is a sample plugin for Obsidian (https://obsidian.md).
[日本語版](./README.ja.md)
This project uses TypeScript to provide type checking and documentation.
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
This sample plugin demonstrates some of the basic functionality the plugin API can do.
- Adds a ribbon icon, which shows a Notice when clicked.
- Adds a command "Open Sample Modal" which opens a Modal.
- Adds a plugin setting tab to the settings page.
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
## First time developing plugins?
Quick starting guide for new plugin devs:
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
## Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
## Adding your plugin to the community plugin list
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
Double press the `Option` key to search with [Dictionaries by Monokakido](https://www.monokakido.jp/en/dictionaries/app/index.html).
## How to use
- Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
All you need is just **double** press the `Option` key.
## Manually installing the plugin
## How to Install
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
### From within Obsidian
## Improve code quality with eslint (optional)
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint`
- To use eslint to analyze this project use this command:
- `eslint main.ts`
- eslint will then create a report with suggestions for code improvement by file and line number.
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
- `eslint .\src\`
From Obsidian v0.9.8+, you can activate this plugin within Obsidian by doing the following:
## Funding URL
1. Open Settings > Third-party plugin
2. Make sure Safe mode is **off**
3. Click Browse community plugins
4. Search for "Monokakido Copilot"
5. Click Install
6. Once installed, close the community plugins window and activate the newly installed plugin
You can include funding URLs where people who use your plugin can financially support it.
### Manually installing the plugin From GitHub
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
1. Download the Latest Release from the Releases section of the GitHub Repository
2. Put files to your vault's plugins folder: `<vault>/.obsidian/plugins/monokakido-copilot`
3. Reload Obsidian
4. If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.
```json
{
"fundingUrl": "https://buymeacoffee.com"
}
```
If you have multiple URLs, you can also do:
```json
{
"fundingUrl": {
"Buy Me a Coffee": "https://buymeacoffee.com",
"GitHub Sponsor": "https://github.com/sponsors",
"Patreon": "https://www.patreon.com/"
}
}
```
## API Documentation
See https://github.com/obsidianmd/obsidian-api
> Note: The .obsidian folder may be hidden. On macOS you should be able to press Command+Shift+Dot to show the folder in Finder.

10
esbuild.config.mjs
View file

@ -2,20 +2,19 @@ import esbuild from "esbuild";
import process from "process";
import builtins from "builtin-modules";
const banner =
`/*
const banner = `/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin
*/
`;
const prod = (process.argv[2] === "production");
const prod = process.argv[2] === "production";
const context = await esbuild.context({
banner: {
js: banner,
},
entryPoints: ["main.ts"],
entryPoints: ["./src/main.ts"],
bundle: true,
external: [
"obsidian",
@ -31,7 +30,8 @@ const context = await esbuild.context({
"@lezer/common",
"@lezer/highlight",
"@lezer/lr",
...builtins],
...builtins,
],
format: "cjs",
target: "es2018",
logLevel: "info",

134
main.ts
View file

@ -1,134 +0,0 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
mySetting: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
}
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
async onload() {
await this.loadSettings();
// This creates an icon in the left ribbon.
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
// Called when the user clicks the icon.
new Notice('This is a notice!');
});
// Perform additional things with the ribbon
ribbonIconEl.addClass('my-plugin-ribbon-class');
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
const statusBarItemEl = this.addStatusBarItem();
statusBarItemEl.setText('Status Bar Text');
// This adds a simple command that can be triggered anywhere
this.addCommand({
id: 'open-sample-modal-simple',
name: 'Open sample modal (simple)',
callback: () => {
new SampleModal(this.app).open();
}
});
// This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
id: 'sample-editor-command',
name: 'Sample editor command',
editorCallback: (editor: Editor, view: MarkdownView) => {
console.log(editor.getSelection());
editor.replaceSelection('Sample Editor Command');
}
});
// This adds a complex command that can check whether the current state of the app allows execution of the command
this.addCommand({
id: 'open-sample-modal-complex',
name: 'Open sample modal (complex)',
checkCallback: (checking: boolean) => {
// Conditions to check
const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
if (markdownView) {
// If checking is true, we're simply "checking" if the command can be run.
// If checking is false, then we want to actually perform the operation.
if (!checking) {
new SampleModal(this.app).open();
}
// This command will only show up in Command Palette when the check function returns true
return true;
}
}
});
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
// Using this function will automatically remove the event listener when this plugin is disabled.
this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
console.log('click', evt);
});
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
this.registerInterval(window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000));
}
onunload() {
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async saveSettings() {
await this.saveData(this.settings);
}
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
}
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
}
onClose() {
const {contentEl} = this;
contentEl.empty();
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
constructor(app: App, plugin: MyPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const {containerEl} = this;
containerEl.empty();
new Setting(containerEl)
.setName('Setting #1')
.setDesc('It\'s a secret')
.addText(text => text
.setPlaceholder('Enter your secret')
.setValue(this.plugin.settings.mySetting)
.onChange(async (value) => {
this.plugin.settings.mySetting = value;
await this.plugin.saveSettings();
}));
}
}

14
manifest.json
View file

@ -1,11 +1,11 @@
{
"id": "sample-plugin",
"name": "Sample Plugin",
"version": "1.0.0",
"id": "monokakido-copilot",
"name": "Monokakido Copilot",
"version": "0.0.1",
"minAppVersion": "0.15.0",
"description": "Demonstrates some of the capabilities of the Obsidian API.",
"author": "Obsidian",
"authorUrl": "https://obsidian.md",
"fundingUrl": "https://obsidian.md/pricing",
"description": "During editing, simply double-press the option key to search with the Dictionaries by Monokakido.",
"author": "NoHeartPen",
"authorUrl": "https://github.com/NoHeartPen",
"fundingUrl": "https://ko-fi.com/noheartpen",
"isDesktopOnly": false
}

2397
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

182
src/main.ts Normal file
View file

@ -0,0 +1,182 @@
import { App, Editor, MarkdownView, Notice, Plugin, PluginSettingTab, Setting, TFile } from 'obsidian';
import { searchWordAtCursor } from './utils/cursor-word-utils';
/**
* 调试模式开关
*/
const isDebug = false;
/**
* 调试日志
*/
export function debugLog(...args: string[]) {
if (isDebug) {
console.log(...args);
}
}
interface PluginSettingsInterface {
/**
* 调用辞書的 URL
*/
dictURL: string;
/**
* 是否调用 URL Scheme 查询
*/
searchByOpenUrl: boolean;
/**
* 形态素分析 API
*/
morphemeAnalysisAPI: string;
/**
* 双击指定的按键触发搜索
*/
doubleClickedKey: string;
/**
* 查词历史记录文件路径
*/
historyFilePath: string;
}
export const PLUGIN_SETTINGS: PluginSettingsInterface = {
// 默认使用 物書堂
dictURL: 'mkdictionaries:///?text=<text_to_search>',
// 默认不使用剪贴板查询模式
searchByOpenUrl: false,
// 如果你使用源码自己在本地部署请修改成 <http://127.0.0.1:8000/>
// 形态素分析的源码 <https://github.com/NoHeartPen/fast-mikann-api>
morphemeAnalysisAPI: 'https://www.nonjishokei.org/',
// 默认按键为 Option 键（在 Windows 上是 Alt 键）
doubleClickedKey: 'Alt',
// 查词历史记录文件路径
historyFilePath: 'MonoKakido Copilot History.md'
}
export default class MonokakidoCopilotPlugin extends Plugin {
settings: PluginSettingsInterface;
private lastKeyupTime = 0;
private lastKeyWasDouble: boolean
/**
* 双击监听指定按键时触发搜索
* @param event
* @param app
*/
private searchOnDoublePress(event: KeyboardEvent, app: App) {
const key = event.key;
if (key !== PLUGIN_SETTINGS.doubleClickedKey) {
this.lastKeyupTime = 0;
return;
}
if (this.lastKeyWasDouble) {
this.lastKeyWasDouble = false;
return;
}
if (Date.now() - this.lastKeyupTime < 500) {
this.lastKeyupTime = 0;
searchWordAtCursor();
}
this.lastKeyupTime = Date.now();
}
/**
* 双击指定按键后清空计时器
*/
private clearTimerOnDoublePress(event: KeyboardEvent) {
if (event.key !== PLUGIN_SETTINGS.doubleClickedKey) {
this.lastKeyWasDouble = true;
}
}
async onload() {
await this.loadSettings();
this.registerDomEvent(window, 'keyup', (event) => this.searchOnDoublePress(event, this.app));
this.registerDomEvent(window, 'keydown', (event) => this.clearTimerOnDoublePress(event));
this.addRibbonIcon('file-clock', 'Monokakido Copilot history', () => {
this.openHistoryFile();
});
this.registerCommands();
this.addSettingTab(new SettingTab(this.app, this));
}
private registerCommands() {
this.addCommand({
id: 'open-history',
name: 'Open history',
callback: () => {
this.openHistoryFile();
},
});
this.addCommand({
id: 'search-cursor-word',
name: 'Search Cursor word',
editorCallback: async (editor: Editor, view: MarkdownView) => {
searchWordAtCursor();
},
});
}
private openHistoryFile() {
const vault = this.app.vault;
const filePath = PLUGIN_SETTINGS.historyFilePath;
const file = vault.getAbstractFileByPath(filePath);
if (file instanceof TFile) {
this.app.workspace.openLinkText(filePath, '', true);
} else {
// FIXME 封装，因为有可能在写入笔记时文件又被删除了
vault.create(
filePath,
'# MonoKakido Copilot history\n\nThis document is used for history.'
);
new Notice(`単語メモ帳は: ${filePath}`);
this.app.workspace.openLinkText(filePath, '', true);
}
}
async loadSettings() {
this.settings = Object.assign({}, PLUGIN_SETTINGS, await this.loadData());
PLUGIN_SETTINGS.dictURL = this.settings.dictURL;
}
async saveSettings() {
await this.saveData(this.settings);
PLUGIN_SETTINGS.dictURL = this.settings.dictURL;
}
}
class SettingTab extends PluginSettingTab {
plugin: MonokakidoCopilotPlugin;
constructor(app: App, plugin: MonokakidoCopilotPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const { containerEl } = this;
containerEl.empty();
new Setting(containerEl)
.setName('Dict URL Scheme')
.setDesc('')
.addText(text => text
.setPlaceholder(PLUGIN_SETTINGS.dictURL)
.setValue(this.plugin.settings.dictURL)
.onChange(async (value) => {
this.plugin.settings.dictURL = value;
PLUGIN_SETTINGS.dictURL = value;
await this.plugin.saveSettings();
}));
}
}

59
src/utils/analyze-word-utils.ts Normal file
View file

@ -0,0 +1,59 @@
import { PLUGIN_SETTINGS, debugLog } from 'src/main';
/**
* 获取光标处附近的英文单词
* @param context 光标所在的上下文
* @param cursorIndex 光标位置
* @returns 光标附近的英文单词，如果没有则返回空字符串
*/
function getCursorEnglishWord(context: string, cursorIndex: number): string {
let start: number = cursorIndex;
let end: number = cursorIndex;
// 向前扫描，找到单词起点
while (start > 0 && /\S/.test(context[start - 1])) {
start--;
}
// 向后扫描，找到单词终点
while (end < context.length && /\S/.test(context[end])) {
end++;
}
// 提取并返回光标附近的单词
return context.substring(start, end).trim();
}
/**
* 分析光标附近的单词
* @param context 光标所在的上下文
* @param cursorIndex 光标的位置
* @returns 如果含有假名那么调用 API 分析光标附近单词的辞书形，反之直接借助空格判断
*/
export async function analyzeCursorWord(context: string, cursorIndex: number): Promise<string | undefined> {
// 如果不包含任何假名，那么直接通过空格推导
if (!context.match(/[\u3040-\u309F\u30A0-\u30FF]/)) {
return getCursorEnglishWord(context, cursorIndex);
}
const response = await fetch(PLUGIN_SETTINGS.morphemeAnalysisAPI, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
sentence: context,
cursor_index: cursorIndex
})
});
if (!response.ok) {
console.error('HTTP error:', response.status);
return;
}
const data = await response.json();
// 返回的数据格式： {jishokei: 'かける'}
debugLog(data);
const cursorWords = data.jishokei;
return cursorWords;
}

92
src/utils/cursor-word-utils.ts Normal file
View file

@ -0,0 +1,92 @@
import { MarkdownView, Notice, Platform } from 'obsidian';
import { debugLog, PLUGIN_SETTINGS } from '../main';
import { openDictUrl, write2ClipBoard } from './open-dict-utils';
import { analyzeCursorWord } from './analyze-word-utils';
import { writeToHistory } from './history-utils';
/**
* 搜索光标附近的单词
*/
export async function searchWordAtCursor() {
new Notice('分析中、少々お待ちください。');
try {
const cursorWord = await getCursorWord();
if (!cursorWord) {
return;
}
doSearch(cursorWord);
} catch (error) {
console.error('Error getting cursor word:', error);
}
}
/**
* 执行搜索动作
* @param word 推导的辞书形
*/
export async function doSearch(word: string) {
new Notice(`物書堂で「${word}」を引きました`);
if (Platform.isMobileApp) {
// 在移动设备上总是通过 URL 自动打开
PLUGIN_SETTINGS.searchByOpenUrl = true;
}
if (PLUGIN_SETTINGS.searchByOpenUrl === true) {
openDictUrl(word);
} else {
await write2ClipBoard(word);
}
}
/**
* 获取光标所在行的上下文和索引，如果当前无有效 Markdown 编辑器视图，则返回 null。
* @returns {object|null} 返回一个对象，包含以下属性：
* - context {string} 当前光标所在行的文本内容
* - cursorIndex {number} 当前光标在该行内的字符索引（从0开始）
*/
function getContextAndIndex(): { context: string; cursorIndex: number; } | null {
const view = this.app.workspace.getActiveViewOfType(MarkdownView);
if (!view) {
console.error('No active MarkdownView found.');
return null;
}
const editor = view.editor;
/**
* 用户想查单词所在的上下文，用于形态素分析
*/
let context = "";
/**
* 光标在上下文中的位置，用于计算形态素分析结果中最靠近光标的结果
*/
let cursorIndex = 0;
const selection = editor.getSelection();
if (selection === "") {
// 如果用户没有选中文字，那么获取光标所在行的所有文本作为上下文
const cursor = editor.getCursor();
context = editor.getLine(cursor.line);
cursorIndex = cursor.ch;
} else {
context = selection;
cursorIndex = 0;
}
return { context, cursorIndex };
}
/**
* 通过上下文和光标索引获取光标附近的单词的辞书形
* 并将上下文和单词保存到历史记录
*/
export async function getCursorWord(): Promise<string | undefined> {
const context = getContextAndIndex()?.context ?? "";
const cursorIndex = getContextAndIndex()?.cursorIndex ?? 0;
debugLog(`context: ${context}, cursorIndex: ${cursorIndex}`);
const word = await analyzeCursorWord(context, cursorIndex);
debugLog(`cursorWord: ${word}`);
if (word !== undefined) {
writeToHistory(PLUGIN_SETTINGS.historyFilePath, context, word);
}
return word;
}

58
src/utils/history-utils.ts Normal file
View file

@ -0,0 +1,58 @@
import { normalizePath, TFile } from 'obsidian';
import { debugLog } from 'src/main';
/**
* 移除字符串中的常见 Markdown 语法和 Obsidian 高亮标记，
* 返回去除格式后的纯文本内容。
* @param text 输入的可能包含 Markdown 格式的文本
* @returns 去除 Markdown 格式后的纯文本
*/
function removeMarkdownSyntax(text: string): string {
return text
// 移除加粗 **text**
.replace(/\*\*(.*?)\*\*/g, '$1')
// 移除斜体 *text* or _text_
.replace(/(\*|_)(.*?)\1/g, '$2')
// 移除行内 `code`
.replace(/`([^`]+)`/g, '$1')
// Obsidian 专用高亮语法 ==text==
.replace(/==(.+?)==/g, '$1')
// 块引用 > blockquote
.replace(/^>\s?/gm, '')
// 标题 # Headings、 列表 -, +, *
.replace(/^[#*-]\s?/gm, '')
.trim();
}
/**
* 将查词历史记录写入到指定的文件中
* @param filePath 保存查词历史的文件路径
* @param context 查词时的上下文
* @param word 查询的单词
*/
export async function writeToHistory(filePath: string, context: string, word: string): Promise<void> {
const normalizedFilePath = normalizePath(filePath);
const activeFile = this.app.workspace.getActiveFile();
if (!activeFile) {
throw new Error('No active file found. Cannot create back link.');
}
/**
* 添加所查单词的文件作为反向链接
*/
const backLink = `[[${activeFile.basename}]]`;
context = removeMarkdownSyntax(context);
const vault = this.app.vault;
const file = vault.getAbstractFileByPath(normalizedFilePath);
const noteContent = `\n> ${context} ${backLink}\n> ${word}\n> メモ：\n`;
if (file instanceof TFile) {
await vault.append(file, noteContent);
} else {
await vault.create(filePath, noteContent);
}
debugLog(`Content written to file: ${filePath}`);
}

41
src/utils/open-dict-utils.ts Normal file
View file

@ -0,0 +1,41 @@
import { debugLog, PLUGIN_SETTINGS } from "src/main";
/**
* 将要查的单词写入剪贴板
* @param word 需要要写入剪贴板的单词
*/
export async function write2ClipBoard(word: string) {
try {
await navigator.clipboard.writeText(word);
debugLog(`write 「${word}」 to clipboard successfully`);
} catch (err) {
console.error('can not write to clipboard :', err);
}
}
/**
* 通过调用 URL Scheme 打开辞书
* @param word 用于拼接 URL Scheme 的单词
*/
export function openDictUrl(word: string) {
let dictUrl = "";
debugLog(`openDictUrl: ${PLUGIN_SETTINGS.dictURL}`);
if (PLUGIN_SETTINGS.dictURL.includes("<text_to_search>")) {
// Monokakido URL Scheme is end with "<text_to_search>".
debugLog(`defaultDictURL is ${PLUGIN_SETTINGS.dictURL}, includes <text_to_search>`);
dictUrl = PLUGIN_SETTINGS.dictURL.replace("<text_to_search>", word);
} else if (PLUGIN_SETTINGS.dictURL.includes("<文字列>")) {
debugLog(`defaultDictURL is ${PLUGIN_SETTINGS.dictURL}, includes <文字列>`);
dictUrl = PLUGIN_SETTINGS.dictURL.replace("<文字列>", word);
} else if (PLUGIN_SETTINGS.dictURL.includes("{w}")) {
// 通用的网址链接{w}
debugLog(`defaultDictURL is ${PLUGIN_SETTINGS.dictURL}, includes {w}`);
dictUrl = PLUGIN_SETTINGS.dictURL.replace("{w}", word);
}
else {
// 直接在 URL Scheme 末尾拼接上单词
debugLog(`defaultDictURL is ${PLUGIN_SETTINGS.dictURL}`);
dictUrl = PLUGIN_SETTINGS.dictURL + word;
}
window.open(dictUrl, '_blank');
}

8
styles.css
View file

@ -1,8 +0,0 @@
/*
This CSS file will be included with your plugin, and
available in the app when your plugin is enabled.
If your plugin does not need CSS, delete this file.
*/