Rethink Plugin API documentation: auto-generate JSON API spec, generate `.pyi` and `.d.ts` from there
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 15/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Attiva
- Stack tecnologico
- json, python, typescript
- Ambito
- api, documentation
Direzione di ricerca
The payload names no files or entry points; it covers the RPC protocol as documented in the executable, Python and Node plugin guides of the Flow-Launcher docs repo. Start by reading those guides to see what protocol detail they repeat. Done would mean a decision on the spec format and tooling, agreed in the thread, before any generator for .pyi or .d.ts is written.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Extracted from: https://github.com/Flow-Launcher/docs/pull/108#discussion_r4232118122
Documenting the RPC protocol in the various language-specific plugin guides is not ideal. Rather, we should decide on a formal, generated reference for the RPC spec, the same way you might see documentation for a C# API, or a .d.ts reference. Then these various non-C# plugin guides - executable, python, node - can stop documenting the protocol and instead reference the formal spec.
This spec can also be used to generate types for the TypeScript/JavaScript and Python libraries which make plugin development easier. Someone should be able to easily import the library in their node or python project and get rich intellisense for JSON requests and responses.
- Lingua principale
- Svelte
- Stelle
- 23
- Fork
- 23
- Merge medio
- 9g 34m
- PR unite (30g)
- 3
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun 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 Flow-Launcher/docs
-
documentation
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
Flow-Launcher/docs#99 ·
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
Flow-Launcher/docs#87 · 13 commenti ·
-
Outdated NodeJS versionAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 45/100
Flow-Launcher/docs#79 · 2 commenti ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
Flow-Launcher/docs#49 · 1 commento ·
-
Deploy on VercelAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
Flow-Launcher/docs#4 · 12 commenti ·
Tutte le issue di Flow-Launcher/docs
Issue simili
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 60/100
manyfold3d/manyfold#7346 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 6 giorni
-
Byse new domainAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
Gujal00/ResolveURL#1525 ·
I maintainer di solito rispondono entro 1 giorno
-
Serialisation fails with pydantic 2.14: wrap serialisers pass SerializationInfo as index_keyForse già presa @hugohills-regnosys l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
finos/rune-python-runtime#45 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100