スポンサーリンク

【TypeScript】TypeScriptの「tsconfig.json」とは?ファイル内の記述の説明。

TypeScript
スポンサーリンク
スポンサーリンク

TypeScriptの作る「tsconfig.json」とは?ファイル内の記述の説明。

私がTypeScriptを勉強し始めて1日が経とうとしているのですが、ようやくTypeScriptの全体像がみえてきたように思います。

そもそもどのように勉強すればいいかに関してもコチラの記事にまとめておきますので気になるかたはご参照ください。

さて本題に入りますが「tsconfig.json」のファイルの中身を見たことがありますでしょうか。

TypeScriptではこのファイルがかなり重要になってきます。例えばこのファイルをいじることで複数のトランスファーを一つのコード行ったりすることができたり、ブラウザで用いることができます。

要はどうやってコンパイルするかと言うことです。

では中身を追っていきましょう。

まずはファイルの作り方です!

ターミナルなりコマンドプロンプトなりで下記を記述しましょう。

tsc --init

特定のフォルダの中に作った方がいいかもです。では中身!

まず中身の記述の仕方がなかなかやばくなっており私は初めてみた瞬間みやすくしてやろうとコメントアウトを消していました。笑

ほんとは消しちゃダメです。

{
  "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": "./",                        /* 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": 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. */
  }
}

コメントアウトされている箇所に関してはデフォルトでは使われていませんが使うとなったらコメントアウトを外して使うようです。

つまり、作業フォルダ内のTypeScriptの機能を拡張させるためのファイルと考えて良いと思います。

まずこのファイルの使われかたですがコンパイル時に参照されているようです。参照しないやり方もあります。

tsc              //参照されている。

//or

tsc ファイル名.ts //参照せずにこの指定のファイルのみをコンパイルしている。

つまりコンパイルする際はこのファイルがあるなら「tsc」と実行するのが正解なのかもですね。

ではこのファイルの上の方から順番に重要なのをみていきましょう。

「”target”: “es5”,」

ECMAScriptのVerを指定しています。
何か使用する際に別のECMAScriptのVerを使用したい場合記載を変更してください。

「”module”: “commonjs”,」

「// “lib”: [],」

コンパイルする際の型を指定できます。「npm install typescript」のコードの際に一緒にインストールしてきたファイルに型の定義ようのファイルが実はあります。コンパイルする際にこのファイルは実は参照されているようです。
例えば「console.log()」と言うものもこの中にあるのでこれが指定されていないとエラーに繋がります。

これがコメントアウトされている場合は「”target”: “es5”,」を参照しているのでエラーが起きません。仮にコメントアウトを外して、空欄のままだと色々なエラーが発生します。仮にコメントアウトを使用する場合は下記のようにすれば大丈夫です。

"lib": ["ES5"],

「// “allowJs”: true,」

これはjsファイルも合わせてコンパイルするかと言うもの。コンパイルが二重になることも考えられますがそれも設定で変更できるようです。

「// “checkJs”: true,」

エラーのチェックに関する設定

「// “jsx”: “preserve”,」

Reactを使用する際に用いる。

「// “sourceMap”: true,」

コチラは本当に大事です。TypeScriptとjavascriptの架け橋みたいな感じでブラウザでTypeScriptを用いる際に使用します。ブラウザはTypeScriptを理解できませんが、この機能によって理解できるようになります。

「// “outDir”: “./”,」

これはコンパイルした際に生成されるjsファイルをどこに出力するかを設定できます。

"outDir": "./test"

これでtestフォルダがあればそこにコンパイルしてできたjsファイルが格納されます。

その他の機能

このファイルに追加できる要素「exclude」「include」コンパイル時にコンパイルするものを除外、追加できる要素。これの強みはワイルドカードを使えるとです。

例えば下記のように記述を行います。

///一番したとかに記述する

  "exclude":[
    "node_modules"  //これはexcludeを記述すると入っているそうですが別の要素とかを入れる場合追加する必要あり
    "*.ts"  //これでこの拡張子はコンパイルできなくなるとか
    "**/compailer.ts"  //階層がどこになろうがこのファイルはコンパイルから省かれる
  ]
}

まあこんな感じで「include」の場合も同じように指定できますが「include」「exclude」では後者の方が優先して指定されるので理解することでよりコンパイルを指定できます。

似ている要素に「files」と言う要素もありますがそちらはpathで指定するみたいな感じです。

こんな感じで私が理解できている、試した機能をまとめました。

他の設定もいじることでより高いレベルの開発ができるんだろうなー

コメント

  1. […] 【TypeScript】TypeScriptの「tsconfig.json」とは?ファイル内の記述の説明。 […]

  2. […] 作成されたtsconfig.jsonの出力先に関係のある箇所を修正します。tsconfig.jsonの中身の大体の説明は別記事にありますので気になるかたはこちらをご参照ください。 […]

タイトルとURLをコピーしました