Ver código fonte

Add new topic: tsconfig.json

zhongsp 8 anos atrás
pai
commit
31481f8f80
5 arquivos alterados com 117 adições e 61 exclusões
  1. 26 6
      README.md
  2. 2 1
      SUMMARY.md
  3. 87 0
      doc/handbook/tsconfig.json.md
  4. 0 54
      doc/tsconfig.json.md
  5. 2 0
      preface.md

+ 26 - 6
README.md

@@ -1,18 +1,37 @@
 # TypeScript
+
 TypeScript is a superset of JavaScript that compiles to clean JavaScript output.  http://www.typescriptlang.org
 
-Please read: :book: [TypeScript手册中文版 - Published with GitBook](http://zhongsp.gitbooks.io/typescript-handbook/content/)
+请阅读 :book: [TypeScript Handbook 中文版 - Published with GitBook](http://zhongsp.gitbooks.io/typescript-handbook/content/)
+
+
+## 目录
+
+* [基础类型](./doc/handbook/Basic Types.md)
+* [枚举](./doc/handbook/Enums.md)
+* [变量声明](./doc/handbook/Variable Declarations.md)
+* [接口](./doc/handbook/Interfaces.md)
+* [类](./doc/handbook/Classes.md)
+* [命名空间和模块](./doc/handbook/Namespaces and Modules.md)
+* [命名空间](./doc/handbook/Namespaces.md)
+* [模块](./doc/handbook/Modules.md)
+* [函数](./doc/handbook/Functions.md)
+* [泛型](./doc/handbook/Generics.md)
+* [混入](./doc/handbook/Mixins.md)
+* [声明合并](./doc/handbook/Declaration Merging.md)
+* [类型推论](./doc/handbook/Type Inference.md)
+* [类型兼容性](./doc/handbook/Type Compatibility.md)
+* [书写.d.ts文件](./doc/handbook/Writing Definition Files.md)
+* [Iterators 和 Generators](./doc/handbook/Iterators and Generators.md)
+* [Symbols](./doc/handbook/Symbols.md)
+* [Decorators](./doc/handbook/Decorators.md)
+* [tsconfig.json](./doc/handbook/tsconfig.json.md)
 
 **TypeScript Handbook**
 
 * Read [TypeScript Handbook (Recommended, BUT not up to date officially)](http://www.typescriptlang.org/Handbook)
 * Read [TypeScript手册中文版 - Published with GitBook(持续更新中,最新版)](http://zhongsp.gitbooks.io/typescript-handbook/content/):book: 
 
-**Beyond Handbook && Latest features**
-
-* [tsconfig.json](./doc/tsconfig.json.md) (TypeScript 1.5)
-* [let和const](./doc/let_and_const.md) (TypeScript 1.4)
-
 **TypeScript Language Specification**
 
 * Read [TypeScript Language Specification (Recommended)](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md)
@@ -24,6 +43,7 @@ Please read: :book: [TypeScript手册中文版 - Published with GitBook](http://
 
 I'd love for you to contribute to the translation:)
 
+
 ## Using Gulp with TypeScript
 
 Install `gulp` and `gulp-typescript`. See [package.json](./package.json).

+ 2 - 1
SUMMARY.md

@@ -17,4 +17,5 @@
 * [书写.d.ts文件](./doc/handbook/Writing Definition Files.md)
 * [Iterators 和 Generators](./doc/handbook/Iterators and Generators.md)
 * [Symbols](./doc/handbook/Symbols.md)
-* [Decorators](./doc/handbook/Decorators.md)
+* [Decorators](./doc/handbook/Decorators.md)
+* [tsconfig.json](./doc/handbook/tsconfig.json.md)

+ 87 - 0
doc/handbook/tsconfig.json.md

@@ -0,0 +1,87 @@
+## 概述
+如果一个目录下存在一个`tsconfig.json`文件,那么它意味着这个目录是TypeScript项目的根目录。
+`tsconfig.json`文件中指定了用来编译这个项目的根文件和编译选项。
+`tsconfig.json`从TypeScript 1.5开始支持。
+一个项目通过以下方式之一来编译:
+
+## 使用tsconfig.json
+
+* 不带任何输入文件的情况下调用`tsc`,编译器会从当前目录开始去查找`tsconfig.json`文件,依次向上搜索父级目录。
+* 不带任何输入文件的情况下调用`tsc`,并且使用命令行参数`-project`(或`-p`)指定一个包含`tsconfig.json`文件的目录。
+
+当命令行上指定了输入文件时,`tsconfig.json`文件被忽略。
+
+## 示例
+
+`tsconfig.json`示例文件:
+
+* 使用`"files"`属性
+
+```json
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "noImplicitAny": true,
+        "removeComments": true,
+        "preserveConstEnums": true,
+        "out": "../../built/local/tsc.js",
+        "sourceMap": true
+    },
+    "files": [
+        "core.ts",
+        "sys.ts",
+        "types.ts",
+        "scanner.ts",
+        "parser.ts",
+        "utilities.ts",
+        "binder.ts",
+        "checker.ts",
+        "emitter.ts",
+        "program.ts",
+        "commandLineParser.ts",
+        "tsc.ts",
+        "diagnosticInformationMap.generated.ts"
+    ]
+}
+```
+
+* 使用`"exclude"`属性
+
+```json
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "noImplicitAny": true,
+        "removeComments": true,
+        "preserveConstEnums": true,
+        "out": "../../built/local/tsc.js",
+        "sourceMap": true
+    },
+    "exclude": [
+        "node_modules",
+        "wwwroot"
+    ]
+}
+```
+
+## 细节
+
+`"compilerOptions"`可以被忽略,这时编译器会使用默认值。在这里查看完整的[编译器选项](./Compiler Options.md)列表。
+
+如果`tsconfig.json`没有提供`"files"`属性,编译器会默认包含当前目录及子目录下的所有TypeScript文件(`*.ts` 或 `*.tsx`)。
+如果提供了`"files"`属性值,只有指定的文件会被编译。
+
+如果指定了`"exclude"`选项,编译器会包含当前目录及子目录下的所有TypeScript文件(`*.ts` 或 `*.tsx`),除了那些指定排队在外的文件和目录。
+
+`"files"`选项不能与`"exclude"`选项同时使用。如果同时指定了两个选项的话,只有`"files"`会生效。
+
+所有被`"files"`属性里的文件所引用的文件同样会被包含进来。
+就好比,`A.ts`引用了`B.ts`,因此`B.ts`不能被排队,除非引用它的`A.ts`在`"exclude"`列表中。
+
+`tsconfig.json`可以是个空文件,那么编译器则使用默认编译选项,编译当前目录及其子目录下的所有文件。
+
+命令行上提供的编译选项会覆盖`tsconfig.json`文件中的对应选项。
+
+## 模式
+
+到这里查看模式: [http://json.schemastore.org/tsconfig](http://json.schemastore.org/tsconfig)

+ 0 - 54
doc/tsconfig.json.md

@@ -1,54 +0,0 @@
-## 概述
-如果一个目录下存在一个`tsconfig.json`文件,那么它意味着这个目录是TypeScript项目的根目录。
-`tsconfig.json`文件中指定了用来编译这个项目的根文件和编译选项。
-`tsconfig.json`从TypeScript 1.5开始支持。
-一个项目可以用以下方法进行编译:
-
-
-## 使用tsconfig.json
-* 不带任何输入文件的情况下调用`tsc`,编译器会去查找`tsconfig.json`文件,从当前目录开始,依次向上搜索父级目录。
-* 不带任何输入文件的情况下调用`tsc`并且使用了命令行参数`-project`(或`-p`)指定一个包含`tsconfig.json`文件的目录。
-
-当命令行上指定了输入文件时,`tsconfig.json`被忽略。
-
-## 示例
-An example `tsconfig.json` file:
-```json
-{
-    "compilerOptions": {
-        "module": "commonjs",
-        "noImplicitAny": true,
-        "removeComments": true,
-        "preserveConstEnums": true,
-        "out": "../../built/local/tsc.js",
-        "sourceMap": true
-    },
-    "files": [
-        "core.ts",
-        "sys.ts",
-        "types.ts",
-        "scanner.ts",
-        "parser.ts",
-        "utilities.ts",
-        "binder.ts",
-        "checker.ts",
-        "emitter.ts",
-        "program.ts",
-        "commandLineParser.ts",
-        "tsc.ts",
-        "diagnosticInformationMap.generated.ts"
-    ]
-}
-```
-
-## 细节
-`"compilerOptions"`可以被忽略,编译器会使用默认值。编译选项的详细信息请参考[[Compiler Options]]文档。
-
-如果`tsconfig.json`没有提供`"files"`属性,编译器默认包含当前目录及子目录下的所有文件。如果提供了`"files"`属性值,只有这些文件会被编译。
-
-`tsconfig.json`可以是个空文件,如果为空则使用默认编译选项,编译当前目录及其子目录下的所有文件。
-
-命令行上提供的编译选项会覆盖`tsconfig.json`文件中的对应选项。
-
-## Schema
-到这里查看Schema: http://json.schemastore.org/tsconfig

+ 2 - 0
preface.md

@@ -39,10 +39,12 @@ TypeScript目前还在积极的开发完善之中,不断地会有新的特性
 * [Iterators 和 Generators](./doc/handbook/Iterators and Generators.md)
 * [Symbols](./doc/handbook/Symbols.md)
 * [Decorators](./doc/handbook/Decorators.md)
+* [tsconfig.json](./doc/handbook/tsconfig.json.md)
 
 
 ## 主要修改
 
+* 2015-12-06 新增章节:[tsconfig.json](./doc/handbook/tsconfig.json.md)
 * 2015-12-05 新增章节:[变量声明:let和const](./doc/handbook/Variable Declarations.md)
 * 2015-11-30 新增章节:[枚举](./doc/handbook/Enums.md)
 * 2015-11-28 新增章节:[Decorators](./doc/handbook/Decorators.md)