はじめに
TypeScriptを業務で扱うことが増えたので、0から環境構築する方法をまとめました。今回は、tsconfigとWebpackの設定をして、画面に「Hello World」を表示させたいと思います。
開発環境
はじめにnodeを入れましょう.
$ node -v
v16.5.0
TypeScriptの環境構築
１. 開発用ディレクトリの作成
$ mkdir ts-basic
２. npmの初期化
$ npm init
３. 関連パッケージのインストール
$ npm install --save-dev typescript ts-loader webpack webpack-cli webpack-dev-server
package.jsonが作成されるので、本番環境用のbuildコマンドと開発環境用のsrartコマンドをscriptsに記入します。
package.json
{
"name": "ts-basic",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"build": "webpack --mode=production",
"start": "webpack-cli serve --mode development"
},
"author": "",
"license": "ISC",
"devDependencies": {
"ts-loader": "^9.2.5",
"typescript": "^4.3.5",
"webpack": "^5.51.1",
"webpack-cli": "^4.8.0",
"webpack-dev-server": "^4.0.0"
}
}
４. webpack.config.jsの作成と設定
TypeScriptで開発するための設定をします。
$ touch webpack.config.js
webpack.config.js
const path = require("path");
module.exports = {
// モジュールバンドルを行う起点となるファイルの指定
// 指定できる値としては、ファイル名の文字列や、それを並べた配列やオブジェクト
// 下記はオブジェクトとして指定した例
entry: {
bundle: "./src/index.ts",
},
// モジュールバンドルを行った結果を出力する場所やファイル名の指定
output: {
path: path.join(__dirname, "dist"), // "__dirname"はファイルが存在するディレクトリ
filename: "[name].js", // [name]はentryで記述した名前（この設定ならbundle）
},
// import文でファイル拡張子を書かずに名前解決するための設定
// 例...「import World from './world'」と記述すると"world.ts"という名前のファイルをモジュールとして探す
resolve: {
extensions: [".ts", ".js"], // Reactの.tsxや.jsxの拡張子も扱いたい場合は配列内に追加する
},
devServer: {
static: {
directory: path.join(__dirname, "dist"),
}, // webpack-dev-serverの公開フォルダ
open: true, // サーバー起動時にブラウザを開く
},
// モジュールに適用するルールの設定（ローダーの設定を行う事が多い）
module: {
rules: [
{
// 拡張子が.tsのファイルに対してTypeScriptコンパイラを適用する
// Reactで用いる.tsxの拡張子にも適用する場合は test:/\.(ts|tsx)$/,
test: /\.ts$/,
loader: "ts-loader",
},
],
},
};
５. tsconfig.jsonの作成と設定
$ tsc --init
message TS6071: Successfully created a tsconfig.json file.
上記のコマンドを行うと、tsconfig.jsonが作成されます。基本的にはデフォルトでOKですが、outDirとbaseUrlを変更しました。
-
outDir: コンパイル後のファイルを置く場所を設定 -
baseUrl: インポート文を絶対パスで書けるようにする設定
tsconfig.json
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', 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', 'react', 'react-jsx' or 'react-jsxdev'. */
// "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. コンパイル後のファイルを./distに置く設定 */,
// "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": 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. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
"baseUrl": "./src" /* 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. */
}
}
ここまででTypeScriptの環境構築ができました。
画面にHello Worldを作成する。
distフォルダを作成し、htmlのindexファイルを作成します。
dist/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>TypeScriptの環境構築</title>
</head>
<body>
<div id="root"></div>
<script src="bundle.js"></script>
</body>
</html>
次にHello Worldを表示するためのTypeScriptのファイルをsrcフォルダを作成し、用意します。
src/index.ts
import World from "./world"; //webpack.config.jsのresolveに設定があるため、拡張子は不要
const root: HTMLElement | null = document.getElementById("root");
const world = new World("Hello World!!!!");
world.sayHello(root);
src/world.ts
export default class World {
// クラスで使うプロパティ
message: string;
// コンストラクタ（初期化）
constructor(message: string) {
this.message = message;
}
// 外部から呼び出せるメソッドを定義
public sayHello(elem: HTMLElement | null) {
if (elem) {
elem.innerText = this.message;
}
}
}
npmコマンドで実行します。
- 開発用
$ npm start
画面に"Hello World!!!!"が表示されれば成功です。
- 本番用
$ npm build
distフォルダにbundle.jsが作成されれば成功です。
次はコードの品質を上げるためにESLintとPrettierを設定します。