swagger-api/swagger-codegen

node.js generator can create invalid package.json files

Offen

#2.088 geöffnet am 09.02.2016

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: GeneralServer: Nodejshelp wanted

Repository-Metriken

Stars
 (12.701 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Problem betrifft die unsachgemäße Maskierung des Paketnamens und der Version in generierten package.json Dateien durch den Node.js Generator. Zur Behebung: Lokalisieren Sie die Vorlagendatei, die für die Generierung von package.json verantwortlich ist (wahrscheinlich eine Mustache oder Handlebars Vorlage im Verzeichnis modules/swagger codegen/src/main/resources oder ähnlich). Stellen Sie sicher, dass dynamische Werte für name und version ordnungsgemäß mit Standard JSON Maskierung maskiert werden (z. B. Maskierung von Anführungszeichen und Steuerzeichen). Suchen Sie nach vorhandenen Maskierungs Hilfsfunktionen oder Utility Funktionen, die anderswo in den Vorlagen verwendet werden. Ein Kommentar eines Maintainers sollte die Akzeptanzkriterien klären.
Tech Stack
Keine
Domain
backendapitooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80