SAService Architect Back to designer
SAService ArchitectDocumentation
Code generation make typescript-*

TypeScript commands

TypeScript targets manage pnpm generation, builds, strict checks, diagnostics, profiling and standalone packaging.

When to use

Use this reference when generating, reviewing or operating a Service Architect project.

Behavior

  • The root workspace uses one frozen pnpm lock where available.
  • Generated package scripts build services and independent contract/model packages.
  • Debug targets expose the Node inspector and retain source maps.

TypeScript workspace commands

Public root targets and generated TypeScript orchestration.

CommandScopeDescription
make typecheckWorkspace

Type-check every workspace package.

make coverageWorkspace

Run service tests with Node coverage.

make typescript-toolsWorkspace

Install pinned TypeScript schema-generation tools.

make typescript-docker-buildWorkspace

Build production service images.

make typescript-packageWorkspace

Package every service as a standalone repository.

make typescript-package-<service-name>Service

Package one selected service. <service-name> is derived from Service.name.

make debug-<service-name>Service

Start the selected service with the Node inspector on its generated debug port.

make benchmarkWorkspace

Compare the generated framework service with its native baseline; pass BENCHMARK_ARGS for options.

make profileWorkspace

Collect framework/native profiles; pass PROFILING_ARGS for options.

Standalone TypeScript service commands

Targets inside an extracted service package.

CommandScopeDescription
make buildService

Install dependencies and build TypeScript output.

make test / coverageService

Run tests, optionally collecting coverage.

make typecheckService

Run the TypeScript project build in check mode.

make lintService

Type-check then run ESLint with zero warnings.

make fmtService

Format the package with Prettier.

make cleanService

Remove dist, dist-test, node_modules and tsbuildinfo.

make hooksService

Install generated pre-commit and pre-push quality gates.

make docker-build / docker-upService

Build and start the standalone image.

make debugService

Use the development image and expose the Node inspector.

make docker-down / docker-cleanService

Stop standalone Compose, optionally removing volumes.

Contract/model package commands

Targets emitted for independent npm schema packages.

CommandScopeDescription
make installPackage

Install from the frozen pnpm lock when present.

make generatePackage

Run sorted generate-*.generated.sh schema scripts.

make buildPackage

Generate then compile the package.

make testPackage

Build and run package tests.

make docker-buildPackage

Verify the independent package in a generated Docker build.

make cleanPackage

Remove dist and TypeScript build state.

TypeScript workflow

make typecheck
make coverage
make debug-<service-name>
make benchmark BENCHMARK_ARGS="--help"
make typescript-package