swagger-api/swagger-codegen

All typescript client should have to possibility to generate packaging information

Open

#2,694 opened on Apr 24, 2016

View on GitHub
 (9 comments) (4 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: TypeScriptEnhancement: Featurehelp wanted

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

Tech stack
typescript
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Familiarity with swagger codegen template structureUnderstanding of TypeScript project setupKnowledge of npm package generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The angular2 client already generates package.json, tsconfig.json, and typings.json. You should locate the template files and generator code for the angular2 client in the repository (likely under modules/swagger codegen/src/main/resources/typescript angular2 and the related generator class). Then extend the same logic to all other TypeScript client generators (e.g., typescript angular, typescript node, typescript fetch) by checking the `npmName` option. Ensure the files are generated only when `npmName` is provided. Consult the existing implementation for reference and test with sample OpenAPI specs.