fix: cleanComments filter not applied to api.title and api.description in api-endpoint.njk
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 86/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- node.js, typescript
- Área
- backend-api-design
Línea de trabajo
Lee src/generator/templates/api-endpoint.njk y compara las expresiones api.title y api.description con los otros campos de descripción que usan cleanComments. El issue identifica las dos aplicaciones de filtro que faltan y las expresiones previstas. La tarea estará completa cuando ambos campos se saniticen de forma coherente; revisa las pruebas del generador que cubren esta plantilla.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
The cleanComments filter in filters.ts (lines 85–93) neutralises */ and /*
to prevent them from escaping JSDoc block comments in generated TypeScript. It is
applied to every method, parameter, and schema description field in
api-endpoint.njk, but is missing from api.title and api.description
at lines 58 and 60.
Expected behaviour
api.title and api.description are sanitised with cleanComments, consistent
with every other description field in the same template.
Actual behaviour
Both fields are rendered raw. The filter already exists and already handles this
case, it is simply not applied to these two fields.
Proposed fix
Two-line change in src/generator/templates/api-endpoint.njk:
Line 58
Before: * {{ api.title }}
After: * {{ api.title | cleanComments | safe }}
Line 60
Before: * {{ api.description | replace("\n", "\n * ") }}
After: * {{ api.description | cleanComments | safe | replace("\n", "\n * ") }}
I'm happy to submit a PR if the fix looks good.
- Lenguaje dominante
- TypeScript
- Estrellas
- 12.3k
- Forks
- 2k
- Merge medio
- 3 d 10 h
- PR fusionados (30 d)
- 9
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una 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 googleapis/google-api-nodejs-client
-
Dificultad 4/5 1-2 días Aptitud para principiantes 5/100
googleapis/google-api-nodejs-client#4067 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 1/100
googleapis/google-api-nodejs-client#4063 ·
Los mantenedores suelen responder en 2 días
-
eMudhra/emSign CA compromise (October 2026): what Cloud SDK Node.js Libraries developers need to doAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 10/100
googleapis/google-api-nodejs-client#4062 ·
Los mantenedores suelen responder en 2 días
-
dev.blockchain.open.gov.phAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 10/100
googleapis/google-api-nodejs-client#4061 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 32/100
googleapis/google-api-nodejs-client#3932 · 1 comentario ·
Los mantenedores suelen responder en 2 días
Todos los issues de googleapis/google-api-nodejs-client
Issues similares
-
bug UI
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
wardian-app/Wardian#1746 ·
Los mantenedores suelen responder en 1 día
-
area: interop area: sip-core v3
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
fonoster/routr#705 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P2
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
openclaw/openclaw#198551 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día