Docs: document plugin registry generation step for create-sonicjs users
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 50/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- javascript, typescript
- Ambito
- developer-experience, documentation
Direzione di ricerca
Start by reading generate-plugin-registry.mjs to confirm what the registry step does, then find the plugin development docs and the create-sonicjs template README, which the issue says never mention it. The manual route-mounting snippet for src/index.ts is a second option to document. Done means a clear callout in the plugin docs and a note in the template README or getting-started guide explaining when the registry must be generated or routes mounted.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Problem
Users who scaffold a new project via npx create-sonicjs my-app are not aware that plugins won't be picked up unless the plugin registry is generated or routes are manually mounted.
This came up in Discord — a user couldn't get plugins working because neither the plugin development docs nor the default template mention the required setup step.
What's missing
Plugins require one of the following to work:
- Generate the plugin registry via
generate-plugin-registry.mjs, or - Manually mount plugin routes in
src/index.ts:
// Mount plugin routes
if (contactFormPlugin.routes) {
for (const route of contactFormPlugin.routes) {
app.route(route.path, route.handler)
}
}
// Mount core app last
app.route('/', coreApp)
Suggested fix
- Add a clear callout in the plugin development docs explaining the registry generation step
- Update the
create-sonicjstemplate or its README to mention this requirement - Consider adding a note in the getting started guide for plugin consumers
Source
Discord community feedback.
- Lingua principale
- TypeScript
- Stelle
- 1.8k
- Fork
- 219
- Merge medio
- 2g 21h
- PR unite (30g)
- 67
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
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.
Altre issue di SonicJs-Org/sonicjs
-
bug(admin/users): server error returns bare alert HTML causing black-shape visual artifactForse già presa @lane711 l’ha presa oggi. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
SonicJs-Org/sonicjs#1211 ·
I maintainer di solito rispondono entro 1 giorno
-
area: api bug priority: P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
SonicJs-Org/sonicjs#1200 ·
I maintainer di solito rispondono entro 1 giorno
-
ResendProvider cannot send on Workers: unbound `fetch` stored as an instance property throws "Illegal invocation"Forse già presa @lane711 l’ha presa 23 giorni fa. Apertaarea: email bug priority: P1
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
SonicJs-Org/sonicjs#1099 ·
I maintainer di solito rispondono entro 1 giorno
-
Email plugin settings are never read: loadDbEmailSettings queries a v2 `plugins` table that does not exist in v3Forse già presa @lane711 l’ha presa 23 giorni fa. Apertaarea: email bug priority: P1
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
SonicJs-Org/sonicjs#1098 ·
I maintainer di solito rispondono entro 1 giorno
-
area: documentation bug documentation priority: P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
SonicJs-Org/sonicjs#1012 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di SonicJs-Org/sonicjs
Issue simili
-
P2
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
bug ready-for-human
Difficoltà 2/5 1-3 ore Idoneità per principianti 60/100
LucasSantana-Dev/Lucky#3150 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement good first issue priority: low size: XS
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
area: testing bug priority: low
Difficoltà 2/5 1-3 ore Idoneità per principianti 87/100
snapotter-hq/SnapOtter#5099 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
EveryInc/compound-engineering-plugin#2091 ·
I maintainer di solito rispondono entro 1 giorno