Development Tools for TypeScript Projects

• Provides a set of build tools.

  Such as build-z to bundle project files, or clean-z to clean the output.

• Provides configuration support for various development tools.

  Such as Rollup and Jest.

• Implies project layout.

  All development and build tools respect this layout.

• Maintains some project configuration files.

  Such as .gitignore and .npmignore.

Installation

Add @run-z/project-config to your project:

npm add --save-dev @run-z/project-config

and start using its tooling.

Project Layout

Project configuration implied to have the following directories:

• src/ directory for TypeScript sources.
• dist/ directory for distribution files.
• target/ directory for build targets not supposed to be published by NPM.

There is also a cache directory created automatically in temporary system directory.

This can me customized.

Build Tools

Build tools are scripts that can be added to project's package.json:

{
  "scripts": {
    "build": "build-z",
    "clean": "clean-z",
    "lint": "lint-z",
    "test": "test-z"
  }
}

Then these tools cab be invoked to perform particular tasks:

npm run clean  # Clean output
npm run lint   # Perform linting
npm run test   # Run project tests
npm run build  # Bundle project files

The following tools supported:

• build-z - transpiles and bundles TypeScript source files with Rollup.
• clean-z - cleans the output by deleting output directories (dist/, target/, and cache one, according to project layout).
• test-z - runs project tests with Jest.