feat: add tsd #1027

shepherdwind · 2017-06-09T23:11:51Z

新增 tsd 文件，依赖 https://github.com/eggjs/egg-type

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

shepherdwind · 2017-06-09T23:13:18Z

用例和依赖都在 https://github.com/eggjs/egg-type/blob/master/package.json#L7 这个仓库里面。

popomore · 2017-06-10T02:24:42Z

index.d.ts

@@ -0,0 +1,41 @@
+import * as EggType from 'egg-type';


这个独立出来的好处是？

独立的话更新起来更方便，不需要发 egg 版本了，只需要发这个 egg-type 即可。

一般增加 api 都需要改地址egg，不然 egg 的测试就过不了。

我想的是，这个 tsd 类似于文档，egg 的文档和 egg 仓库在一起，但如果文档发布需要 egg 升级就不大合理了。

现在的 tsd 定义还只有一个 demo ，并没有在内部真正用上，后面修改可能会比较多。这种情况如果要频繁升级 egg 的版本就不大合理了。

ts 本身功能也在升级，后面也许接口自动 merge 支持了，我们的写法也会有所变化。因此，我认为初期最好独立一个仓库，这样后面发布 tsd 包会比较方便，不需要依赖 egg 的版本。

可以先试一下

所以这里就有问题，没办法维护的。

egg-type 依赖的 egg 只是一些基本的接口定义。这个 egg 里面 index.d.ts 里面只有很少一部分定义，这一部分基本不变的，后续接口变动只修改 egg-type 就可以了，测试也不会再有依赖的。

我的观点还是哪里的代码就在哪里定义 ts，两者只要有一个地方变更就会不同步。

那我弄过来吧，egg-type 不用也行，我主要考虑后续升级上可能没那么方便，不过 tsd 一般很少改动，影响也不大。

还要改啥？我都弄过来了，egg-type 包不依赖了

popomore · 2017-06-10T02:26:45Z

test/egg-ts.test.ts

@@ -0,0 +1,34 @@
+import { Controller, Service, Application } from '..';


测试放 fixture 吧，建一个应用，按标准 egg 应用写，然后用 coffee 运行命令行测试

嗯，好的。这个我改下

codecov · 2017-06-10T15:05:30Z

Codecov Report

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

@@           Coverage Diff           @@
##           master    #1027   +/-   ##
=======================================
  Coverage   98.96%   98.96%           
=======================================
  Files          29       29           
  Lines         676      676           
=======================================
  Hits          669      669           
  Misses          7        7

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 a4ba2a2...f816f0c. Read the comment docs.

popomore · 2017-06-18T11:37:48Z

package.json

@@ -74,7 +80,8 @@
    "config",
    "bin",
    "lib",
-    "index.js"
+    "index.js",
+    "index.d.ts"


d.ts 的 entry 配置要配么

d.ts 的 entry 配置 是什么意思？

ts 默认会找包里面的 index.d.ts ，找不到找 @types/egg 的

就是如果不放 index.d.ts 是否可以指定，类似 main

https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html 可以配置 types 字段，要配一个么？默认是 index.d.ts

popomore · 2017-06-18T11:38:42Z

test/fixtures/apps/app-ts/app/controller/foo.ts

