feat: support egg.typescript (#92)

README.md

@@ -80,7 +80,7 @@ $ egg-bin dev
 - `--port` server port, default to `7001`.
 - `--cluster` worker process number, skip this argvs will start only `1` worker, provide this without value will start `cpu` count worker.
 - `--sticky` start a sticky cluster server, default to `false`.
-- `--typescript` / `--ts` enable typescript support, default to `false`.
+- `--typescript` / `--ts` enable typescript support, default to `false`. Also support read from `package.json`'s `egg.typescript`.
 - `--require` will add to `execArgv`, support multiple.
 
 ### debug

lib/command.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const path = require('path');
+const fs = require('fs');
 const BaseCommand = require('common-bin');
 
 class Command extends BaseCommand {
@@ -24,14 +25,24 @@ class Command extends BaseCommand {
 
   get context() {
     const context = super.context;
-    const { argv, debugPort, execArgvObj } = context;
+    const { argv, debugPort, execArgvObj, cwd } = context;
 
     // compatible
     if (debugPort) context.debug = debugPort;
 
     // remove unuse args
     argv.$0 = undefined;
 
+    // read `egg.typescript` from package.json
+    const baseDir = argv._[0] || argv.baseDir || cwd;
+    const pkgFile = path.join(baseDir, 'package.json');
+    if (fs.existsSync(pkgFile)) {
+      const pkgInfo = require(pkgFile);
+      if (pkgInfo && pkgInfo.egg && pkgInfo.egg.typescript) {
+        argv.typescript = true;
+      }
+    }
+
     // execArgv
     if (argv.typescript) {
       execArgvObj.require = execArgvObj.require || [];

test/fixtures/example-ts-pkg/app.ts

@@ -0,0 +1,7 @@
+'use strict';
+
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  console.log(`hi, egg, ${app.config.keys}`);
+};

test/fixtures/example-ts-pkg/app/router.ts

@@ -0,0 +1,9 @@
+'use strict';
+
+import { Application, Context } from 'egg';
+
+export default (app: Application) => {
+  app.router.get('/', function* (this: Context) {
+    this.body = `hi, egg`;
+  });
+};

test/fixtures/example-ts-pkg/config/config.default.ts

@@ -0,0 +1,7 @@
+'use strict';
+
+export default () => {
+  const config: any = {};
+  config.keys = '123456';
+  return config;
+};

test/fixtures/example-ts-pkg/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "example-ts-pkg",
+  "egg": {
+    "typescript": true
+  }
+}

test/fixtures/example-ts-pkg/test/index.test.ts

@@ -0,0 +1,21 @@
+'use strict';
+
+import { Application, Context } from 'egg';
+import { default as mock, MockOption, BaseMockApplication } from 'egg-mock';
+import * as path from 'path';
+
+describe('test/index.test.ts', () => {
+  let app: BaseMockApplication<Application, Context>;
+  before(() => {
+    app = mock.app({ typescript: true } as MockOption);
+    return app.ready();
+  });
+  after(() => app.close());
+  it('should work', async () => {
+    await app
+      .httpRequest()
+      .get('/')
+      .expect('hi, egg')
+      .expect(200);
+  });
+});

test/fixtures/example-ts-pkg/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "commonjs",
+    "strict": true,
+    "noImplicitAny": false,
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "pretty": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "inlineSourceMap": true,
+    "importHelpers": true
+  },
+}

test/ts.test.js

@@ -33,45 +33,78 @@ describe('test/ts.test.js', () => {
       .end();
   });
 
-  it('should start app', () => {
+  describe('real application', () => {
     if (process.env.EGG_VERSION && process.env.EGG_VERSION === '1') {
       console.log('skip egg@1');
       return;
     }
-    cwd = path.join(__dirname, './fixtures/example-ts');
-    return coffee.fork(eggBin, [ 'dev', '--ts' ], { cwd })
-      // .debug()
-      .expect('stdout', /hi, egg, 12345/)
-      .expect('stdout', /started/)
-      .expect('code', 0)
-      .end();
-  });
 
-  it('should test app', () => {
-    if (process.env.EGG_VERSION && process.env.EGG_VERSION === '1') {
-      console.log('skip egg@1');
-      return;
-    }
-    cwd = path.join(__dirname, './fixtures/example-ts');
-    return coffee.fork(eggBin, [ 'test', '--ts' ], { cwd })
-      // .debug()
-      .expect('stdout', /hi, egg, 123456/)
-      .expect('stdout', /should work/)
-      .expect('code', 0)
-      .end();
+    before(() => {
+      cwd = path.join(__dirname, './fixtures/example-ts');
+    });
+
+    it('should start app', () => {
+      return coffee.fork(eggBin, [ 'dev', '--ts' ], { cwd })
+        // .debug()
+        .expect('stdout', /hi, egg, 12345/)
+        .expect('stdout', /started/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should test app', () => {
+      return coffee.fork(eggBin, [ 'test', '--ts' ], { cwd })
+        // .debug()
+        .expect('stdout', /hi, egg, 123456/)
+        .expect('stdout', /should work/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should cov app', () => {
+      return coffee.fork(eggBin, [ 'cov', '--ts' ], { cwd })
+        .debug()
+        .expect('stdout', /hi, egg, 123456/)
+        .expect('stdout', process.env.NYC_ROOT_ID ? /Coverage summary/ : /Statements.*100%/)
+        .expect('code', 0)
+        .end();
+    });
   });
 
-  it('should cov app', () => {
+  describe('egg.typescript = true', () => {
     if (process.env.EGG_VERSION && process.env.EGG_VERSION === '1') {
       console.log('skip egg@1');
       return;
     }
-    cwd = path.join(__dirname, './fixtures/example-ts');
-    return coffee.fork(eggBin, [ 'cov', '--ts' ], { cwd })
-      .debug()
-      .expect('stdout', /hi, egg, 123456/)
-      .expect('stdout', process.env.NYC_ROOT_ID ? /Coverage summary/ : /Statements.*100%/)
-      .expect('code', 0)
-      .end();
+
+    before(() => {
+      cwd = path.join(__dirname, './fixtures/example-ts-pkg');
+    });
+
+    it('should start app', () => {
+      return coffee.fork(eggBin, [ 'dev' ], { cwd })
+        // .debug()
+        .expect('stdout', /hi, egg, 12345/)
+        .expect('stdout', /started/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should test app', () => {
+      return coffee.fork(eggBin, [ 'test' ], { cwd })
+        // .debug()
+        .expect('stdout', /hi, egg, 123456/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should cov app', () => {
+      return coffee.fork(eggBin, [ 'cov' ], { cwd })
+        .debug()
+        .expect('stdout', /hi, egg, 123456/)
+        .expect('stdout', process.env.NYC_ROOT_ID ? /Coverage summary/ : /Statements.*100%/)
+        .expect('code', 0)
+        .end();
+    });
   });
 });