shoedler_crossbow/DEV.md

Dev Notes

Roadmap

• General UX Improvement
• Add "Goto Source" action on suggestions
• Fix occurrences hint not being updated when new occurrences are found

Refactors

• Refactor handling / updating of TreeItems. Use a reactive approach instead of manually updating the tree.
• Refactor Editor.getWordLookup() there has to be a better way of retrieving plain-text from an Editor (Without manually removing MD syntax) (Maybe a code mirror plugin?)
• Minimally stem words before matching them to cache items

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 to the community plugin list

• Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
• 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.

API Documentation

See https://github.com/obsidianmd/obsidian-api