[RFC] Using a package manager for plugins
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 204
- Forks
- 82
- Avg merge
- 22h 27m
- Merged PRs (30d)
- 3
Description
While it's still early days for plugins in Noteplan, it might make sense to keep all the "blessed" plugins in this Github repo, but longer term, that'll start to get untenable. Specially when it comes to releases.
Using a package manager like NPM might make a lot of sense. Using registry.npm.org URLs it's fairly straightforward to search, get details and download packages that can go directly to the Plugins folder.
Here are the benefits to this approach:
- Third party packages can all follow a naming convention (e.g. noteplan-plugin-commandName) and publish them on NPM and they will become easily discoverable for users.
- NPM packages have versioning built-in and it will become easy for different plug-ins to be updated independently and for Noteplan to periodically check for updates easily by package name.
- Since NPM allows for an independent
.npmignorefile it'll become easy to ignore built files for GitHub and ignore source files for the NPM package. This way Noteplan doesn't have to download any unnecessary files. - It should still be valid to use a Github URL to manually download plugins that aren't on NPM. (without all the extra feature though)
Possible downsides:
- Churn - NPM can be an additive feature so that the churn can be kept to a minimum.
- it slightly increases the barrier to entry, but it's really just an
npm publishcommand for a plug-in author. For advanced plugins this would be a total win.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points to inspect. First clarify the plugin discovery, download, versioning, update, and GitHub fallback requirements, then map those requirements to the existing plugin installation flow. Done would mean an agreed package-manager design and an implementation plan with testable behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100