OpenAPITools / OpenAPITools/openapi-generator

[BUG][Javascript] Can not build the generated code Invalid version

Open
#4,442 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: JavaScript/Node.js Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

Can't run the

npm run build

command on the generated (Javascript ES6) code since the package.json file contains an invalid version number.

openapi-generator version

4.2.0

OpenAPI declaration file content or url

Swagger definition

Command line used for generation
java -jar openapi-generator-cli.jar generate -i /path/to/definition.yaml -g javascript -o /tmp/sample/
Steps to reproduce
  • Download the openapi-generator-cli.jar
  • Try to build a Javascript NodeJS client with the above mention or any other OpenAPI definition file
  • Check the generated package.json file version
  • Try to build the generated API client package
  • It will throw following exception
npm ERR! Invalid version: "v1"

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/tmkasun/.npm/_logs/2019-11-10T14_10_24_564Z-debug.log
The terminal process terminated with exit code: 1
Related issues/PRs
Suggest a fix

need to generate the package.json file with valid semantic versioning string in the version field

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the generated package.json from the JavaScript ES6 generator and reproduce the issue using the provided OpenAPI definition and generation command. Check where the version value is produced, then run npm run build on the generated client. Done means the version is valid semantic versioning and the build succeeds.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
build-system, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.