# soundscript

soundscript is a stricter subset of TypeScript. It keeps TypeScript syntax, uses `.sts` files for
checked code, and aims for full soundness inside a fully soundscript codebase. Ordinary TypeScript,
JavaScript, and declaration-only code remain available through explicit `// #[interop]` boundaries.

Homepage:
- https://soundscript.dev/

Core docs:
- Introduction: https://soundscript.dev/docs
- Quick start: https://soundscript.dev/docs/getting-started/quick-start
- soundscript vs TypeScript: https://soundscript.dev/docs/getting-started/soundscript-vs-typescript
- Adopt in existing TypeScript apps: https://soundscript.dev/docs/getting-started/adopt-in-existing-typescript-apps
- Adoption FAQ: https://soundscript.dev/docs/getting-started/adoption-faq

Concepts:
- Soundness model: https://soundscript.dev/docs/concepts/soundness-model
- Runtime and builtins: https://soundscript.dev/docs/concepts/runtime-and-builtins

Guides:
- Interop boundaries: https://soundscript.dev/docs/guides/interop-boundaries
- Errors and failures: https://soundscript.dev/docs/guides/errors-and-failures
- Tooling and workflow: https://soundscript.dev/docs/guides/tooling-and-js-target
- CI and editor setup: https://soundscript.dev/docs/guides/ci-and-editor-setup
- Publishing packages: https://soundscript.dev/docs/guides/publishing-packages

Reference:
- CLI: https://soundscript.dev/docs/reference/cli
- Builtin modules: https://soundscript.dev/docs/reference/builtin-modules
- Macros: https://soundscript.dev/docs/reference/macros
- Fixed-width numeric types: https://soundscript.dev/docs/reference/machine-numerics
- Newtypes and value classes: https://soundscript.dev/docs/reference/newtypes-and-value-classes
- Variance contracts: https://soundscript.dev/docs/reference/variance-contracts
- Annotation spec: https://soundscript.dev/docs/reference/annotation-spec
- Diagnostics: https://soundscript.dev/docs/reference/diagnostics
- Banned and restricted surface: https://soundscript.dev/docs/reference/banned-and-restricted

Project repos:
- Main repo: https://github.com/soundscript-lang/soundscript
- Website repo: https://github.com/soundscript-lang/website