obsidianmd / obsidianmd/obsidian-sample-plugin

Enhance sample plugin with Jest Unit Test

Open
#37 4 comments 13 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4.5k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

In order to be able to guard custom obsidian plugins with unit tests, it'd be great if the sample plugin would already contain an initial Jest Unit Test and the package.json configured to execute it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the sample plugin structure and package.json to understand the existing build and test entry points. Add an initial Jest unit test and configure package.json to execute it; done means the test runs successfully through the configured package command.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.