fix: cleanComments filter not applied to api.title and api.description in api-endpoint.njk
Les mainteneurs répondent en général sous 2 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Accessibilité débutants
- 86/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- node.js, typescript
- Domaine
- backend-api-design
Piste de recherche
Lisez src/generator/templates/api-endpoint.njk et comparez les expressions api.title et api.description aux autres champs de description qui utilisent cleanComments. L’issue indique les deux applications de filtre manquantes et les expressions prévues. La tâche est terminée lorsque les deux champs sont assainis de manière cohérente ; vérifiez les tests du générateur qui couvrent ce template.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- TypeScript
- Étoiles
- 12.3k
- Forks
- 2k
- Merge moyen
- 3 j 10 h
- PR mergées (30 j)
- 9
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de googleapis/google-api-nodejs-client
-
Difficulté 4/5 1-2 jours Accessibilité débutants 5/100
googleapis/google-api-nodejs-client#4067 ·
Les mainteneurs répondent en général sous 2 jours
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 1/100
googleapis/google-api-nodejs-client#4063 ·
Les mainteneurs répondent en général sous 2 jours
-
eMudhra/emSign CA compromise (October 2026): what Cloud SDK Node.js Libraries developers need to doOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 10/100
googleapis/google-api-nodejs-client#4062 ·
Les mainteneurs répondent en général sous 2 jours
-
dev.blockchain.open.gov.phOuverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
googleapis/google-api-nodejs-client#4061 ·
Les mainteneurs répondent en général sous 2 jours
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 32/100
googleapis/google-api-nodejs-client#3932 · 1 commentaire ·
Les mainteneurs répondent en général sous 2 jours
Toutes les issues de googleapis/google-api-nodejs-client
Issues similaires
-
parse: child keys like `007`, `1e3`, `0x1f`, `-1` make the parent an empty array and hide the valueOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
enhancement follow-up
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 62/100
bketelsen/pi-pocket-team#232 ·
Les mainteneurs répondent en général sous 1 jour
-
bug UI
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
wardian-app/Wardian#1746 ·
Les mainteneurs répondent en général sous 1 jour
-
area: interop area: sip-core v3
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
fonoster/routr#705 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour