Router events (enabling route documentation) – feature request
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- express, javascript, node.js
Línea de trabajo
Comienza revisando la discusión del issue y el módulo de ejemplo mk-express-router-doc enlazado para comprender el wrapper del router propuesto y el comportamiento de los eventos. Determina el alcance y la API de los eventos cuando se añaden middleware, rutas o manejadores de métodos, incluido si se incluyen metadatos de documentación de rutas. Se considera terminado cuando exista una dirección de implementación acordada con la documentación y las pruebas correspondientes, pero aquí no se identifican archivos ni pruebas de destino.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I am very fond of the express router for it provides a great deal of flexibility. But I have somewhat problems keeping track of all the routes, middleware locations and methods.
It would be great if there was an event implementation that fires up, if e.g. a middleware handler, another route or a method handler is added.
It would then be easy to keep track of the routes and eventually build a documentation.
Since the lines above might not well explain what I have in mind, I have given this some more thought an created a little example module, which is basically a wrapper/decorator for the express router, which sort of mimics and extends the express router behavior.
I hope this example helps explaining why an evented router might be helpful indeed. It's not great code, but rather a quick and dirty hack:
https://github.com/mkastner/mk-express-router-doc
I don't want to be pushing this too far: but if one could add some documentation on the fly to each respective route and path – that would be the icing on the cake.
- Lenguaje dominante
- JavaScript
- Estrellas
- 69.7k
- Forks
- 25.6k
- Merge medio
- 2 d 9 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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.
Más de expressjs/express
-
Outdated res.send() syntax in lib/response.js documentation exampleQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abiertodocs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
expressjs/express#7588 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
4.x deps module:body-parser
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
expressjs/express#7564 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Update to mocha 12.xPosiblemente ocupada @ganeshghutukade-04 la tomó hace 26 días. Abiertodeps
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
expressjs/express#7547 · 6 comentarios ·
Los mantenedores suelen responder en 1 día
-
req.subdomains splits an IPv6 host that contains dotsPosiblemente ocupada @johnnyhuirilef la tomó hace 30 días. Abierto4.x 5.x bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
expressjs/express#7532 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Readme: project name 'express.js' is not capitalizedQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
Los mantenedores suelen responder en 1 día
Todos los issues de expressjs/express
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 63/100
anothaDev/luci-theme-vantage#143 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
kingcharleslzy-ai/dsh-purge#282 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
-
a-corriger bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
christian-raj/S-Aloha#340 ·
-
area:image documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día