swagger-api / swagger-api/swagger-codegen

[TYPESCRIPT_ANGULAR] Bug - swagger-codegen-cli-v3 generates not well formatted README.md

Open
#10,072 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

I'd like to generate typescript-angular client with https://hub.docker.com/r/swaggerapi/swagger-codegen-cli-v3.
Everything works fine but the generated README.md misses the code fencing closing (```) after
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save in the consuming section/without publishing part so the README.md is not well formatted.

Swagger-codegen version

swaggerapi/swagger-codegen-cli-v3:latest (3.0.18)

Swagger declaration file content or url

http://petstore.swagger.io/v2/swagger.json

Command line used for generation
docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli-v3:latest generate \
-i http://petstore.swagger.io/v2/swagger.json \
-l typescript-angular \
-o /local \
-DnpmName=somepackagename
Suggest a fix/enhancement

Please add the missing code fencing closing (```) after npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save

Thanks in advance,
Lajos

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

Reproduce the issue with the listed Docker command and inspect the generated README.md, especially the consuming section/without publishing part. Find the TypeScript Angular template that produces this section and verify the closing code fence is present in the generated output; completion is a correctly fenced README.md.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, docker, typescript
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.