これは、なにをしたくて書いたもの？
ちょっとTypeScriptを勉強してみようかなと思いまして。
簡単にコードを書いたり、環境設定をしてみます。
TypeScript
TypeScriptとは型安全な言語で、コンパイルするとJavaScriptに変換されます。
TypeScript: JavaScript With Syntax For Types.
言語そのものは情報が多いと思うので、ここではあまり書きません。
ドキュメント。
TypeScript: The starting point for learning TypeScript
今回は使いませんが、ライブラリや型宣言はこちらで検索するみたいです。
TypeScript: Search for typed packages
環境
今回の環境は、こちら。
$ node --version v16.13.0 $ npm --version 8.1.0
TypeScriptプロジェクトを作成する
では、まずはプロジェクトを作成しましょう。今回は、getting-startedというディレクトリを作成します。
$ mkdir getting-started $ cd getting-started
npm init。
$ npm init -y
ここからは、TypeScriptのダウンロードページを見ながら進めていきます。
TypeScript: How to set up TypeScript
TypeScriptのインストール。
$ npm i -D typescript
tscというコマンドで、コンパイラがインストールされます。
$ npx tsc --version Version 4.4.4
この時の、package.json。
package.json
{ "name": "getting-started", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { "typescript": "^4.4.4" } }
次は、ソースコードを書いていきましょう。こちらを参考にしながら。
TypeScript: Documentation - TypeScript Tooling in 5 minutes
$ mkdir src
こんなソースコードを作成。
src/index.ts
class Person { firstName: string; lastName: string; constructor(firstName: string, lastName: string) { this.firstName = firstName; this.lastName = lastName; } greetingMessage(): string { return `Hello, my name is "${this.firstName} ${this.lastName}"!!`; } } let p = new Person("カツオ", "磯野"); console.log(p.greetingMessage());
tscコマンドでコンパイル。
$ npx tsc src/index.ts
同じディレクトリに.jsファイル（JavaScript）が作成されるので
$ ll src 合計 16 drwxrwxr-x 2 xxxxx xxxxx 4096 10月 30 23:18 ./ drwxrwxr-x 6 xxxxx xxxxx 4096 10月 30 23:18 ../ -rw-rw-r-- 1 xxxxx xxxxx 390 10月 30 23:18 index.js -rw-rw-r-- 1 xxxxx xxxxx 463 10月 30 23:18 index.js.map
これをnodeで実行。
$ node src/index.js Hello, my name is "カツオ 磯野"!!
動きました。
ここで、いったん生成されたJavaScriptを削除しておきます。
$ rm src/index.js
tsconfig.json
TypeScriptのプロジェクト設定は、tsconfig.jsonというファイルで行うようです。
TypeScript: Documentation - What is a tsconfig.json
tsconfig.jsonでは、ルートファイルやコンパイルオプションを指定するようです。
tsconfig.jsonは、tsc --initで作成できるようです。
$ npx tsc --init
生成されたtsconfig.jsonファイル。
tsconfig.json
{ "compilerOptions": { /* Visit https://aka.ms/tsconfig.json to read more about this file */ /* Projects */ // "incremental": true, /* Enable incremental compilation */ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */ // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ /* Language and Environment */ "target": "es5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ // "jsx": "preserve", /* Specify what JSX code is generated. */ // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */ // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */ // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */ // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ /* Modules */ "module": "commonjs", /* Specify what module code is generated. */ // "rootDir": "./", /* Specify the root folder within your source files. */ // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */ // "types": [], /* Specify type package names to be included without being referenced in a source file. */ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ // "resolveJsonModule": true, /* Enable importing .json files */ // "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */ /* JavaScript Support */ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */ /* Emit */ // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ // "declarationMap": true, /* Create sourcemaps for d.ts files. */ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */ // "outDir": "./", /* Specify an output folder for all emitted files. */ // "removeComments": true, /* Disable emitting comments. */ // "noEmit": true, /* Disable emitting files from a compilation. */ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ // "newLine": "crlf", /* Set the newline character for emitting files. */ // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */ // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */ // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */ // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ /* Interop Constraints */ // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ /* Type Checking */ "strict": true, /* Enable all strict type-checking options. */ // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */ // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */ // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */ // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */ // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */ // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */ // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */ // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */ // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ /* Completeness */ // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ "skipLibCheck": true /* Skip type checking all .d.ts files. */ } }
ほとんどがコメントアウトされていますが、めちゃくちゃ項目多いですね…。
tsconfig.jsonのリファレンスは、こちら。
TypeScript: TSConfig Reference - Docs on every TSConfig option
今回は、これくらいの設定にしました。
tsconfig.json
{ "compilerOptions": { "target": "esnext", "module": "commonjs", "baseUrl": "./src", "outDir": "dist", "strict": true, "noImplicitAny": true, "forceConsistentCasingInFileNames": true, "esModuleInterop": true, "sourceMap": true, "skipLibCheck": true }, "include": [ "src" ] }
moduleの設定は、今回はNode.jsなのでCommonJSを選ぶ感じですかね。
Modules: CommonJS modules | Node.js v20.5.1 Documentation
あと、コンパイル対象のディレクトリはsrcにして、出力先はdistにしておきました。
これでtscコマンドでソースコードを指定しなくてもコンパイルできるようになります。
$ npx tsc
実行。
$ node dist/index.js Hello, my name is "カツオ 磯野"!!
distディレクトリは、こんな感じになっています。今回はSource Mapを生成するようにしているので、そちらも
ありますね。
$ ll dist 合計 16 drwxrwxr-x 2 xxxxx xxxxx 4096 10月 30 19:14 ./ drwxrwxr-x 5 xxxxx xxxxx 4096 10月 30 21:38 ../ -rw-rw-r-- 1 xxxxx xxxxx 361 10月 30 21:40 index.js -rw-rw-r-- 1 xxxxx xxxxx 431 10月 30 21:40 index.js.map
TypeScript ESLintを使う
lintも有効にしてみましょう。TypeScript ESLintを使うようです。
tslintというものもあるのですが、こちらは非推奨になっているようです。
こちらを見ながら
https://typescript-eslint.io/docs/linting/linting
TypeScript ESLintのインストール。
$ npm i -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
バージョン。
$ npx eslint --version v8.2.0
"@typescript-eslint/eslint-plugin": "^5.4.0", "@typescript-eslint/parser": "^5.4.0", "eslint": "^8.2.0",
eslint --initで、ESLintの設定ファイルが作成されます。
$ npx eslint --init
対話形式になるので、こんな感じで選択。
How would you like to use ESLint? · problems
✔ What type of modules does your project use? · esm
✔ Which framework does your project use? · none
✔ Does your project use TypeScript? · No / Yes
✔ Where does your code run? · node
✔ What format do you want your config file to be in? · JavaScript
The config that you've selected requires the following dependencies:
@typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest
✔ Would you like to install them now with npm? · No / Yes
Successfully created .eslintrc.js file in /path/to
TypeScriptも選択肢にあり、ここでTypeScript ESLintをインストールすることもできたみたいです。
できあがったファイル。
.eslintrc.js
module.exports = { "env": { "es2021": true, "node": true }, "extends": [ "eslint:recommended", "plugin:@typescript-eslint/recommended" ], "parser": "@typescript-eslint/parser", "parserOptions": { "ecmaVersion": 13, "sourceType": "module" }, "plugins": [ "@typescript-eslint" ], "rules": { } };
lintをかけてみましょう。
$ npx eslint src --ext .js,.ts
console.logがエラーになりました…。
$ npx eslint src --ext .js,.ts /path/to/src/index.ts 15:5 error 'p' is never reassigned. Use 'const' instead prefer-const ✖ 1 problem (1 error, 0 warnings) 1 error and 0 warnings potentially fixable with the `--fix` option.
再代入しないなら、constにするべきです、と。
修正して
const p = new Person("カツオ", "磯野");
確認。
$ npx eslint src --ext .js,.ts
今度はOKになりました。
フォーマッターPrettierを使う
コードフォーマッターも入れておきましょう。Prettierというものが良さそうです。
Prettier · Opinionated Code Formatter
ドキュメントを見ながら
インストール。
$ npm i -D -E prettier
バージョン。
$ npx prettier --version 2.4.1
設定ファイルを、空で作成します。
$ echo {} > .prettierrc.json
フォーマット。
$ npx prettier --write src
なお、ESLintはコードスタイルに関するルールも持つため、Prettierと競合する場合はこちらを参照。
ESLintのコードスタイルルールとPrettierを合わせて使う時には、eslint-config-prettierを使う - CLOVER🍀
Emacsでtypescript-mode
ソースコードを書くのは、Emacsを使います。typescript-modeをインストールしましょう。
GitHub - emacs-typescript/typescript.el: TypeScript-support for Emacs
Emacsの設定は、こんな感じにしました。
(require 'typescript-mode) (add-hook 'typescript-mode-hook '(lambda () (setq typescript-indent-level 2))) (add-to-list 'auto-mode-alist '("\.ts$" . typescript-mode)) (require 'ansi-color) (defun colorize-compilation-buffer () (ansi-color-apply-on-region compilation-filter-start (point-max))) (add-hook 'compilation-filter-hook 'colorize-compilation-buffer)
M-x compileでnpx tscを実行すると、Emacs上でコンパイルできるようになります。
lsp-mode
最後はlsp-modeを導入します。こちらを使いましょう。
JavaScript/TypeScript (theia-ide) - LSP Mode - LSP support for Emacs
Language Serverとしては、TypeScript Language Serverというものを使うみたいです。
自分でインストールしてもいいのですが、以下の設定のようにEmacsを設定して
※lsp-mode自体は設定しているものとします
(require 'typescript-mode) (add-hook 'typescript-mode-hook '(lambda () (setq typescript-indent-level 2))) (add-to-list 'auto-mode-alist '("\.ts$" . typescript-mode)) (require 'ansi-color) (defun colorize-compilation-buffer () (ansi-color-apply-on-region compilation-filter-start (point-max))) (add-hook 'compilation-filter-hook 'colorize-compilation-buffer) (use-package lsp-mode :ensure t :commands (lsp lsp-deferred) :hook (typescript-mode . lsp-deferred))
TypeScriptソースコードを読み込むと、Language Serverの自動インストールをするか聞かれるので、そちらで
指定すればOKです。
選択肢はeslist、graphql-lsp、jsts-ls、ts-lsの4つで、TypeScript Language Serverはts-lsです。
jsts-lsはなんだろう？と思ったのですが、こちらですね。メンテナンスは終了しているみたいです。
こんな感じでしょうか、これでTypeScriptを始められるようになりましたかね？
