TypeScript で バッチジョブを開発するときのボイラープレート

TypeScript で バッチジョブを開発するときのボイラープレート

TypeScript を使用していますか? 私はTypeScriptを愛用しています。理由としては、

  1. Node モジュールを使用できるためかなり効率よく開発が進むこと
  2. ソースコードの自動補完機能があること
  3. 型定義されているためソースコードが分かりやすくなること

の3点です。

この記事では、TypeScript でバッチジョブを開発するときのボイラープレートを紹介します。

このボイラープレートが提供する機能

このボイラープレートは以下の機能を提供します。

  1. src ディレクトリにソースコードを配置
  2. dist ディレクトリ にコンパイル済み js ファイルを出力
  3. tsc --watch によるソースコードの自動コンパイル
  4. @types/node のインストール

各種ファイルダウンロード

下準備1:typescript をインストールする

TypeScript のインストールが未だの場合は、インストールしましょう。


npm install -g typescript

下準備2:package.json を作成する

まず、npm init -y で package.json を作成しましょう。


D:\ts-batch-boilar>npm init -y
Wrote to D:\ts-batch-boilar\package.json:
{
  "name": "ts-batch-boilar",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

下準備3:tsconfig.json を作成する

次に、tsconfig.json を作成します。


D:\ts-batch-boilar>tsc --init
message TS6071: Successfully created a tsconfig.json file.

package.json を修正する

以下のように package.json を修正します。

  1. scripts に watch スクリプトを追加
  2. dependencies に @types/node を追加
{
  "name": "ts-batch-boilar",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "watch": "tsc -watch"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@types/node": "^12.0.4"
  }
}

tsconfig.json を修正する

以下のように tsconfig.json を修正します。

  1. outDir にコンパイル先ディレクトリを指定
  2. rootDir にソースディレクトリを指定
  3. typeRoots に Node Modules の @types を指定
  4. include にコンパイル対象ソースを指定
  5. exclude にコンパイル対象外のソースを指定
{
  "compilerOptions": {
    /* Basic Options */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 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 */
    // "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. */

    /* 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": [
      "node_modules/@types"
    ],                       /* List of folders to include type definitions from. */
    "types": [
      "node"
    ],                           /* 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. */

    /* 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. */
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules",
    "**/*.spec.ts"
  ]
}

src ディレクトリ と dist ディレクトリを作成する

src ディレクトリ と dist ディレクトリを作成します。

  • srcディレクトリは、ソースコード(tsファイル)を格納するフォルダです。
  • dist ディレクトリは、コンパイル済み js ファイルが出力されるフォルダです。

npm install で パッケージをインストールする

npm install でパッケージをインストールします。

以上

想定どおりの動作をしているか確認してみましょう。

返信を残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です