tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a testing section in README

This commit is contained in:
hjonasson 2023-11-17 11:18:36 +13:00
parent eeeb774668
commit 5e756acd75
No known key found for this signature in database
GPG Key ID: 68D22124ADDEEB04
1 changed files with 60 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
README.md
View File

@ -8,64 +8,82 @@ The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definiti
**Note:** The Obsidian API is still in early alpha and is subject to change at any time! **Note:** The Obsidian API is still in early alpha and is subject to change at any time!
This sample plugin demonstrates some of the basic functionality the plugin API can do. 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 ribbon icon, which shows a Notice when clicked.
- Adds a plugin setting tab to the settings page. - Adds a command "Open Sample Modal" which opens a Modal.
- Registers a global click event and output 'click' to the console. - Adds a plugin setting tab to the settings page.
- Registers a global interval which logs 'setInterval' to the console. - 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? ## First time developing plugins?
Quick starting guide for new plugin devs: 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. - 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). - 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. - 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. - 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`. - 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`. - 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. - Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window. - Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder. - For updates to the Obsidian API run `npm update` in the command line under your repo folder.
## Releasing new releases ## 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 `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. - 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 - 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. - 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. - 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`. > 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` > 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 ## Adding your plugin to the community plugin list
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md - Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
- Publish an initial version. - Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo. - 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. - Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
## How to use ## How to use
- Clone this repo. - Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`). - Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies. - `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode. - `npm run dev` to start compilation in watch mode.
## Testing
There is a setup for writing unit tests using [`Jest`](https://jestjs.io/). To run the test suite you can run
```BASH
npm run test
```
or in watch mode
```BASH
npm run test:watch
```
Due to the Obsidian source code not being open-source Jest's more common mocking patterns don't work, such as `jest.mock('obsidian')`. Instead we use [Jest's manual mocks](https://jestjs.io/docs/manual-mocks) by writing a partial mock module in [`__mocks__/obsidian.js`](./__mocks__/obsidian.js). Note that it does not contain a full mock of `obsidian` and you might need to extend it to test your plugin. If you do, please consider adding your extension to this repo.
## Manually installing the plugin ## Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. - Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Improve code quality with eslint (optional) ## 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: - [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.
- `npm install -g eslint` - To use eslint with this project, make sure to install eslint from terminal:
- To use eslint to analyze this project use this command: - `npm install -g eslint`
- `eslint main.ts` - To use eslint to analyze this project use this command:
- eslint will then create a report with suggestions for code improvement by file and line number. - `eslint main.ts`
- 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 will then create a report with suggestions for code improvement by file and line number.
- `eslint .\src\` - 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 ## Funding URL
@ -75,7 +93,7 @@ The simple way is to set the `fundingUrl` field to your link in your `manifest.j
```json ```json
{ {
"fundingUrl": "https://buymeacoffee.com" "fundingUrl": "https://buymeacoffee.com"
} }
``` ```
@ -83,11 +101,11 @@ If you have multiple URLs, you can also do:
```json ```json
{ {
"fundingUrl": { "fundingUrl": {
"Buy Me a Coffee": "https://buymeacoffee.com", "Buy Me a Coffee": "https://buymeacoffee.com",
"GitHub Sponsor": "https://github.com/sponsors", "GitHub Sponsor": "https://github.com/sponsors",
"Patreon": "https://www.patreon.com/" "Patreon": "https://www.patreon.com/"
} }
} }
``` ```