![\"Atscript\"](\"https://atscript.dev/logo.svg\"){kind=logo}
\n\n \n
\n Define your models once — get TypeScript types, runtime validation, and DB metadata from a single .as model.\n
\n Documentation · Build Setup Guide\n
\n\n---\n\nBuild tool plugin that compiles `.as` files during development. Works with Vite, Webpack, Rollup, Rolldown, esbuild, Rspack, and Farm via [Unplugin](https://unplugin.unjs.io/).\n\n## Installation\n\n```bash\npnpm add -D unplugin-atscript @atscript/typescript @atscript/core\n```\n\n## Quick Start\n\n```ts\n// vite.config.ts\nimport atscript from 'unplugin-atscript/vite'\nexport default { plugins: [atscript()] }\n\n// rollup.config.js\nimport atscript from 'unplugin-atscript/rollup'\nexport default { plugins: [atscript()] }\n\n// webpack.config.js\nconst atscript = require('unplugin-atscript/webpack')\nmodule.exports = { plugins: [atscript()] }\n```\n\nAlso available: `unplugin-atscript/esbuild`, `unplugin-atscript/rolldown`, `unplugin-atscript/rspack`, `unplugin-atscript/farm`.\n\n## Options\n\nSame options on every bundler entry:\n\n| Option | Type | Default | Effect |\n| -------- | --------- | ------------------- | -------------------------------------------------------------------------------------- |\n| `strict` | `boolean` | `true` | Fail the build on parse/diagnostic **errors**. `false` = log errors but keep building. |\n| `root` | `string` | bundler root or cwd | Directory `atscript.config.*` is discovered from. Absolute, or relative to the cwd. |\n\nVite picks the root up automatically (from `configResolved`); other bundlers need `root` when the working directory is not the project root.\n\n## Features\n\n- Universal bundler support via dedicated entry points\n- Automatic `atscript.config.*` loading\n- Strict validation — build fails on `.as` errors by default (`strict: false` to disable)\n- Tree-shaking aware — marks non-mutating modules as side-effect-free\n- On Vite, prebundles `@atscript/typescript/utils` so the first `.as`-backed route does not trigger a dep re-optimization reload\n- Watch-safe in dev — a changed `.as` file is dropped from the document cache and every transitive `.as` import is registered as a watch file, so dependants are re-checked against the new definition on the next reload (esbuild excepted: unplugin has no `watchChange` for it, so under esbuild watch a changed `.as` import still needs a restart)\n\n## Documentation\n\n- [Build Setup Guide](https://atscript.dev/packages/typescript/build-setup)\n- [Full Documentation](https://atscript.dev)\n\n## License\n\nMIT\n","readmeFilename":"README.md"}