fix: cleanComments filter not applied to api.title and api.description in api-endpoint.njk
Mantenedores costumam responder em até 2 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Facilidade para iniciantes
- 86/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- node.js, typescript
- Domínio
- backend-api-design
Direção de pesquisa
Leia src/generator/templates/api-endpoint.njk e compare as expressões api.title e api.description com os outros campos de descrição que usam cleanComments. A issue identifica as duas aplicações de filtro ausentes e as expressões pretendidas. O trabalho estará concluído quando ambos os campos forem sanitizados de forma consistente; confira os testes do gerador que cobrem este template.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- TypeScript
- Estrelas
- 12.3k
- Forks
- 2k
- Merge médio
- 3d 10h
- PRs com merge (30d)
- 9
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de googleapis/google-api-nodejs-client
-
Dificuldade 4/5 1-2 dias Facilidade para iniciantes 5/100
googleapis/google-api-nodejs-client#4067 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 1/100
googleapis/google-api-nodejs-client#4063 ·
Mantenedores costumam responder em até 2 dias
-
eMudhra/emSign CA compromise (October 2026): what Cloud SDK Node.js Libraries developers need to doAberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 10/100
googleapis/google-api-nodejs-client#4062 ·
Mantenedores costumam responder em até 2 dias
-
dev.blockchain.open.gov.phAberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 10/100
googleapis/google-api-nodejs-client#4061 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 32/100
googleapis/google-api-nodejs-client#3932 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
Todas as issues de googleapis/google-api-nodejs-client
Issues semelhantes
-
parse: child keys like `007`, `1e3`, `0x1f`, `-1` make the parent an empty array and hide the valueAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
enhancement follow-up
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 62/100
bketelsen/pi-pocket-team#232 ·
Mantenedores costumam responder em até 1 dia
-
bug UI
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
wardian-app/Wardian#1746 ·
Mantenedores costumam responder em até 1 dia
-
area: interop area: sip-core v3
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
fonoster/routr#705 · 1 comentário ·
Mantenedores costumam responder em até 1 dia