@stencila/typescript-boilerplate NPM

`@stencila/typescript-boilerplate`

What

An opinionated tooling setup for Typescript projects including,

typescript for compiling Typescript
jest for testing
typedoc for source code documentation
ts-node and ts-node-dev for running scripts during development

Usage

Just use this as an example when creating a new project. Check out the package.json and add or modify other files as needed...

A tsconfig.json file that extends or modifies the Typescript configuration in dev-config e.g.

{
  "extends": "@stencila/dev-config/tsconfig.json",
  "compilerOptions": {
    /* Enable experimental support for ES7 decorators. */
    "experimentalDecorators": true
  }
}

Add a jest configuration object to your package.json:

  // …
  "jest": {
    "preset": "ts-jest",
    "testEnvironment": "node",
    "testMatch": [
      "**/tests/**/*.test.ts"
    ]
  },
  // …

Create a typedoc.json file or modify the one in dev-config

{
  "out": "./docs",
  "readme": "./README.md"
}

Add scripts to your package.json file for running tests, collecting coverage, building the package and generating documetation:

  // …
  "scripts": {
    "test": "jest",
    "test:cover": "jest --collectCoverage",
    "test:watch": "jest --watch",
    "build": "tsc",
    "docs": "typedoc src"
  },
  // …

Add main, types and other entries in your package.json file to point to the compiled files in the dist folder:

  // …
  "main": "dist/src/index.js",
  "types": "dist/src/index.d.ts",
  "bin": "dist/src/cli.js",
  // …

Add the following folders to your .gitignore file:

/coverage
/dist
/docs

Stencila dev Typescript boilerplate configuration

@infinitebrahmanuniverse/nolb-_sten @everything-registry/sub-chunk-872

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago