Skip to content

Commit 28a29ff

Browse files
committed
move tsconfig.json docs to the top. Closes basarat#9
1 parent 1cddee3 commit 28a29ff

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616
* [Async Await](docs/async-await.md)
1717
* [Generators](docs/generators.md)
1818
* [Project](docs/project/project.md)
19+
* [tsconfig.json](docs/project/tsconfig.md)
1920
* [Declaration Spaces](docs/project/declarationspaces.md)
2021
* [Modules](docs/project/modules.md)
2122
* [File Module Details](docs/project/external-modules.md)
2223
* [globals.d.ts](docs/project/globals.md)
2324
* [Namespaces](docs/project/namespaces.md)
24-
* [tsconfig.json](docs/project/tsconfig.md)
2525
* [TypeScript's Type System](docs/types/type-system.md)
2626
* [Ambient Declarations](docs/types/ambient-declarations.md)
2727
* [`lib.d.ts`](docs/types/lib.d.ts.md)

docs/project/project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project
22

3-
To create a successful project using TypeScript you need to understand the various project organization language features available. In this section we will cover declaration spaces, modules, and finally the concept of "compilation context".
3+
To create a successful project using TypeScript you need to understand the various project organization language features available. In this section we will cover "compilation context", declaration spaces and modules.
44

55

66
{% include "footer.md" %}

docs/project/tsconfig.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
## Compilation Context
2-
All of these spaces tie into a *compilation context*. The compilation context is basically just a fancy term for grouping of the files that TypeScript will parse and analyze to determine what is valid and what isn't. A great way to define this logical grouping (some people like to use the term *project*) is using a `tsconfig.json` file.
2+
The compilation context is basically just a fancy term for grouping of the files that TypeScript will parse and analyze to determine what is valid and what isn't. A great way to define this logical grouping (we also like to use the term *project*) is using a `tsconfig.json` file.
33

44

5-
### Basic
6-
It is extremely easy to get started with tsconfig.json as the basic file you need is:
5+
### Basic
6+
It is extremely easy to get started with tsconfig.json as the basic file you need is:
77
```json
88
{}
99
```
1010
i.e. an empty JSON file at the *root* of your project. This way TypeScript will include *all* the `.ts` files in this directory (and sub directories) as a part of the compilation context. It will also select a few sane default compiler options.
1111

1212
### compilerOptions
13-
You can customize the compiler options using `compilerOptions`.
13+
You can customize the compiler options using `compilerOptions`.
1414

1515
```json
1616
{

0 commit comments

Comments
 (0)