swagger-api/swagger-codegen

All typescript client should have to possibility to generate packaging information

Open

#2,694 opened on 2016年4月24日

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

説明

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.

コントリビューターガイド

技術スタック
typescript
領域
toolingdeveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Familiarity with swagger codegen template structureUnderstanding of TypeScript project setupKnowledge of npm package generation
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
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.