Skip to main content
Version: 2.31 (dev)

typescript

TypeScript type checker (tsc).

Backend: pants.backend.experimental.typescript

Config section: [typescript]

Basic options​

extra_build_args​

--typescript-extra-build-args="['<str>', '<str>', ...]"
PANTS_TYPESCRIPT_EXTRA_BUILD_ARGS
pants.toml
[typescript]
extra_build_args = [
  '<str>',
  '<str>',
  ...,
]
default: []

Extra arguments to pass to tsc when running in --build mode. These args are added to the base command 'tsc --build'. Commonly used: --verbose, --force, --dry.

skip​

--[no-]typescript-skip
PANTS_TYPESCRIPT_SKIP
pants.toml
[typescript]
skip = <bool>
default: False

If true, don't use TypeScript when running pants check.

Advanced options​

binary_name​

--typescript-binary-name=<str>
PANTS_TYPESCRIPT_BINARY_NAME
pants.toml
[typescript]
binary_name = <str>
default: None

Override the binary to run for this tool. Defaults to the package name.

install_from_resolve​

--typescript-install-from-resolve=<str>
PANTS_TYPESCRIPT_INSTALL_FROM_RESOLVE
pants.toml
[typescript]
install_from_resolve = <str>
default: None

If specified, install the tool using the lockfile for this named resolve, instead of the version configured in this subsystem.

If unspecified, the tool will use the default configured package manager [nodejs].package_manager`, and install the tool without a lockfile.

version​

--typescript-version=<str>
PANTS_TYPESCRIPT_VERSION
pants.toml
[typescript]
version = <str>
default: typescript@FROM_PACKAGE_JSON

Version string for the tool in the form package@version (e.g. [email protected])

Deprecated options​

None

None