swagger-api/swagger-codegen

node.js generator can create invalid package.json files

Open

#2,088 opened on Feb 9, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: GeneralServer: Nodejshelp wanted

Description

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

Tech stack
nodejs
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js basicsJSON syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue concerns improper escaping of the package name and version in generated package.json files by the Node.js generator. To fix, locate the template file responsible for generating package.json (likely a mustache or handlebars template in the modules/swagger codegen/src/main/resources or similar directory). Ensure that dynamic values for name and version are properly escaped using standard JSON escaping (e.g., escape quotes and control characters). Look for existing escaping helpers or utility functions used elsewhere in the templates. A maintainer comment should clarify acceptance criteria.