From 973ad11daa89e98bfdee07fa0ffcc3526bf8519b Mon Sep 17 00:00:00 2001 From: NoRFoLK Date: Fri, 17 Jan 2025 17:53:43 +0400 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D1=82?= =?UTF-8?q?=D1=8C=20README=20=D0=B8=20=D0=BC=D0=B0=D0=BD=D0=B8=D1=84=D0=B5?= =?UTF-8?q?=D1=81=D1=82=20=D0=BF=D0=BB=D0=B0=D0=B3=D0=B8=D0=BD=D0=B0;=20?= =?UTF-8?q?=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D1=82=D1=8C=20=D1=84=D1=83?= =?UTF-8?q?=D0=BD=D0=BA=D1=86=D0=B8=D0=BE=D0=BD=D0=B0=D0=BB=D1=8C=D0=BD?= =?UTF-8?q?=D0=BE=D1=81=D1=82=D1=8C=20=D0=B4=D0=BB=D1=8F=20=D0=BF=D0=BE?= =?UTF-8?q?=D0=B8=D1=81=D0=BA=D0=B0=20=D1=82=D0=B5=D0=B3=D0=BE=D0=B2=20?= =?UTF-8?q?=D0=B8=20=D0=BF=D0=B5=D1=80=D0=B5=D0=BC=D0=B5=D1=89=D0=B5=D0=BD?= =?UTF-8?q?=D0=B8=D1=8F=20=D1=84=D0=B0=D0=B9=D0=BB=D0=BE=D0=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 94 ----------------------------------- main.ts | 134 +++++++++++++++++++++++++++++++------------------- manifest.json | 4 +- 3 files changed, 86 insertions(+), 146 deletions(-) diff --git a/README.md b/README.md index c773152..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,94 +0,0 @@ -# Obsidian Sample Plugin - -This is a sample plugin for Obsidian (https://obsidian.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. - -## 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. - -## Manually installing the plugin - -- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. - -## 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\` - -## Funding URL - -You can include funding URLs where people who use your plugin can financially support it. - -The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file: - -```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 diff --git a/main.ts b/main.ts index f790773..7cf794f 100644 --- a/main.ts +++ b/main.ts @@ -1,4 +1,4 @@ -import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian'; +import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting, Tasks, TFile } from 'obsidian'; // Не забудьте переименовать эти классы и интерфейсы! @@ -19,8 +19,13 @@ export default class MyPlugin extends Plugin { // Создает иконку в левой боковой панели. const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => { // Вызывается при клике на иконку. - this.findTagsInNote(); - new Notice('This is a notice!'); + this.findTagsInNote().then(tags => { + if (tags) { + new Notice('Tags: ' + tags.join(', ')); + } else { + new Notice('No tags found.'); + } + }); }); // Добавляет дополнительные стили к иконке. ribbonIconEl.addClass('my-plugin-ribbon-class'); @@ -29,40 +34,22 @@ export default class MyPlugin extends Plugin { // const statusBarItemEl = this.addStatusBarItem(); // statusBarItemEl.setText('Status Bar Text'); - // Добавляет простую команду, которую можно вызвать откуда угодно. - this.addCommand({ - id: 'open-sample-modal-simple', - name: 'Open sample modal (simple)', - callback: () => { - new SampleModal(this.app).open(); - } - }); // Добавляет команду для редактора, которая может выполнять операции с текущим экземпляром редактора. 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.addCommand({ - id: 'open-sample-modal-complex', - name: 'Open sample modal (complex)', - checkCallback: (checking: boolean) => { - // Условия для проверки. - const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView); - if (markdownView) { - // Если checking равно true, мы просто проверяем, может ли команда быть выполнена. - // Если checking равно false, мы выполняем операцию. - if (!checking) { - new SampleModal(this.app).open(); - } - - // Эта команда появится в палитре команд только если функция проверки возвращает true. - return true; - } + id: 'scan-root-folder', + name: 'Scan notes in root folder', + callback: async () => { + const fileList = await this.scanFolder(); + fileList.forEach((file) => { + const tagsForScan = ['art', '🍆'] + const tags = this.findTagsInNote(file); + tags.then((tags)=>{ + if (tagsForScan.every(tag => (tags ?? []).includes(tag))) { + console.log('FOUND', file.name); + this.moveFileToFolder(file, 'temp') + } + }) + }); } }); @@ -72,7 +59,7 @@ export default class MyPlugin extends Plugin { // Если плагин подключает глобальные события DOM (на частях приложения, которые не принадлежат этому плагину), // использование этой функции автоматически удалит обработчик события при отключении плагина. this.registerDomEvent(document, 'click', (evt: MouseEvent) => { - console.log('click', evt); + // console.log('click', evt); }); // При регистрации интервалов эта функция автоматически очистит интервал при отключении плагина. @@ -108,25 +95,72 @@ export default class MyPlugin extends Plugin { * * @returns {Promise} Обещание, которое разрешается, когда теги найдены и отображены. */ - async findTagsInNote() { - const activeView = this.app.workspace.getActiveViewOfType(MarkdownView); - if (!activeView) return; + async findTagsInNote(file?: TFile) { + let activeFile = file; - const content = activeView.getViewData(); - console.log('CONTENT', content); + if (!activeFile) { + const activeView = this.app.workspace.getActiveViewOfType(MarkdownView); + if (!activeView) { + return; + } + if (activeView.file) { + activeFile = activeView.file; + } + } - const file = activeView.file; - if (!file) return; + if (!activeFile) { + return; + } - const fileCache = this.app.metadataCache.getFileCache(file); - const tags = [ - ...(fileCache?.frontmatter?.tags.map(tag => tag.replace('#', '')) || []), - ...(fileCache?.tags?.map(tag => tag.tag.replace('#', '')) || []) - ]; + const content = await this.app.vault.read(activeFile); + // console.log('CONTENT \n', content); - console.log('TAGS', tags); - new Notice(`Found tags: ${tags.join(', ')}`); + const fileCache = this.app.metadataCache.getFileCache(activeFile); + // console.log('FILECACHE', fileCache); + + const frontmatterTags = (fileCache?.frontmatter?.tag || []).map((tag) => { + return tag ? tag.replace(/#/g, '') : ''; + }); + + const fileCacheTags = (fileCache?.tags || []).map((tag) => { + return tag.tag ? tag.tag.replace(/#/g, '') : ''; + }); + + let tags = [...new Set([...frontmatterTags, ...fileCacheTags])]; + // console.log('frontmatterTags', frontmatterTags); + // console.log('fileCacheTags', fileCacheTags); + // console.log('TAGS', tags); + // new Notice(`Found tags: ${tags.join(', ')}`); + return tags; } + + async scanFolder(path?: string, recursive: boolean = true) { + recursive = false; + if (!path || path === '/') { + path = ''; + } + const files = this.app.vault.getMarkdownFiles(); + const filteredFiles = files.filter((file) => { + if (recursive) { + return file.path.startsWith(path); + } else { + return file.path.startsWith(path) && file.path.split('/').length === path.split('/').length; + } + }) + return filteredFiles; + } + + async moveFileToFolder(file: TFile, targetFolder: string) { + try { + const newPath = `${targetFolder}/${file.name}`; + await this.app.vault.rename(file, newPath); + console.log(`Moved ${file.name} to ${newPath}`); + } + catch (e) { + console.error(`Failed to move file ${file.name} to ${targetFolder}` ,e); + } + } + } class SampleModal extends Modal { diff --git a/manifest.json b/manifest.json index f8033c1..5624aef 100644 --- a/manifest.json +++ b/manifest.json @@ -1,6 +1,6 @@ { - "id": "ZZZ-sample-plugin", - "name": "ZZSample Plugin", + "id": "AAA-sample-plugin", + "name": "AA Sample Plugin", "version": "1.0.0", "minAppVersion": "0.15.0", "description": "Demonstrates some of the capabilities of the Obsidian API.",