プロジェクトをJavaScriptからTypeScriptへ移行する手順

こんにちは。[KEN](https://twitter.com/ken_0205_jp)です。

以前、自分で書いたJavaScriptのコードをメンテナンス性向上などの観点からTypeScriptへ書き換える機会がありました。

TypeScripへ段階的に移行することがこれからもあるかと思うので、備忘録としてここに記しておきます。

### TypeScriptの導入
何はともあれまずはTypeScriptの導入です。
(package.jsonが無い場合は、```npm init --yes```で作成する。)

``` 
npm install --save-dev typescript 
```

次にtsconfig.json(TypeScriptの設定ファイル)の作成です。

```
npx tsc --init
```

また自分の場合Node.jsを使用していたので、Node.js用の型定義パッケージをインストールします。```@types/node```パッケージにはfsやpathなどの型定義が含まれています。


```
npm install --save-dev @types/node
```

### tsconfig.jsonの設定をプロジェクトに合わせる。
次に先ほど作成したtsconfig.jsonを編集していきます。

今回はtargetをES2019、moduleをcommonjsにしました。
またコンパイル後にできるjsファイルの置き場所として、distディレクトリを指定しています。(```"outDir": "dist"```)
そしてコンパイルの対象ファイルをsrcディレクトリ以下にあるファイルとしています。(```"include": ["src/**/*]```)

tsconfig.json

```
{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "ES2019",                          /* 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": "./",                       /* 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'). */

    /* Strict Type-Checking Options */
    "strict": false,                           /* Enable all strict type-checking options. */
    "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    "strictNullChecks": false,              /* Enable strict null checks. */
    "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    "strictPropertyInitialization": false,  /* 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 */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  },
  "include": [
    "src/**/*"
  ]
}
```

型チェックの厳しさに関しては、徐々に移行するために最初は緩めで設定しています。
```"strict": false```
```"noImplicitAny": false``` 
推論できない型もとりあえず許可する
```"strictNullChecks": false```
nullとundefinedを厳密に扱わない
```"strictPropertyInitialization": false```
クラスメンバの定義を厳密に扱わない

### 拡張子を.jsから.tsへ変更する & buildコマンドをpackage.jsonへ追加する。

以下のようにbuildを追加します。これで```npm run build```コマンドでコンパイルを実行することができます。

```
"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "tsc"
},
```

### コンパイルエラーが出てくるので、修正する。

エラーメッセージを元に修正をしていきます。
エラーがなくなったら、徐々に先ほど緩めに設定したルールを徐々に厳しくしていきます。

外部パッケージなどを使用する際に、型が付与されていなくてコンパイルできない場合があります。

その際は、基本的に型定義ファイル集Definitely Typedを利用します。
```npm search @types/パッケージ名```でパッケージをコマンドで検索したり、[TypeScript Types Search](https://www.typescriptlang.org/dt/search?search=)で検索することもできます。

自分の場合はプロジェクト内でpuppeteer等のライブラリを使用していたので、npm i @types/puppeteerで型定義パッケージをインストールしていました。

もし、使用したいパッケージの型定義集が公開されていない場合は、自分で型定義を記述する必要があります。(自分で書かないければいけない場合は、めったにないらしいですが。)

### 型チェックの厳しさの設定を徐々に上げる

最後は、tscongig.jsonの設定で、```"strict": true```にしてもコンパイルエラーが出ないように修正をしていきます。

これで以上です。
JavaScriptからTypeScriptへの移行が完了しました！