obsidian-plugin/bambuscontrol_obsidian-unicode-search
1
0
Fork 0
mirror of https://github.com/bambuscontrol/obsidian-unicode-search.git synced 2026-07-22 07:20:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
bambuscontrol_obsidian-unic.../.github/copilot-instructions.md
copilot-swe-agent[bot] 6b7ed3c6df docs: add repository copilot coding instructions 
Co-authored-by: BambusControl <73384901+BambusControl@users.noreply.github.com>
Agent-Logs-Url: https://github.com/BambusControl/obsidian-unicode-search/sessions/38855c47-98bf-46a6-9433-4e8208b7fb2a
2026-03-22 21:17:04 +00:00

1.3 KiB
Raw Permalink Blame History

Copilot coding instructions

Project overview

  • This repository contains the Obsidian Unicode Search plugin.
  • Source code is in /src:
    • /src/unicode-search contains plugin/runtime integration with the Obsidian API.
    • /src/libraries contains reusable pure logic (comparison, helpers, data, ordering, and types).
  • Tests are in /tests and generally mirror files in /src/libraries.

Development workflow

  • Use Node.js + npm.
  • Main scripts:
    • npm run dev – development build/watch mode
    • npm run build – TypeScript check + production bundle
    • npm run test – Jest tests
    • npm run export-schema – regenerate resources/save-data-schema.json for SaveData changes
  • Before finalizing changes, run:
    1. npm run build
    2. npm run test

Coding guidelines

  • Use TypeScript and keep changes strongly typed.
  • Follow existing formatting conventions from .editorconfig (UTF-8, LF, 4 spaces).
  • Keep business logic in /src/libraries when possible; keep Obsidian UI/plugin glue in /src/unicode-search.
  • Make focused, minimal changes that fit existing naming and structure.

Testing guidelines

  • Add or update Jest tests for logic changes.
  • Place tests under /tests in the corresponding mirrored path.
  • Prefer targeted unit tests over broad rewrites.