build.md

parent	nav_order
CLI	6

Build code

---

skuba uses tsc or esbuild to transpile your TypeScript source code to JavaScript output.

The resulting output can be executed with a regular Node.js runtime, or in the case of packages, consumed in other projects without the need for additional transpilation.

See our esbuild topic for further deliberation over our choice of build tool.

---

skuba build

Compiles your project.

skuba build

# TSFILE: ...

By convention, this points to a tsconfig.build.json that excludes tests from your production bundle.

// tsconfig.build.json
{
  "exclude": ["**/__mocks__/**/*", "**/*.test.ts", "src/testing/**/*"],
  "extends": "tsconfig.json",
  "include": ["src/**/*"],
}

// tsconfig.json
{
  "compilerOptions": {
    "outDir": "lib",
  },
  "exclude": ["lib*/**/*"],
}

Run skuba configure if you don't already have this file.

With tsc, you can supply any compiler option with the following caveats:

1. Long-form option names must use a double -- prefix rather than a single - prefix
2. Complex configurations make it difficult to port your project between build tools

With esbuild, you can supply the following options:

Option	Description
--debug	Enable debug console output
--project	Point to a different tsconfig.json file

Bundling assets

To bundle additional assets alongside your build, add an assets field inside the skuba section within your package.json.

{
  "skuba": {
    "entryPoint": "src/index.ts",
    "template": "koa-rest-api",
    "type": "application",
    "version": "8.1.0",
    "assets": ["**/*.vocab/*translations.json"]
  }
}

In this example, all *.vocab/*translations.json files found within src will be copied into the corresponding lib directory.

---

skuba build-package

Compiles your project for compatibility with CommonJS and ES2015 modules.

This is useful for building isomorphic npm packages.

skuba build-package

# commonjs │ TSFILE: ...
# commonjs │ tsc exited with code 0
# es2015   │ TSFILE: ...
# es2015   │ tsc exited with code 0
# types    │ TSFILE: ...
# types    │ tsc exited with code 0

skuba build-package runs operations concurrently up to your CPU core count. On a resource-constrained Buildkite agent, you can limit this with the --serial flag. See our Buildkite guide for more information.

To bundle additional assets alongside your package, view the bundling assets section above.

These files will be copied into the corresponding lib-commonjs and lib-es2015 directories.

Option	Description
--serial	Force serial execution of compilation operations