obsidianmd / obsidianmd/obsidian-sample-plugin

Organise typescript sources into separate src hierarchy

Open
#81 0 comments 6 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

The plugin checklist recommends that plugin developers "Consider organizing your code base using folders":

If your plugin uses more than one .ts file, consider organizing them into folders to make it easier to review and maintain.

It would be helpful if the sample plugin did this so that there was an example to follow.

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

No specific files or tests are named. Inspect the sample plugin's TypeScript sources and build configuration first, then determine the source hierarchy that demonstrates the linked plugin guideline; done means the example is organized into folders and remains usable as a sample plugin.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience
Issue type
Refactor
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.