JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Add full scaffold generator support
Nessuno ha ancora preso questa issue.
- Lingua principale
- Ruby
- Stelle
- 2.3k
- Fork
- 546
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
This issue is a (choose one):
- Feature request.
Checklist before submitting:
- I've searched for an existing issue.
- The feature I'm asking for is compliant with the JSON:API spec.
Description
Features:
note: this issue (or something similar to it) was brought up by @eccegordo in https://github.com/cerebris/jsonapi-resources/issues/1241. I opened this issue because I did not want to automatically close his in case our requests diverged, but will follow up with that issue if this issue is resolved with my PR.
As a developer, I need to be able to spin up new services, collect feedback, and validate those proofs-of-concepts as quickly as possible. Any time I spend writing boilerplate code is time not spent working on real value-adding features or concepts.
As such, I would like a way to quickly, consistently, and safely generate all of the required base file structures to get a jsonapi resource/endpoint working. Further, I would like these generated files to be opinionated, and help me fall into a "pit of success" / good practices.
In scope:
- generate (flat or name-spaced) base controllers
- generate (flat or name-spaced) controllers
- generate (flat or name-spaced) base resources
- generate (flat or name-spaced) resources
- generate (flat or name-spaced) base models
- generate (flat or name-spaced) models
- generate (flat or name-spaced) routes
Out of scope:
- declare attributes, associations, or other defining characteristics during generation
- parameterized generation options (e.g. "don't generate base classes")
- generate (flat or name-spaced) tests (future PR)
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
Inizia mappando gli entry point dei generatori e le convenzioni esistenti del repository rispetto all’elenco in scope: controller, risorse, modelli e route, ciascuno nelle forme flat e namespaced. Il lavoro è completo quando i file base e concreti richiesti vengono generati in modo coerente, lasciando fuori scope attributi, associazioni, opzioni parametrizzate e test.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- rails, ruby
- Ambito
- api, backend, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100