swagger-api/swagger-codegen

node.js generator can create invalid package.json files

Aperta

#2088 aperta il 9 feb 2016

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Enhancement: GeneralServer: Nodejshelp wanted

Metriche repository

Star
 (12.701 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

We need to properly escape the name, and version as well.

For instance:

name: "it's bad",
version: "1"

Will give an error on the name and the version as well.

Reported by @kesh92

Guida contributor

Direzione di ricerca
Il problema riguarda l'escape improprio del nome del pacchetto e della versione nei file package.json generati dal generatore Node.js. Per risolvere, individuare il file template responsabile della generazione di package.json (probabilmente un template mustache o handlebars nella directory modules/swagger codegen/src/main/resources o simile). Assicurarsi che i valori dinamici per name e version siano adeguatamente sottoposti a escape utilizzando l'escape JSON standard (ad esempio, escape di virgolette e caratteri di controllo). Cercare helper di escape esistenti o funzioni di utilità utilizzate altrove nei template. Un commento del maintainer dovrebbe chiarire i criteri di accettazione.
Tech stack
Nessuno
Dominio
backendapitooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80