A simple CLI tool to generate documentation for TypeScript projects.

ts-docs is a command-line utility that processes TypeScript files, concatenating them while preserving their export order. It simplifies the process of merging exported TypeScript files into a single output file, making it easier to manage and share code.

Concatenates TypeScript files in topological order based on their exports. Removes import declarations from the output file. Easy to integrate into your build process

Install ts-docs as a global package:

npm install -g ts-docs

Or, add it as a dependency to your project:

npm install ts-docs --save-dev

Command Line

ts-docs -i <input_entry_path> -o <output_path>

• -i, --input : Input entry path (required)
• -o, --output : Output path (required)

Programmatically

import { concatTs } from "ts-docs";

concatTs({
  input: "path/to/input/entry.ts",
  output: "path/to/output/file.ts",
});

Example Given the following TypeScript files:

index.ts

export { default as Foo } from "./Foo";
export { default as Bar } from "./Bar";

Foo.ts

export default class Foo {
  // ...
}

Bar.ts

export default class Bar {
  // ...
}

Running the command:

ts-docs -i index.ts -o output.ts

Will produce the following concatenated output file:

output.ts

export default class Foo {
  // ...
}

export default class Bar {
  // ...
}

As you can see this is a simple concat and things such as the default exports will not be fixed. That being said, the files are topologically imported.

MIT License

npm run dev

Runs the CLI application.

You can pass arguments to your application by running npm run dev -- --your-argument. The extra -- is so that your arguments are passed to your CLI application, and not npm.

npm run clean

Removes any built code and any built executables.

npm run build

Cleans, then builds the TypeScript code.

Your built code will be in the ./dist/ directory.

npm run test

Cleans, then builds, and tests the built code.

npm run bundle

Cleans, then builds, then bundles into native executables for Windows, Mac, and Linux.

Your shareable executables will be in the ./exec/ directory.