Closed
6

TypeScriptことはじめ

環境整備

VSCode上での開発を想定。TypeScriptの環境を整えてみる。
JSのLinterとしてESLint、コードフォーマッターとしてPrettier入り。TypeDocも入れてみよう。

動作環境

Windows 10 Home 64bit

> node -v
v15.7
> npm -v
7.4.3
> yarn -v
1.22.5

やったこと

細かい設定は後から。

# package.json
yarn init -y
yarn add -D yarn-run-all

# ts-node … tscを使ってプリコンパイルなしにTypeScriptを実行するnpmパッケージ
# ts-node-dev … ts-nodeでwatchをするために必要
# typescript … TypeScriptコンパイラ
# @types/node … Nodeのデフォルトモジュールの型定義
yarn add -D ts-node ts-node-dev typescript @types/node

# init tsconfig
yarn run tsc --init

# ESLint
yarn add -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin

# Prettier
yarn add -D prettier eslint-config-prettier

# typedoc
yarn add -D typedoc

ESLint

静的検証ツールとして。

  • JS/TSで共用としたい
  • とりあえず一般的な設定で良い
  • ベストプラクティスってなんだ??

リファレンス

https://eslint.org/docs/user-guide/configuring/

設定(試行錯誤中)

eslintrc.yml
# 共有(JS/TS)
env:
  browser: true # document や console にエラーが出ないようにする
  node: true # document や console にエラーが出ないようにする
  es6: true
extends:
  - eslint:recommended
  - prettier
globals:
  Atomics: readonly
  SharedArrayBuffer: readonly
parserOptions:
  ecmaVersion: 2015
  sourceType: module
rules:
  no-var: warn
# TS向け
overrides:
  - files:
      - "*.ts"
      - "*.tsx"
    parser: "@typescript-eslint/parser"
    parserOptions:
      project: ./tsconfig.json
      sourceType: module
    plugins:
      - "@typescript-eslint"
    extends:
      - plugin:@typescript-eslint/eslint-recommended
      - plugin:@typescript-eslint/recommended
      - prettier/@typescript-eslint

Prettier

フォーマッタとして。

リファレンス

https://prettier.io/docs/en/options.html

設定(試行錯誤中)

.prettierrc.yml
trailingComma: 'es5'
tabWidth: 2
singleQuote: true
semi: true
parser: 'typescript'
.prettierignore
# Ignore artifacts:
out/
node_modules
package.json
package-lock.json
tsconfig.json
tsconfig.eslint.json
.eslintrc.yml
.prettierrc.yml

tsconfig.json

大事なやつ忘れてた。

  • どのファイルをコンパイルするか
  • どのモジュールシステムにコンパイルするか
  • コンパイル結果をどのディレクトリに格納するか

などを定義するもの。

https://www.typescriptlang.org/ja/tsconfig

に日本語のリファレンスがある。
何が正しいのかよくわからないので、迷ったらRecommended:の設定に近づけようかな。

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

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

    /* 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 */

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

このスクラップは2ヶ月前にクローズされました
ログインするとコメントできます