[RFC] Using a package manager for plugins
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 204
- Fork
- 82
- Merge medio
- 22h 27m
- PR unite (30g)
- 3
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
La issue non indica file, test o punti di ingresso da ispezionare. Innanzitutto chiarisci i requisiti di rilevamento, download, versionamento, aggiornamento e fallback GitHub dei plugin, poi associa tali requisiti al flusso di installazione dei plugin esistente. Il lavoro sarà completato quando saranno disponibili un design concordato del package manager e un piano di implementazione con un comportamento verificabile.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100