javascripttypescript

Do I have to reference TypeScript definition in every file?


Is there a way to tell TypeScript to use a certain file (or set of files) as a definition for everything compiled?

My only alternative currently is to add something like this in every single TypeScript file (which seems clunky):

/// <reference path="DefinitelyTyped/requirejs/require.d.ts" />

Solution

  • When using TypeScript's internal module system, you can avoid having any <reference> tags at all in the code. I personally do this because I don't want to encode paths (relative or absolute) within the code as I constantly move stuff around.

    One way to do this is by making sure all required declaration files and TypeScript source files are passed to the compiler as arguments during compile time.

    Using gulp together with gulp-typescript simplifies this task. You can set noExternalResolve in gulp-typescript to true, and create gulp tasks that take all your .d.ts files along with your sources and pipe it down to the compiler. When you pull in tsd into your stack, you only need to pass the tsd.d.ts file that contains references to all other definition files installed via tsd.

    UPDATE for TypeScript >= v1.5: you can use a tsconfig.json file, and the compiler will get the ordering of the classes right. This removes the need to use gulp-typescript altogether. You can either choose to have all files explicitly listed in the tsconfig.json file, or completely leave out the files property to include all *.ts/*.tsx files within the directory the tsconfig.json resides (including all subfolders).

    A sample tsconfig.json may look like:

    {
        "compilerOptions": {
            "target": "ES5",
            "module": "commonjs",
            "lib": [ "es5", "es2015.promise", "dom" ]
        },
        "include": [
            "src/**/*.ts"
        ]
    }