swagger-api/swagger-codegen

All typescript client should have to possibility to generate packaging information

Open

#2,694 创建于 2016年4月24日

在 GitHub 查看
 (9 评论) (4 反应) (0 负责人)HTML (12,701 star) (5,474 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.