refactor(local-server): Ctrl+Cでローカルサーバを終了できるメッセージを追加 (#2)

refactor(local-server): Ctrl+Cでローカルサーバを終了できるメッセージを追加

Author: azu

.travis.yml

@@ -1,3 +1,11 @@
 sudo: false
 language: node_js
-node_js: "stable"
+node_js:
+  - "10"
+  - "node"
+# https://travis-ci.community/t/timeout-after-build-finished-and-succeeded/1336
+env:
+  - YARN_GPG=no
+os:
+  - linux
+  - windows

README.md

@@ -25,15 +25,20 @@ Local Server for [js-primer](https://github.com/asciidwango/js-primer "js-primer
 指定したディレクトリをベースにサーバを起動する
 
     npx @js-primer/local-server ./docs
-    
+
+指定したポート番号でサーバを起動する
+
+    npx @js-primer/local-server --port 8000
+
+起動したローカルサーバは、コマンドラインで<kbd>Ctrl+C</kbd>のショートカットを押下することで終了できます。
+
 ### Usage for old Node.js
 
-NOde.js 8.2未満の場合は[npm](https://www.npmjs.com/)でインストールし利用できます。
+Node.js 8.2未満の場合は[npm](https://www.npmjs.com/)でインストールすることで利用できます。
 
     npm install local-server --global
     $ js-primer-local-server
 
-
 ## Changelog
 
 See [Releases page](https://github.com/js-primer/local-server/releases).

package.json

@@ -46,31 +46,31 @@
     "tabWidth": 4
   },
   "dependencies": {
-    "chalk": "^2.4.1",
-    "connect": "^3.6.6",
-    "detect-port": "^1.2.3",
-    "log-symbols": "^2.2.0",
+    "chalk": "^2.4.2",
+    "connect": "^3.7.0",
+    "detect-port": "^1.3.0",
+    "log-symbols": "^3.0.0",
     "meow": "^5.0.0",
-    "serve-static": "^1.13.2"
+    "serve-static": "^1.14.1"
   },
   "devDependencies": {
     "@types/chalk": "^2.2.0",
     "@types/connect": "^3.4.32",
     "@types/detect-port": "^1.1.0",
-    "@types/meow": "^4.0.1",
-    "@types/mocha": "^5.2.0",
-    "@types/node": "^10.1.1",
+    "@types/meow": "^5.0.0",
+    "@types/mocha": "^5.2.7",
+    "@types/node": "^12.6.2",
     "@types/serve-static": "^1.13.2",
-    "@types/supertest": "^2.0.4",
-    "cross-env": "^5.1.5",
-    "husky": "^0.14.3",
-    "lint-staged": "^7.1.0",
-    "mocha": "^5.1.1",
-    "prettier": "^1.12.1",
-    "supertest": "^3.1.0",
-    "ts-node": "^6.0.3",
-    "ts-node-test-register": "^3.0.0",
-    "typescript": "^2.8.3"
+    "@types/supertest": "^2.0.8",
+    "cross-env": "^5.2.0",
+    "husky": "^3.0.0",
+    "lint-staged": "^9.2.0",
+    "mocha": "^6.1.4",
+    "prettier": "^1.18.2",
+    "supertest": "^4.0.2",
+    "ts-node": "^8.3.0",
+    "ts-node-test-register": "^8.0.1",
+    "typescript": "^3.5.3"
   },
   "publishConfig": {
     "access": "public"

src/cli.ts

@@ -19,14 +19,21 @@ export const run = () => {
                 port: {
                     type: "string"
                 }
-            }
+            },
+            autoVersion: true,
+            autoHelp: true
         }
     );
 
     const server = new LocalServer({
         rootDir: cli.input.length > 0 ? cli.input[0] : process.cwd(),
         port: cli.flags.port !== undefined ? Number(cli.flags.port) : 3000
     });
+    // Ctrl + C を押したときにメッセージを出す
+    process.on("SIGINT", function() {
+        server.stop();
+        process.exit();
+    });
     return server
         .start()
         .then(() => {})

src/local-server.ts

@@ -6,8 +6,7 @@ import { HandleFunction } from "connect";
 import detectPort = require("detect-port");
 import { responseLog } from "./middlewares/response-log";
 import chalk from "chalk";
-
-const logSymbols = require("log-symbols");
+import logSymbols from "log-symbols";
 
 export interface LocalServerOptions {
     rootDir?: string;
@@ -24,36 +23,42 @@ export class LocalServer {
         this.port = options.port || 3000;
     }
 
+    get appName() {
+        return this.rootDir ? path.basename(this.rootDir) : "app";
+    }
+
     start() {
         return detectPort(this.port).then(newPort => {
             if (this.port !== newPort) {
                 console.log(
-                    `${logSymbols.warning} ポート番号:${
-                        this.port
-                    }はすでに使われています。利用できる別のポート番号を探索中です。`
+                    `${logSymbols.warning} ポート番号:${this.port}はすでに使われています。利用できる別のポート番号を探索中です。`
                 );
             }
             const serve = serveStatic(this.rootDir, { index: ["index.html", "index.htm"] }) as HandleFunction;
             this.server = connect()
                 .use(responseLog())
                 .use(serve)
                 .listen(newPort, () => {
-                    const appName = path.basename(this.rootDir) || "app";
                     console.log(`
-${chalk.underline(appName)}のローカルサーバを起動しました。
+${chalk.underline(this.appName)}のローカルサーバを起動しました。
 次のURLをブラウザで開いてください。
 
   URL: ${chalk.underline(`http://localhost:${newPort}`)}
 
+Ctrl+Cのショートカットを押下することでローカルサーバを終了できます。
 `);
                 });
             return this.server;
         });
     }
 
     stop() {
-        if (this.server) {
-            this.server.close();
+        if (!this.server) {
+            return;
         }
+        this.server.close();
+        console.log(`
+${chalk.underline(this.appName)}のローカルサーバを終了しました。
+`);
     }
 }

test/test.js renamed to test/test.ts

@@ -1,25 +1,28 @@
-const assert = require("assert");
-const path = require("path");
-const request = require("supertest");
-const { LocalServer } = require("../src/local-server");
+import path from "path";
+import request from "supertest";
+import { LocalServer } from "../src/local-server";
+import * as http from "http";
+
 const fixtures = path.join(__dirname, "/fixtures");
 
-async function createServer(dir) {
+async function createServer(dir?: string) {
     const server = new LocalServer({
         rootDir: dir || fixtures
     });
     await server.start();
-    return server.server;
+    return server;
 }
 
 describe("LocalServer", function() {
     describe("basic operations", function() {
-        let server;
+        let localServer: LocalServer;
+        let server: http.Server;
         before(async function() {
-            server = await createServer();
+            localServer = await createServer();
+            server = localServer.server;
         });
         after(() => {
-            return server.close();
+            return localServer.stop();
         });
 
         it("should serve static files", function(done) {
@@ -96,7 +99,7 @@ describe("LocalServer", function() {
                     }
                     request(server)
                         .get("/todo.txt")
-                        .set("If-None-Match", res.headers.etag)
+                        .set("If-None-Match", (res as any).headers.etag)
                         .expect(304, done);
                 });
         });

tsconfig.json

@@ -8,6 +8,7 @@
     "target": "es5",
     "sourceMap": true,
     "declaration": true,
+    "esModuleInterop": true,
     "jsx": "preserve",
     "lib": [
       "es2017",
@@ -32,4 +33,4 @@
     ".git",
     "node_modules"
   ]
-}
+}