Skip to content

Commit 317ca90

Browse files
committed
Merge pull request #210 from TypeStrong/Fix-Reference-Docs
Improve documentation for `reference`
2 parents 714ed89 + 15e5eda commit 317ca90

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,19 +248,19 @@ grunt.initConfig({
248248

249249
#### reference
250250

251-
Grunt-ts can generate a reference TypeScript file which will contains a reference to all other found `.ts` files.
252-
253-
This means that the developer will not need to cross-reference files manually; instead they can just reference `reference.ts`.
251+
Grunt-ts can automatically generate a TypeScript file containing a reference to all other found `.ts` files. This means that the developer will not need to cross-reference each of their TypeScript files manually; instead, they can just reference the single `reference` file in each of their code files.
254252

255253
````javascript
256254
grunt.initConfig({
257255
ts: {
258256
default: {
257+
src: ["references.ts","some/other/path/**/*.ts"],
259258
reference: "references.ts"
260259
}
261260
}
262261
});
263262
````
263+
**Note:** the TypeScript file identified in the `reference` property *must* be included in the `src` or `files` property in the Grunt target, or `reference` won't work (either directly or via wildcard/glob).
264264

265265
*Warning:* Using the compiler with `out` and `reference` will prevent grunt-ts from using its fast compile feature. Consider using external modules with transforms instead.
266266

0 commit comments

Comments
 (0)