From a2fbbeae5462d970fd9c9d5f68d8a3109403522f Mon Sep 17 00:00:00 2001 From: Nymbo <129332110+Nymbo@users.noreply.github.com> Date: Tue, 12 May 2026 16:50:00 -0400 Subject: [PATCH] Prepare plugin for community submission --- .gitignore | 1 + README.md | 44 ++++++++++++++++++++++++++++++++++---------- manifest.json | 6 +++--- package-lock.json | 5 +++-- package.json | 4 ++-- versions.json | 3 ++- 6 files changed, 45 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 41e19ab..5c2a50c 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ main.js *.map .obsidian/ .DS_Store +data.json diff --git a/README.md b/README.md index d15df24..6eb0f31 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ # Copy Flasher -Copy Flasher is an Obsidian plugin that briefly highlights copied text so you get visual confirmation that the copy action worked. +Copy Flasher highlights text when you copy it in Obsidian, giving a clear visual confirmation that the copy action worked. + +## Features + +- Highlights copied editor text immediately when you press `Ctrl+C` or `Cmd+C`. +- Keeps the highlight visible while the copy shortcut is held. +- Supports copied text in reading view and other rendered Obsidian content. +- Includes settings for color, opacity, corner radius, rendered-text highlighting, and fallback timing. +- Works without external services, network requests, telemetry, or file-system access. + +## Usage + +Select text in Obsidian and copy it. The selected text is highlighted while the copy shortcut is held, then returns to normal when the keys are released. + +For mouse or menu-based copy actions, Copy Flasher uses a short configurable fallback duration because there is no keyboard release event to observe. + +## Settings + +Open **Settings -> Community plugins -> Copy Flasher** to customize: + +- Highlight color +- Editor opacity +- Rendered text opacity +- Corner radius +- Whether rendered Markdown text is highlighted +- Mouse/menu copy duration +- Lost-keyup fallback duration + +## Privacy and permissions + +Copy Flasher runs entirely inside Obsidian. It does not collect data, send network requests, read your clipboard contents, or access files directly. ## Development @@ -22,19 +52,13 @@ Watch for changes during development: npm run dev ``` -For local testing, this repository can be linked into a development vault at: - -```text -P:\Code Repos\Obs-Dev-Vault\Obs-Dev-Vault\.obsidian\plugins\copy-flasher -``` - Obsidian loads community plugins from `.obsidian/plugins/`. The folder name should match `manifest.json`'s `id`, and Obsidian expects the built `main.js`, `manifest.json`, and optional `styles.css` at that folder root. -After changing `manifest.json`, restart Obsidian so it re-reads the plugin metadata. After changing TypeScript, rebuild and reload the plugin, or use a hot-reload plugin in your development vault. +After changing `manifest.json`, restart Obsidian so it re-reads the plugin metadata. After changing TypeScript, rebuild and reload the plugin. -## Release Files +## Release files -Community plugin releases typically include: +Each GitHub release should include these assets: - `main.js` - `manifest.json` diff --git a/manifest.json b/manifest.json index e7886f7..5eb631e 100644 --- a/manifest.json +++ b/manifest.json @@ -1,9 +1,9 @@ { "id": "copy-flasher", "name": "Copy Flasher", - "version": "0.1.2", - "minAppVersion": "0.15.0", - "description": "Briefly highlights text copied inside Obsidian.", + "version": "0.1.3", + "minAppVersion": "0.16.0", + "description": "Highlights copied text in Obsidian.", "author": "Nymbo", "authorUrl": "https://github.com/Nymbo", "isDesktopOnly": false diff --git a/package-lock.json b/package-lock.json index bfda8cd..562db78 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,13 @@ { "name": "copy-flasher", - "version": "0.1.2", + "version": "0.1.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "copy-flasher", - "version": "0.1.2", + "version": "0.1.3", + "description": "Highlights copied text in Obsidian.", "license": "MIT", "dependencies": { "@codemirror/state": "^6.6.0", diff --git a/package.json b/package.json index 98826be..dbd963a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "copy-flasher", - "version": "0.1.2", - "description": "Briefly highlights text copied inside Obsidian.", + "version": "0.1.3", + "description": "Highlights copied text in Obsidian.", "main": "main.js", "type": "module", "scripts": { diff --git a/versions.json b/versions.json index 40ff89f..ea07375 100644 --- a/versions.json +++ b/versions.json @@ -1,5 +1,6 @@ { "0.1.0": "0.15.0", "0.1.1": "0.15.0", - "0.1.2": "0.15.0" + "0.1.2": "0.16.0", + "0.1.3": "0.16.0" }