build-tools-typescript v1.5.0

build-tools-typescript

Set of tools and configurations to work with TypeScript: compiler, linter and documentation.

• Compiler: default configs for tsc.
• Linter: eslint runner and adidas linter configs.
• TypeScript documentation: based on typedoc tool.

Install

npm install --save-dev build-tools-typescript

Usage

Extend your tsconfig.json with build-tools-typescript:

{
  "extends": "build-tools-typescript",
  "compilerOptions": {
    "outDir": "dist"
  },
  "files": [
    "src/index.ts"
  ]
}

To use adidas linter configurations check https://github.com/adidas/js-linter-configs/tree/master/packages/eslint-config-adidas-typescript.

You can run typedoc as you would normally do, e.g:

npx typedoc --out docs

Links

• Base configuration
• TypeScript
• ESLint TypeScript
• TypeDoc