Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhengqbbb committed Nov 1, 2024
1 parent d3c010f commit 8e7cea5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ https://cdn.jsdelivr.net/gh/Zhengqbbb/cz-git@{{ v }}/docs/public/schema/cz-git.j

- Added in `cz-git`, `czg` version `v1.11.0`
- Will use Node.js LTS version >= `v22.11.0` ==experimental feature==, **native TypeScript configuration file loading**<br>==Need injection of experimental options== `NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning'` to use
- For details, [see Node.js documentation](https://nodejs.org/api/cli.html#--experimental-transform-types) | [Node.js TypeScript support roadmap](https://github.com/nodejs/loaders/issues/217)
- For details: [see Node.js documentation](https://nodejs.org/api/cli.html#--experimental-transform-types) | [Node.js TypeScript support roadmap](https://github.com/nodejs/loaders/issues/217)
- ==TIP==: You can first use [ESM js](#javascript-template) configuration files as a transition for future TypeScript configuration files, and switch after Node.js runs TypeScript stably

::::: details Click to expand `NODE_OPTIONS` injection methods
:::: code-group
Expand Down
3 changes: 2 additions & 1 deletion docs/zh/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ https://cdn.jsdelivr.net/gh/Zhengqbbb/cz-git@{{ v }}/docs/public/schema/cz-git.j

-`cz-git`, `czg``v1.11.0` 版本开始
- 将使用 Node.js LTS 版本 >= `v22.11.0`==实验性功能==, **原生加载 TypeScript 配置文件**<br>==需注入开启实验性的参数== `NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning'` 使用
- 详情[可查看 Node.js 文档](https://nodejs.org/api/cli.html#--experimental-transform-types) | [Node.js TypeScript 支持路线图](https://github.com/nodejs/loaders/issues/217)
- 详情: [可查看 Node.js 文档](https://nodejs.org/api/cli.html#--experimental-transform-types) | [Node.js TypeScript 支持路线图](https://github.com/nodejs/loaders/issues/217)
- ==建议==: 可先在使用 [ESM js](#javascript-%E6%A8%A1%E6%9D%BF) 配置文件作为未来 TypeScript 配置文件的过渡,待 Node.js 运行 TypeScript 稳定后,再进行切换

::::: details 点击展开 `NODE_OPTIONS` 注入方式
:::: code-group
Expand Down

0 comments on commit 8e7cea5

Please sign in to comment.