JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Add full scaffold generator support
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Ruby
- Estrellas
- 2.3k
- Forks
- 546
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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)
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza por mapear los puntos de entrada de los generadores y las convenciones existentes del repositorio con respecto a la lista incluida en el alcance: controladores, recursos, modelos y rutas, cada uno con formas planas y con namespace. Se considera terminado cuando se generen de forma coherente los archivos base y concretos solicitados, dejando fuera de alcance los atributos, las asociaciones, las opciones parametrizadas y las pruebas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- rails, ruby
- Área
- api, backend, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100