JST documentation

Reference

This page provides a quick reference for development commands, generators, quality checks, compatibility, and architecture configuration in JST.

For contribution requirements, see the project’s contribution guidelines.

Development commands

Command	Purpose
npm run dev	Start the development server.
npm run typecheck	Generate route types and check TypeScript.
npm run build	Build the production application after type checking.
npm start	Serve the production build.

Generators

Use the slice generator to create an entity, feature, module, or widget following the project’s architecture conventions.

Examples:

npm run create:slice -- entity account
npm run create:slice -- feature signIn
npm run create:slice -- module projectManagement --stateful
npm run create:slice -- widget accountSummary

Create a workspace package with:

npm run create:package -- orderOperations

See the architecture guide for layer boundaries, public APIs, and guidance on choosing the right architecture.

Quality checks

Local validation

Run linting:

npm run lint

Run unit tests:

npm run test:unit

Run linting, type checking, and unit tests together:

npm run validate

Complete project checks

Run the full project quality checks:

npm run check

Run the release checks, including the production dependency audit and end-to-end tests:

npm run check:release

For browser testing, see the project’s contribution guidelines.

Compatibility and releases

• Supported versions
• Compatibility contract
• Release process
• Project health and engineering evidence

The machine-readable compatibility information is maintained in jst.compatibility.json.

Architecture configuration

JST enforces architecture and source-quality conventions through @jst-stack/eslint-plugin.

• Architecture guide
• Plugin configuration documentation
• Plugin README
• JST policy JSON Schema

Use the plugin documentation and schema as the authoritative references for available policy options.

This site is open source. Improve this page.