tspackage



TsPackage

TsPackage is a Typescript minifier and modular bundle optimizing compiler.

NOTICE

TsPackage is the replacement for TsProject. This is currently a work in progress. Please continue to use TsProject for now.

Top Features

• Bundling of ES6 external Typescript modules
• Bundle minification with identifier shortening and whitespace removal
• Cache optimized incremental project builds
• File glob pattern matching for project files

What's New

TsPackage 1.0.0 supports Typescript 2.x.

Why TsPackage?

TsPackage is the only Typescript 2.0 transpiler that provides minified, single file typescript bundles and javascript bundles for packaging of Typescript, javascript and Typescript definition files. TsPackage bundles file dependencies of external Typescript modules at compilation time rather than relying on build tools (AMD Optimizer, r.js for example ) further down in the build pipeline.

TsPackage Wiki

Additional details can be found on the TsProject wiki.

Typescript ES6 External Module Bundles

TsPackage supports a "bundles" property within the tsconfig.json project file. The "bundles" property may contain a list of named bundles. Each bundle must provide an array of source files and may optionally specify bundle configuration settings. The Typescript source file and its dependencies are packaged as a single Typescript file and output with the bundle name. The Typescript bundle is compiled to a single js javascript file and a single d.ts declaration file.

The following is a sample tsconfig.json showing the "bundles" property:

{
    "compilerOptions": {
        "module": "amd",
        "target": "es5",
        "noResolve": false,
        "declaration": true,
        "diagnostics": true
    },

    "files": [
        "index.ts",
        "page.ts",
        "common.ts",
		"plugin.ts"
    ],
    
    "bundles": {
        "app": {
            "files": [ "index.ts" ]
        },
        "components": {
            "files": [
                "page.ts",
                "plugin.ts"
            ],
            "config": {
			    "declaration": true,
                "outDir": "./bundles",
				"minify": true  
            }
        }
    }
}

How to install

npm install tspackage

API

tspackage.build( projectConfigPath: string, settings: any, ( result: BuildResult ) => {
	if ( !result.Succeeded() ){
		// Handle build errors...
	}
	else {
		// Build succeeded...
	}
});

Where:

projectConfigPath is a relative directory path to the default Typescript project file named "tsconfig.json". Or, projectConfigPath is a relative path to a named Typescript project file.

Building TsPackage

TsPackage depends on NPM as a package manager and Gulp as a build tool. If you haven't already, you'll need to install both these tools in order to build TsPackage.

Once Gulp is installed, you can build it with the following commands:

npm install
gulp build