Converts import/require-style TypeScript directories into a unified namespace output.
TypeScript JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
src
test
typings
.gitattributes
.gitignore
.npmignore
README.md
gulpfile.js
package.json
tsconfig.json
tslint.json

README.md

Typespace

Converts import/require-style TypeScript directories into a unified namespace output.

Why?

AMD, CommonJS, UMD, and the like are wonderful dependency managers that you should strongly consider using in your project. However, in some browser applications, it's useful to have a single smaller file without the overhead of exports or require.

  • Video games that require extremely rapid startup times
  • Older applications that haven't moved to something like require.js

That's where Typespace comes in. It takes a full set of directories containing TypeScript files that reference each other using import and/or require, and combines them into a single .ts output file.

Sources:

// src/Foo.ts
export var value = true;
// src/Bar.ts
import { Value } from "./Foo";
console.log(`Value: ${value}`);

Output:

namespace MyProject.Foo {
    export var Value = true;
}

namespace MyProject.Bar {
    import Value = MyProject.Foo.Value;
    console.log(`Value: ${Value}`);
}

(in the future, these will be combined and optimized for a reduced file size)

Usage

You can use Typespace via require/import or on the command-line. There's also a gulp plugin.

Required arguments/flags:

  • namespace (-n/--namespace) - name of the root namespace

Optional arguments/flags:

  • config (-c/--config) - input tsconfig.json file path to load files from
  • outFile (-o/--outFile) - output .ts file path
  • pathPrefix (-p/--pathPrefix) - directory root to ignore from module paths
  • root (-r/--root) - root path to search for files under
  • target (-t/--target) - module resolution target, as "none" or "commonjs"

CLI

First install Typespace with npm install typespace.

You can then specify files from a TypeScript config file:

typespace --directory . --root src --outFile dist/combined.ts --config tsconfig.json

Code

const Typespace = require("typespace");

const settings = {
    config: "tsconfig.json",
    directory: ".",
    outFile: "dist/combined.ts",
    root: "src"
};

const converter = new Typespace(settings);
converter.convert()
    .then((fileContents: string): void => {
        console.log(`Printed to ${settings.outFile}:\n${fileContents}`);
    });

Building

Typespace is built using Gulp.

npm install -g gulp-cli
npm install
gulp

The primary Gulp tasks are:

  • tslint - lints source code with TSLint
  • tsc - compiles source code with TypeScript
  • test - runs tests
  • watch - runs Gulp whenever a source or test file changes

Compilation

Source files are in TypeScript and primarly rely on async/await programming. Babel is used for Node compatibility.

Tests

Tests files are in JavaScript and run with Mocha. Test coverage for unit tests is computed with Istanbul.