+import { Controller } from '../../../../../../';
+
+// add user controller and service
+declare module '../../../../../../' {


这里为啥不是 egg，最好是标准写法，实现不了可以加个软链接

嗯，这个是有点长了

popomore · 2017-06-18T11:39:55Z

test/fixtures/apps/app-ts/app/controller/foo.ts

+// add user controller and service
+declare module '../../../../../../' {
+  interface IController {
+    foo: FooController;


class 不是不会提升吗，ts 支持的？

放上面下面都可以，这里是静态分析过程，所以放上面也行，不过统一放下面可能会好点

popomore · 2017-06-18T11:44:33Z

index.d.ts

+   */
+  service: IService;
+
+  constructor(ctx: Context);


这个不错

popomore · 2017-06-18T11:45:42Z

test/ts/index.test.js

+const baseDir = path.join(__dirname, '../fixtures/apps/app-ts');
+
+describe('test/ts/index.test.js', () => {
+  it('tsc ok', function* () {


这个可以改成 before

shepherdwind · 2017-06-19T08:21:51Z

用例要跑半个小时啊

fengmk2 · 2017-06-19T08:37:00Z

package.json

+    "@types/accepts": "^1.3.2",
+    "@types/koa": "^2.0.39",
+    "@types/koa-router": "^7.0.22",
+    "@types/node": "^7.0.29",


如果使用 egg 的应用也依赖了 @types/node 怎么办？

这个我去掉吧，不依赖 node 也可以的

shepherdwind · 2017-06-19T08:41:47Z

8.1 下面 link 会挂

Unhandled rejection RangeError: Maximum call stack size exceededpreinstall: no script for preinstall, continuing
    at exports.create (/usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install/node.js:31:40)
    at /usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install/node.js:36:14
    at Array.forEach (native)
    at exports.create (/usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install/node.js:33:25)
    at /usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install/node.js:36:14
    at Array.forEach (native)
    at exports.create (/usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install/node.js:33:25)
    at normalizeTree (/usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install.js:377:5)
    at Array.forEach (native)
    at normalizeTree (/usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install.js:379:19)
    at Array.forEach (native)
    at normalizeTree (/usr/local/lib/node_modules/.npm_npminstall/npm/3.10.8/npm/lib/install.js:379:19

shepherdwind · 2017-06-19T09:06:15Z

挺多类似问题的，在 8.x 我要不先 skip 这个用例？

fengmk2 · 2017-06-19T09:10:13Z

test/ts/index.test.js

+
+describe('test/ts/index.test.js', () => {
+  before(function* () {
+    yield runscript('tsc && npm link ../../../../', { cwd: baseDir });


if (process.env.CI) { yield runscript('tsc && npmlink ../../../../', { cwd: baseDir }); } else { yield runscript('tsc && npm link ../../../../', { cwd: baseDir }); }

@shepherdwind 这样改，使用 npmlink

shepherdwind · 2017-06-20T10:55:50Z

这个可以合并不，tsd 有人发 mr 了 DefinitelyTyped/DefinitelyTyped#17318

popomore · 2017-06-20T15:11:31Z

先合并

fwgood · 2017-10-18T08:03:55Z

请问https://github.com/eggjs/egg-type仓库是被删除了吗

shepherdwind · 2017-10-20T03:59:01Z

@fwgood 类型内置到 egg 里面了，所以那个仓库也不需要了。

shepherdwind requested a review from popomore June 9, 2017 23:12

shepherdwind force-pushed the add-tsd branch from ff6c970 to 0aea9bb Compare June 10, 2017 01:46

popomore reviewed Jun 10, 2017

View reviewed changes

shepherdwind force-pushed the add-tsd branch from e26d2df to 6399e22 Compare June 10, 2017 15:14

popomore reviewed Jun 18, 2017

View reviewed changes

index.d.ts

*/

service: IService;

constructor(ctx: Context);

Copy link

Member

popomore Jun 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个不错

popomore reviewed Jun 18, 2017

View reviewed changes

fengmk2 mentioned this pull request Jun 19, 2017

feat: enable overrideMethod middleware by default #1069

Merged

4 tasks

shepherdwind added 3 commits June 19, 2017 15:20

feat: add tsd

7e2faeb

test: add app-ts test

3a3410a

feat(typescript): remove egg-type

212a47a

shepherdwind force-pushed the add-tsd branch 3 times, most recently from ebea601 to 3c3b142 Compare June 19, 2017 08:05

fengmk2 reviewed Jun 19, 2017

View reviewed changes

feat: add egg path map

f816f0c

shepherdwind force-pushed the add-tsd branch from c6c201a to f816f0c Compare June 19, 2017 09:30

fengmk2 approved these changes Jun 20, 2017

View reviewed changes

popomore approved these changes Jun 20, 2017

View reviewed changes

popomore merged commit 2b1644e into master Jun 20, 2017

popomore deleted the add-tsd branch June 20, 2017 15:11

		@@ -0,0 +1,34 @@
		import { Controller, Service, Application } from '..';

feat: add tsd #1027

feat: add tsd #1027

Conversation

shepherdwind commented Jun 9, 2017

Checklist

Affected core subsystem(s)

Description of change

shepherdwind commented Jun 9, 2017

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

codecov bot commented Jun 10, 2017 • 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

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

shepherdwind commented Jun 19, 2017

fengmk2 Jun 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shepherdwind commented Jun 19, 2017

shepherdwind commented Jun 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shepherdwind commented Jun 20, 2017

popomore commented Jun 20, 2017

fwgood commented Oct 18, 2017

shepherdwind commented Oct 20, 2017

codecov bot commented Jun 10, 2017 •

edited

Loading

fengmk2 Jun 19, 2017 •

edited

Loading