swagger-api / swagger-api/swagger-codegen

All typescript client should have to possibility to generate packaging information

Open
#2,694 9 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: TypeScript Enhancement: Feature help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

For now only the typescript-angluar2 client generates it's own packaging information. All Typescript clients should able to generate their own packaging information.
Next information should be generated:

  • package.json
  • tsconfig.json
  • typings.json (optionaly)

I would suggest to only generate these files when the npmName option is passed.

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 by inspecting how the typescript-angular2 client generates package.json, tsconfig.json, and optional typings.json, then compare the other TypeScript clients. Check the npmName option’s handling and verify that these files are generated for each TypeScript client only when npmName is provided.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.