From 24ea370d9607ec2bf5948a2de9d457d2a9ed5ebe Mon Sep 17 00:00:00 2001 From: lowit Date: Sun, 13 Apr 2025 19:24:28 +0300 Subject: [PATCH] chore: add readme --- README.md | 121 ++++++++++++++++++++++-------------------------------- 1 file changed, 48 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index c773152..16c8561 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,69 @@ -# Obsidian Sample Plugin +# Obsidian Tasks Cleaner Plugin -This is a sample plugin for Obsidian (https://obsidian.md). +๐Ÿงน **Tasks Cleaner** is a plugin for [Obsidian](https://obsidian.md) that helps you automatically remove old completed tasks from your Markdown notes. It's perfect for users who track tasks with completion dates and want to keep their notes tidy. -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 plugin is fully compatible with the [Tasks plugin](https://github.com/obsidian-tasks-group/obsidian-tasks). But it can also work separately. -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. +## ๐Ÿ›  Features -## First time developing plugins? +- Detect completed tasks using a customizable regular expression. +- Delete tasks older than a specified number of days. +- Remove associated descriptions (indented lines under the task). +- Filter which files to clean based on filename patterns. +- Confirmation modal before deletion with a task summary. +- Fully configurable via plugin settings. -Quick starting guide for new plugin devs: +## ๐Ÿ“ฅ Installation -- 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. +Follow the steps below to install Tasks Cleaner. -## Releasing new releases +- Search for "Tasks Cleaner" in Obsidian's community plugins browser +- Enable the plugin in your Obsidian settings (find "Tasks Cleaner" under "Community plugins"). +- Check the settings. It makes sense to set the global filter early on (if you want one). -- 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. +## โš™๏ธ Settings -> 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` +Open **Settings โ†’ Community Plugins โ†’ Tasks Cleaner** to configure the plugin: -## Adding your plugin to the community plugin list +- **Delete tasks older than (days):** + Specifies how many days old a completed task must be to qualify for deletion. + Default: `7` -- 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. +- **Task pattern (Regex):** + Regular expression used to detect completed tasks. + Must contain a capture group for the completion date (e.g. `(\d{4}-\d{2}-\d{2})`). + Default: `- \[x\].*?โœ…\s*(\d{4}-\d{2}-\d{2})` -## How to use +- **Filename filter:** + If set, only files whose names contain this string will be scanned. + Leave empty to scan **all** Markdown files. -- 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. +## โœ… Task Format -## Manually installing the plugin +The plugin looks for completed tasks that include a completion date in this format: -- 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" -} +```markdown +- [x] Fixed the bug โœ… 2024-12-01 + This issue only appears in Firefox + Additional explanation ``` -If you have multiple URLs, you can also do: +If the completion date is older than the threshold, the task and all indented lines below it will be deleted. -```json -{ - "fundingUrl": { - "Buy Me a Coffee": "https://buymeacoffee.com", - "GitHub Sponsor": "https://github.com/sponsors", - "Patreon": "https://www.patreon.com/" - } -} +## ๐Ÿ’ก Example + +Given a file TODO Project.md: + +```markdown +- [x] Fix bug โœ… 2024-12-01 + This happens in Firefox +- [ ] Implement feature ``` -## API Documentation +If the threshold is 7 days, the first task and its description will be removed after confirmation. -See https://github.com/obsidianmd/obsidian-api +## ๐Ÿ›ก Safe Deletion + +Before deleting, the plugin displays a confirmation modal showing how many tasks will be removed from each file. Nothing is deleted until you confirm. + +Keep your notes clean and focused โ€” with Tasks Cleaner โœจ