Skip to content

Commit

Permalink
Document Hidden Feature (#1723)
Browse files Browse the repository at this point in the history
Co-authored-by: skuba <[email protected]>
Co-authored-by: Ryan Ling <[email protected]>
  • Loading branch information
3 people authored Oct 31, 2024
1 parent cfb261a commit eb23b2c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/cli/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,24 @@ With esbuild, you can supply the following options:
| `--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`.

```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
Expand All @@ -86,6 +104,10 @@ 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](#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 |
Expand Down

0 comments on commit eb23b2c

Please sign in to comment.