nodejs+typescript+nodemon+ts-nodeサーバ端構築demo

以前はjsで開発したnodejsアプリケーションですが、今日はtyppescriptでサーバープログラムを書いてみます.ここで出会ったいくつかのピットをまとめてみます.
1:まずnodejsプロジェクトを保存するためのフォルダを作成します.ここでnode-ts-serverと名づけます.
2:npm initプロジェクトを実行すると、一つのpackage.jsonファイルが生成されます.
3:typescript npm install typescriptをインストールする
4:tsc--initを実行して自動的にtsconfig.jsonファイルを生成して、以下の配置に変更して、プロジェクトの需要に応じて柔軟に変えられます.

{
  "compilerOptions": {
    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./dist",                        /* Redirect output structure to the directory. */
    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
    "watch": true,
    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules/*.ts"]
}

5:ソースコードフォルダsrcを作成して、テスト用のtsファイルap.tsつまりpackage.jsonファイルの中の入口ファイルを追加して、作成する前にまずexpressをインストールします.

npm install express --save

expressに慣れていない人はexpressの公式文書に移動できます.
しかし、インストール後にapp.tsファイルを書いてexpressを導入すると、赤いimport express fromの「express」が爆発します.これはexpressを宣言していないので、@types/expressをインストールしてnpm installを実行する必要があります.
app.tsは以下の通りです

import express from "express";

const app = express();

const port = 3000;

app.listen(port,() => {
    console.log("a server is listen on port:",port);
})

このtsファイルを作成しました.直接tsファイルを実行したいですが、どうすればいいですか?ts-nodeは役に立ちます.全体をインストールしてください.

npm install -g ts-node

今tscコマンドを実行するとdistフォルダがあなたのプロジェクトに作成されます.直接実行してもいいです.

ts-node ./src/app.ts

サービスを開始します
今はもう一つの需要があります.Srcカタログのtsファイルを変えるたびに、システムサービスが再起動されます.この時はnodemonというものを使います.よく分からないのは娘を助けてください.
nodemonのインストールを開始します.

npm install -g nodemon

6:package.jsonファイルにスクリプトを追加する:   「start」:「nodemon--watch src/*/*.」ts--exec\"ts-node\"src/ap.ts"

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "nodemon --watch src/**/*.ts --exec \"ts-node\" src/app.ts"
  },

このように変更するたびに下のコンソールから次のように出力されます.

> [email protected] start /Users/lck/js_study/node-ts-server
> nodemon --watch src/**/*.ts --exec "ts-node" src/app.ts

[nodemon] 2.0.3
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): src/**/*.ts
[nodemon] watching extensions: ts,json
[nodemon] starting `ts-node src/app.ts`
a server is listen on port: 3000
[nodemon] restarting due to changes...
[nodemon] starting `ts-node src/app.ts`
a server is listen on port: 3000