chore: improve d.ts with ts support #2306

whxaxes · 2018-04-01T07:56:36Z

Checklist

npm test passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Description of change

atian25

好像有一个测试 fixture 里面的用法改改？

whxaxes · 2018-04-01T08:07:28Z

@atian25 app-ts 那个 fixtures 里就这么一句

export default {
  keys: 'foo',
}

没用到 EggAppConfig

atian25 · 2018-04-01T08:10:12Z

嗯，那就只是 example 那边错？

whxaxes · 2018-04-01T08:10:53Z

嗯，就 example 那边之后改一下就好了

atian25 · 2018-04-01T08:27:12Z

index.d.ts

@@ -165,6 +165,15 @@ declare module 'egg' {

  export type LoggerLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'NONE';

+  export interface EggAppInfo {


顶部加个. jsdoc？说明下这个用在哪里的，如给个 config 的示例

codecov · 2018-04-01T08:33:09Z

Codecov Report

Merging #2306 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2306   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files          29       29           
  Lines         749      749           
=======================================
  Hits          746      746           
  Misses          3        3

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7fba689...745cb27. Read the comment docs.

atian25 · 2018-04-02T00:41:34Z

index.d.ts

+   * ```
+   */
+  export interface EggAppInfo {
+    pkg: string; // package.json


这里错了， pkg 是 json

哦，我改一下

shepherdwind · 2018-04-02T01:25:33Z

index.d.ts

+   * }
+   * ```
+   */
+  export interface EggAppInfo {


这个哪里有文档么？我当时看着文档写的，这些地段哪里那的？

https://eggjs.org/zh-cn/basics/config.html#%E9%85%8D%E7%BD%AE%E5%86%99%E6%B3%95

@shepherdwind 之前你们 example 那边写的 config 理解有问题。

export default (appInfo: EggAppInfo, appConfig?: EggAppConfig) => {} 这才是 config.{env}.js 的签名

不过 appConfig 这个没几个人知道，哈哈

atian25 · 2018-04-03T13:05:30Z

添加下 plugin
这个要改下，info 的第一个参数是支持 number 或 object 啥的，直接 any 好了。

  export interface Logger {
    info(info: string, ...args: any[]): void;
    warn(info: string, ...args: any[]): void;
    debug(info: string, ...args: any[]): void;
    error(info: string | Error, ...args: any[]): void;
  }

atian25

顺手改下 logger 那里

atian25 · 2018-04-04T03:29:31Z

index.d.ts

+    env?: EggEnvType;
+    path?: string;
+    package?: string;
+    enabled?: boolean;


atian25 · 2018-04-04T03:29:49Z

index.d.ts

+  /**
+   * build-in plugin list
+   */
+  interface EggPluginList {


就叫 EggPlugin 吧

atian25 · 2018-04-04T03:44:14Z

index.d.ts

@@ -348,11 +371,31 @@ declare module 'egg' {

    siteFile: any;


https://github.com/eggjs/egg/blob/master/config/config.default.js#L167

应该是 [key: string]: string | buffer

atian25 · 2018-04-04T03:44:40Z

index.d.ts

+   * ```
+   */
+  export interface EggAppInfo {
+    pkg: any; // package.json


是个 object

看到 config 下的就是 any，这种 package info，特意写成 { [key: string]: any } 意义不大啊

any 可以是 Array，String 啥的吧？不过这个无所谓了。

atian25 · 2018-04-04T03:46:48Z

index.d.ts

+      cache: boolean;
+      defaultExtension: string;
+      defaultViewEngine: string;
+      mapping: any;


object， key value 都是 string

atian25 · 2018-04-04T03:48:07Z

index.d.ts

-    watcher: any;
+    watcher: {
+      type: string;
+      eventSources: {


这个 key 可以干掉，或者里面允许 [key: string]

感觉这些是不是提交到 egg-watcher 那边，然后 egg 里面 import 就好了？不要都写在 egg 里面

这个就得所有插件一个一个改了，暂时先写在 egg 里把？之后再给那些插件加

先在这改吧，改完我们看看是不是再一个 PR 干掉，然后才一起发布。

atian25 · 2018-04-04T03:49:07Z

index.d.ts

+  };
+
+  // egg env type
+  type EggEnvType = 'local' | 'unittest' | 'prod';


加个注释，告诉开发者如何覆盖

这个覆盖就是 declare merging....这个不需要写在注释里把，应该是要写在如何写插件或者框架的 ts 那里吧？

如果这个都要写，那 interface 那些不也一样要写了么...

行吧，那在 ts 文档那边写就好了，或者是在 d.ts 的顶部写一次。

atian25 · 2018-04-04T09:07:05Z

index.d.ts

@@ -540,6 +594,8 @@ declare module 'egg' {
    controller: IController;

    Controller: Controller;
+
+    middlewares: IMiddleware;


用 middleware

egg-core 里是 middlewares 哦

你往上看看，有一个 defineProperty

哦，看到了，我改一下

atian25 · 2018-04-04T09:08:00Z

index.d.ts


-    static: any;
+    static: {
+      prefix: string;


除了这些还有其他参数的，https://github.com/eggjs/egg-static#configuration
加个允许未知 key 吧

好，我加个 &PlainObject

beliefgp · 2018-04-04T09:35:05Z

index.d.ts

+   * // { view: { defaultEngines: string } } => { view?: { defaultEngines?: string } }
+   * type EggConfig = PowerPartial<EggAppConfig>
+   */
+  type PowerPartial<T> = {


这个 PowerPartial 的实现，用递归写法好点吧？

type PowerPartial<T> = { [U in keyof T]? : T[U] extends {} ? PowerPartial<T[U]> : T[U]; };

可以，我改一下

会不会有性能问题。。。这样一直递归下去，如果是按照此前的，就至少能控制在 3 层

哇，递归后就是无限层了？

额，你这样讲也有可能，不过这个只是对编译期，应该还好吧~~看看翰文他们什么意见。

interface Test { a: { a1: { a2: { a3: Test; }; }, }; b: string; } type TestP = PowerPartial<Test>; const t: TestP = { a: { a1: { a2: { a3: { a: { }, }, }, }, }, b: 'b', };

试了下，编译提示都没有什么问题，也没有卡顿，ts应该有这种内部保护机制吧……

不是对象，只是 interface 的话，是可能有的有这种互相引用的情况的，不过我刚才试了一下，发现没问题，那我改成你这种把

~~先不改吧，反正 config 一般也就三层~~

我能说我现在就有4层的么……😆

OK，改了

shepherdwind · 2018-04-04T10:07:39Z

index.d.ts

@@ -3,8 +3,23 @@ import * as KoaApplication from 'koa';
 import * as KoaRouter from 'koa-router';
 import { RequestOptions } from 'urllib';
 import { Readable } from 'stream';
+import 'egg-onerror';


插件全部都引入么？但是如果用户不开启也会有相关类型提示了，会不会太多了。

这些都是 egg 内置的插件，其实是希望之后，能把配置这些分散到各个插件去实现

这些插件都是开启的吧，目前这些插件也还没有 d.ts，现在先引入，之后补了插件的 d.ts 之后，这个也可以直接生效了

我让他先写入的，后面 egg 里面的一些如 config.development 的定义，都下沉到插件那边去。
现在先 import 了，避免后面又要发 egg 版本

chore: improve d.ts with ts support (#2306)

chore: add EggAppInfo in d.ts

fe94253

whxaxes requested review from atian25 and shepherdwind and removed request for atian25 April 1, 2018 07:56

atian25 approved these changes Apr 1, 2018

View reviewed changes

atian25 reviewed Apr 1, 2018

View reviewed changes

whxaxes added 2 commits April 1, 2018 16:33

docs: add js doc

20264f2

docs: update jsdoc

efb29bd

atian25 mentioned this pull request Apr 1, 2018

[RFC] TypeScript tool support #2272

Closed

28 tasks

atian25 reviewed Apr 2, 2018

View reviewed changes

whxaxes force-pushed the ts-app-info branch from 91d4acf to efb29bd Compare April 2, 2018 06:10

atian25 and others added 2 commits April 2, 2018 14:11

Merge branch 'master' into ts-app-info

b875997

fix: typo

06a0357

shepherdwind approved these changes Apr 2, 2018

View reviewed changes

Merge branch 'master' into ts-app-info

603a7ac

feat: add PowerPartial type and plugin interfaces

1abcef9

atian25 reviewed Apr 4, 2018

View reviewed changes

atian25 changed the title ~~chore: add EggAppInfo in d.ts~~ chore: improve d.ts with ts support Apr 4, 2018

whxaxes added 3 commits April 4, 2018 11:40

feat: change any type to object

0a357c2

fix: typo

c088b2c

docs: update comment

76b08eb

atian25 reviewed Apr 4, 2018

View reviewed changes

whxaxes added 2 commits April 4, 2018 12:56

feat: change mapping type to plainobject

4585b86

feat: add plainobject type

56ff3e2

whxaxes added 2 commits April 4, 2018 15:12

feat: change EggEnvType

26a3a74

feat: add IMiddleware

ff21f75

atian25 reviewed Apr 4, 2018

View reviewed changes

whxaxes added 2 commits April 4, 2018 17:10

chore: add any key to static config

f1711b5

chore: rename middlewares to middleware

bbca0c0

shepherdwind approved these changes Apr 4, 2018

View reviewed changes

chore: change order of PowerPartial

37b9b77

beliefgp reviewed Apr 4, 2018

View reviewed changes

whxaxes added 2 commits April 4, 2018 17:57

chore: import all plugin

4205e9b

Merge branch 'master' into ts-app-info

e63fbaa

shepherdwind reviewed Apr 4, 2018

View reviewed changes

atian25 approved these changes Apr 4, 2018

View reviewed changes

chore: remove middleware

745cb27

atian25 merged commit 4061427 into master Apr 4, 2018

atian25 deleted the ts-app-info branch April 4, 2018 10:50

atian25 mentioned this pull request Apr 4, 2018

Release 2.6.0 #2317

Merged

4 tasks

popomore pushed a commit that referenced this pull request Apr 4, 2018

docs: auto generate by ci

055037b

chore: improve d.ts with ts support (#2306)

		@@ -165,6 +165,15 @@ declare module 'egg' {

		export type LoggerLevel = 'DEBUG' \| 'INFO' \| 'WARN' \| 'ERROR' \| 'NONE';

		export interface EggAppInfo {

chore: improve d.ts with ts support #2306

chore: improve d.ts with ts support #2306

Conversation

whxaxes commented Apr 1, 2018

Checklist

Affected core subsystem(s)

Description of change

atian25 left a comment

Choose a reason for hiding this comment

whxaxes commented Apr 1, 2018

atian25 commented Apr 1, 2018

whxaxes commented Apr 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Apr 1, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atian25 commented Apr 3, 2018

atian25 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

whxaxes Apr 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

whxaxes Apr 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beliefgp Apr 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atian25 Apr 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Apr 1, 2018 •

edited

Loading

whxaxes Apr 4, 2018 •

edited

Loading

whxaxes Apr 4, 2018 •

edited

Loading

beliefgp Apr 4, 2018 •

edited

Loading

atian25 Apr 4, 2018 •

edited

Loading