From 635c4d81946d472e4297d50b96199e27a78cf9de Mon Sep 17 00:00:00 2001 From: leitao zhao Date: Thu, 25 Aug 2022 22:16:53 +0800 Subject: [PATCH 1/5] i18n: tsconfig-reference top-level options to zh --- docs/tsconfig/zh/intro.md | 20 +++++++-- docs/tsconfig/zh/options/exclude.md | 11 +++++ docs/tsconfig/zh/options/extends.md | 49 +++++++++++++++++++++ docs/tsconfig/zh/options/files.md | 26 ++++++++++++ docs/tsconfig/zh/options/include.md | 66 +++++++++++++++++++++++++++++ 5 files changed, 168 insertions(+), 4 deletions(-) create mode 100644 docs/tsconfig/zh/options/exclude.md create mode 100644 docs/tsconfig/zh/options/extends.md create mode 100644 docs/tsconfig/zh/options/files.md create mode 100644 docs/tsconfig/zh/options/include.md diff --git a/docs/tsconfig/zh/intro.md b/docs/tsconfig/zh/intro.md index f21815a6..298f9013 100644 --- a/docs/tsconfig/zh/intro.md +++ b/docs/tsconfig/zh/intro.md @@ -1,6 +1,18 @@ -## TSConfig 前言 +--- +header: TSConfig 介绍 +firstLine: TSConfig 文件象征着,它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录... +--- -目录中的 TSConfig 文件表明该目录是 TypeScript 或 JavaScript 项目的根目录。 -TSConfig 文件可以是 `tsconfig.json` 或 `jsconfig.json`，它们的配置项和行为相同。 -此页涵盖了 TSConfig 文件中可用的所有不同选项。本页从每个选项的概述开始，到 JSON 文件的根属性，然后是`compilerOptions`（大部分选项），最后是 `watchOptions`。 +TSConfig 文件象征着,它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录。 +TSConfig 文件可以是 `tsconfig.json` 或 `jsconfig.json`，它们的配置相同。 + +此页涵盖了 TSConfig 文件中可用的所有不同选项。同时没有按照线性叙述来构建,而是分为了5个主要部分: + +- 一个配置项的分类概览 +- [root fields](#Project_Files_0): 告知 TypeScript 那些文件需要被处理 +- [`compilerOptions`](#compilerOptions): 本页的主要内容 +- [`watchOptions`](#watchOptions): 配置监听模式 +- [`typeAcquisition`](#typeAcquisition): 配置 JavaScript 项目使用类型的方式 + +如果你是从零开始 TSConfig,可以考虑使用 `tsc --init` 或者 [TSConfig base](https://github.com/tsconfig/bases#centralized-recommendations-for-tsconfig-bases) 来进行配置 \ No newline at end of file diff --git a/docs/tsconfig/zh/options/exclude.md b/docs/tsconfig/zh/options/exclude.md new file mode 100644 index 00000000..6162b738 --- /dev/null +++ b/docs/tsconfig/zh/options/exclude.md @@ -0,0 +1,11 @@ +--- +display: "Exclude" +oneline: "过滤 [`include`](#include) 选项." +--- + +在解析 [`include`](#include) 选项时,需要跳过的文件名称或文件匹配器的列表. + +**Important**: `exclude` _仅仅_ 改变 [`include`](#include) 选项包含的文件. +`exclude` 指定的文件可能仍然是你代码的一部分,由于 被 `import` 引入到你的代码中 ,或者被 `types` 包含,或者使用 `/// + +``` +. +├── scripts ⨯ +│ ├── lint.ts ⨯ +│ ├── update_deps.ts ⨯ +│ └── utils.ts ⨯ +├── src ✓ +│ ├── client ✓ +│ │ ├── index.ts ✓ +│ │ └── utils.ts ✓ +│ ├── server ✓ +│ │ └── index.ts ✓ +├── tests ✓ +│ ├── app.test.ts ✓ +│ ├── utils.ts ✓ +│ └── tests.d.ts ✓ +├── package.json +├── tsconfig.json +└── yarn.lock +``` + +`include` 和 `exclude` 匹配器支持的匹配符: + +- `*` 匹配零个或多个字符 (不包含目录分割符) +- `?` 匹配任何一个字符 (不包含目录分割符) +- `**/` 匹配任何深度的目录 + +如果匹配器不包含文件拓展名,只支持特定拓展名的文件.默认支持 `.ts`, `.tsx`,和 `.d.ts`,如果开启了 [`allowJs`](#allowJs),额外支持 `.js` 和 `.jsx`. From f4388bc879760c39f97d045ada3f4c57667f82b2 Mon Sep 17 00:00:00 2001 From: TomVista <42435611+TomVista@users.noreply.github.com> Date: Fri, 26 Aug 2022 21:00:13 +0800 Subject: [PATCH 2/5] Update half width punctuation Co-authored-by: Xavi Lee --- docs/tsconfig/zh/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tsconfig/zh/intro.md b/docs/tsconfig/zh/intro.md index 298f9013..d5979314 100644 --- a/docs/tsconfig/zh/intro.md +++ b/docs/tsconfig/zh/intro.md @@ -4,7 +4,7 @@ firstLine: TSConfig 文件象征着,它所在的目录是一个 TypeScript 项 --- -TSConfig 文件象征着,它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录。 +TSConfig 文件象征着，它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录。 TSConfig 文件可以是 `tsconfig.json` 或 `jsconfig.json`，它们的配置相同。 此页涵盖了 TSConfig 文件中可用的所有不同选项。同时没有按照线性叙述来构建,而是分为了5个主要部分: From 17feb91b2eec1fe907882b8f72c5740810ed049a Mon Sep 17 00:00:00 2001 From: leitao zhao Date: Fri, 26 Aug 2022 21:09:57 +0800 Subject: [PATCH 3/5] Update half width punctuation --- docs/tsconfig/zh/intro.md | 6 +++--- docs/tsconfig/zh/options/exclude.md | 10 +++++----- docs/tsconfig/zh/options/extends.md | 2 +- docs/tsconfig/zh/options/files.md | 8 ++++---- docs/tsconfig/zh/options/include.md | 8 ++++---- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/tsconfig/zh/intro.md b/docs/tsconfig/zh/intro.md index d5979314..be673017 100644 --- a/docs/tsconfig/zh/intro.md +++ b/docs/tsconfig/zh/intro.md @@ -1,13 +1,13 @@ --- header: TSConfig 介绍 -firstLine: TSConfig 文件象征着,它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录... +firstLine: TSConfig 文件象征着，它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录... --- TSConfig 文件象征着，它所在的目录是一个 TypeScript 项目或者 JavaScript 项目的根目录。 TSConfig 文件可以是 `tsconfig.json` 或 `jsconfig.json`，它们的配置相同。 -此页涵盖了 TSConfig 文件中可用的所有不同选项。同时没有按照线性叙述来构建,而是分为了5个主要部分: +此页涵盖了 TSConfig 文件中可用的所有不同选项。同时没有按照线性叙述来构建，而是分为了5个主要部分: - 一个配置项的分类概览 - [root fields](#Project_Files_0): 告知 TypeScript 那些文件需要被处理 @@ -15,4 +15,4 @@ TSConfig 文件可以是 `tsconfig.json` 或 `jsconfig.json`，它们的配置 - [`watchOptions`](#watchOptions): 配置监听模式 - [`typeAcquisition`](#typeAcquisition): 配置 JavaScript 项目使用类型的方式 -如果你是从零开始 TSConfig,可以考虑使用 `tsc --init` 或者 [TSConfig base](https://github.com/tsconfig/bases#centralized-recommendations-for-tsconfig-bases) 来进行配置 \ No newline at end of file +如果你是从零开始 TSConfig，可以考虑使用 `tsc --init` 或者 [TSConfig base](https://github.com/tsconfig/bases#centralized-recommendations-for-tsconfig-bases) 来进行配置。 \ No newline at end of file diff --git a/docs/tsconfig/zh/options/exclude.md b/docs/tsconfig/zh/options/exclude.md index 6162b738..9b1ae968 100644 --- a/docs/tsconfig/zh/options/exclude.md +++ b/docs/tsconfig/zh/options/exclude.md @@ -1,11 +1,11 @@ --- display: "Exclude" -oneline: "过滤 [`include`](#include) 选项." +oneline: "过滤 [`include`](#include) 选项。" --- -在解析 [`include`](#include) 选项时,需要跳过的文件名称或文件匹配器的列表. +在解析 [`include`](#include) 选项时，需要跳过的文件名称或文件匹配器的列表。 -**Important**: `exclude` _仅仅_ 改变 [`include`](#include) 选项包含的文件. -`exclude` 指定的文件可能仍然是你代码的一部分,由于 被 `import` 引入到你的代码中 ,或者被 `types` 包含,或者使用 `/// Date: Sat, 27 Aug 2022 11:02:03 +0800 Subject: [PATCH 4/5] fix: extends options zh --- docs/tsconfig/zh/options/extends.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/tsconfig/zh/options/extends.md b/docs/tsconfig/zh/options/extends.md index eb82174a..b258788f 100644 --- a/docs/tsconfig/zh/options/extends.md +++ b/docs/tsconfig/zh/options/extends.md @@ -1,17 +1,16 @@ --- display: "Extends" -oneline: "Specify one or more path or node module references to base configuration files from which settings are inherited." oneline: "指定一个路径或者 node 模块引用用于配置继承" --- -`extends` 的值是要继承的配置文件的路径. -路径可以使用 POSIX 风格(Linux MacOS) 或者 Windows 风格(路径中的 `\` 需要转义) +`extends` 的值是要继承的配置文件的路径。 +路径可以使用 POSIX 风格(Linux MacOS) 或者 Windows 风格(路径中的 `\` 需要转义)。 -TSConfig 中的配置会覆盖继承的配置. 相对路径计算是以其所在配置文件为基准,不受继承影响. +TSConfig 中的配置会覆盖继承的配置。 相对路径计算是以其所在配置文件为基准，不受继承影响。 -注意: [`files`](#files), [`include`](#include) 和 `exclude` 会覆盖继承的配置,配置文件不允许循环继承. +注意: [`files`](#files)，[`include`](#include) 和 `exclude` 会覆盖继承的配置，配置文件不允许循环继承。 -[`references`](#references) 是唯一不被继承的顶级配置项. +[`references`](#references) 是唯一不被继承的顶级配置项。 ##### Example From c3aa6849d88c0e1bc9c79af3c07974fe5fb87aa7 Mon Sep 17 00:00:00 2001 From: TomVista <42435611+TomVista@users.noreply.github.com> Date: Fri, 23 Sep 2022 20:40:12 +0800 Subject: [PATCH 5/5] Update docs/tsconfig/zh/intro.md Co-authored-by: Xavi Lee --- docs/tsconfig/zh/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tsconfig/zh/intro.md b/docs/tsconfig/zh/intro.md index be673017..49d8b6cb 100644 --- a/docs/tsconfig/zh/intro.md +++ b/docs/tsconfig/zh/intro.md @@ -10,7 +10,7 @@ TSConfig 文件可以是 `tsconfig.json` 或 `jsconfig.json`，它们的配置 此页涵盖了 TSConfig 文件中可用的所有不同选项。同时没有按照线性叙述来构建，而是分为了5个主要部分: - 一个配置项的分类概览 -- [root fields](#Project_Files_0): 告知 TypeScript 那些文件需要被处理 +- [root fields](#Project_Files_0): 告知 TypeScript 哪些文件需要被处理 - [`compilerOptions`](#compilerOptions): 本页的主要内容 - [`watchOptions`](#watchOptions): 配置监听模式 - [`typeAcquisition`](#typeAcquisition): 配置 JavaScript 项目使用类型的方式