yossydev Blog
rssgithub

node.jsのtsサポートに関して再度理解する

publishedAt:
2024/12/17
updatedAt:
2024/12/17
目次

2024年 ユウトの一人アドベントカレンダーの17日目の記事です。

Intro

Node.jsの--experimental-strip-typesと、--experimental-transform-typesについて再度理解します。

おさらい

--experimental-strip-typesを使うことで、TypeScriptファイルを実行できます。

この時は、TypeScriptの構文、EnumやNamespaceを使えません。 例えばEnumを使用すると、以下のようなエラーになります。

node:internal/modules/helpers:347
    throw new ERR_INVALID_TYPESCRIPT_SYNTAX(error);
          ^

SyntaxError [ERR_INVALID_TYPESCRIPT_SYNTAX]:   x TypeScript enum is not supported in strip-only mode
   ,-[1:1]
 1 | ,-> export enum Foo {
 2 | |       FOO,
 3 | |       BAR
 4 | `-> }
   `----

    at parseTypeScript (node:internal/modules/helpers:347:11)
    at stripTypeScriptTypes (node:internal/modules/helpers:372:25)
    at ModuleLoader.<anonymous> (node:internal/modules/esm/translators:475:16)
    at #translate (node:internal/modules/esm/loader:433:12)
    at ModuleLoader.loadAndTranslate (node:internal/modules/esm/loader:480:27) {
  code: 'ERR_INVALID_TYPESCRIPT_SYNTAX'
}

TypeScript enum is not supported in strip-only modeとなりますね。

そしてこれを解決するために生まれたのが、--experimental-transform-typesになります。 このフラグを有効にすることで、TypeScript独自の構文でも実行可能になります。

ちなみにこの時、--experimental-transform-typesは暗黙的に--experimental-strip-typesも含んでいるので、おそらく今なら以下のスクリプトだけで十分なはずです。

"run": "node --experimental-transform-types index.ts",

// > 暗黙的に`--experimental-strip-types`も含んでいる
// src: https://github.com/marco-ippolito/node/blob/e65928c6a10a6ae7983ccd3b3374d079ea3cb233/src/node_options.cc#L792-L798
  AddOption("--experimental-transform-types",
            "enable transformation of TypeScript-only"
            "syntax into JavaScript code",
            &EnvironmentOptions::experimental_transform_types,
            kAllowedInEnvvar);
  Implies("--experimental-transform-types", "--experimental-strip-types");
  Implies("--experimental-transform-types", "--enable-source-maps");

Amaroのスタックトレース保持方法

Node.jsではTypeScriptのトランスパイルにAmaroというswc typescript parserのラッパーを使用しています。

そしてこちらの面白いところが、スタックトレースのために、型を除いた分の空白をそのままにしておくそうです。

const amaro = require('amaro');
const { code } = amaro.transformSync("const foo: string = 'bar';", { mode: "strip-only" });
console.log(code); // "const foo         = 'bar';"

型排除により詰めた分、元のコードとトランスパイル後のコードの行数は変わってしまうので、デバッグしづらくなるのを防いでいる感じですね。

tsconfigは見ない

今回のNode.jsのtsサポートでは、tsconfigは読み込まれないようになっています。そのため、実行時の型チェックやエイリアスの設定、targetオプションの変更などはできないようになっています。

TypeScript features that depend on settings within tsconfig.json, such as paths or converting newer JavaScript syntax to older standards, are intentionally unsupported. To get full TypeScript support, see Full TypeScript support.

ここら辺は公式のfull typescrit supportを見るとわかります。tsxや、書かれてはないですがts-nodeを使用するようにみたいな感じらしいですね。

まとめ

筆者としてはtsconfigを読み込まないのはエイリアス以外にも結構辛いポイントは出ると思っているので、それだったらts-nodeでいいんじゃないかなと思っている派です。

ただDenoとかBunの影響を受けて、これだけのユーザー数がいるOSSが、誰もが待ち望んだ機能を入れてくれたのはやっぱりすごいなと思うので、引き続き応援していきたいです。

0