@ata-project/unplugin 0.2.0 → 0.4.0

package/README.md

@@ -6,6 +6,11 @@ The generated module imports nothing. A small schema compiles to about 1.3 KB gz
 
 Schemas can be authored as `.json`, `.js` or `.ts`.
 
+It also compiles away `new Validator(schema)` in your own code wherever the schema
+is known at build time and the result is the same, so the runtime compiler stays
+out of the bundle: for the test entry, 122.5 KB gzipped becomes 16.7 KB. See
+[compileAway](#compileaway-keep-new-validator-drop-the-compiler).
+
 ## Install
 
 ```bash
@@ -145,12 +150,12 @@ Other sources (`.json` without the `.schema` suffix, `.js`, `.ts`) produce
 | `nameFromFile` | file name in PascalCase | Type name for schemas without `title` or `$id`. |
 | `root` | from the bundler | Where the globs resolve from. Vite's root, Webpack's and Rspack's `context` and esbuild's `absWorkingDir` are read; Rollup and Rolldown need it passed. |
 | `alias` | Vite's `resolve.alias` | Import aliases inside `.ts` schema files. tsconfig `paths` work without configuration. |
-| `compileAway` | `false` | Replace `new Validator(schema)` in your code with a validator compiled at build time, where that gives the same results. See below. Needs ata-validator 1.36.0. |
+| `compileAway` | `true` | Replace `new Validator(schema)` in your code with a validator compiled at build time, where that gives the same results. See below. Needs ata-validator 1.36.0; with an older version the runtime stays, and a warning is printed only if you set the option yourself. |
 
 ## compileAway: keep `new Validator`, drop the compiler
 
-With `compileAway: true`, code written against the runtime API is compiled at
-build time without being changed:
+Code written against the runtime API is compiled at build time without being
+changed. This is on by default; `compileAway: false` turns it off.
 
 ```js
 import { Validator } from 'ata-validator'
@@ -168,8 +173,8 @@ The plugin puts a compiled validator in place of the `new Validator(...)` call,
 and once nothing else in the file uses the `ata-validator` import, the import
 goes with it, so the runtime compiler is not in the bundle. For the three-schema
 entry in `test/fixtures/compile-away`, one of them with defaults, a minified Vite
-library build is 115.7 KB gzipped without it and 15.5 KB with it, on
-ata-validator 1.36.0. Across the 977 schemas of SchemaStore, 725 can be compiled
+library build is 122.5 KB gzipped without it and 16.7 KB with it (gzip level 9), on
+ata-validator 1.39.2. Across the 977 schemas of SchemaStore, 725 can be compiled
 away this way.
 
 The replacement answers `validate()`, `isValidObject()`, `validateJSON()` and
@@ -183,9 +188,13 @@ A call is replaced only when all of this is true, and left to the runtime
 otherwise:
 
 - `Validator` is a named import from `ata-validator`;
-- the call has one argument, and it is an object literal, a top-level `const`
-  bound to one, the default import of a relative `.json` file, or
-  `defineSchema(...)` around one of those;
+- the schema argument is an object literal, a top-level `const` bound to one,
+  the default import of a relative `.json` file, or `defineSchema(...)` around
+  one of those;
+- there is no second argument, or it is `{ useDefaults: false }` (or
+  `{ useDefaults: true }`), written as a literal or a top-level `const`; that
+  one option needs ata-validator 1.37.0, and older versions keep such calls on
+  the runtime;
 - the result goes into a `const` that is not exported and is only used as
   `name.validate(...)`, `name.isValidObject(...)`, `name.validateJSON(...)` or
   `name.isValidJSON(...)`;
@@ -193,7 +202,7 @@ otherwise:
   `errorMessage`s and shapes its code generator cannot express, which the
   runtime answers with its interpreted engine.
 
-Anything with options (`new Validator(schema, { coerceTypes: true })`), a schema
+Any other option (`new Validator(schema, { coerceTypes: true })`), a schema
 built at run time, or an instance passed around stays as written.
 
 ## How it works

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ata-project/unplugin",
-  "version": "0.2.0",
-  "description": "Compile JSON, JS and TS schema files to ata-validator standalone modules at build time, in Vite, Webpack, Rollup, Rolldown, esbuild and Rspack.",
+  "version": "0.4.0",
+  "description": "Build-time JSON Schema for Vite, Webpack, Rollup, Rolldown, esbuild and Rspack. compileAway takes the runtime compiler out of the bundle.",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
@@ -78,7 +78,7 @@
   },
   "devDependencies": {
     "@rspack/core": "^1.7.0",
-    "ata-validator": "^1.36.0",
+    "ata-validator": "^1.39.2",
     "esbuild": "^0.28.0",
     "rolldown": "^1.2.8",
     "rollup": "^4.60.0",

package/src/compile-away.js

@@ -185,8 +185,24 @@ function inlineModule(src, index) {
   return `const __ataCompiled${index} = (() => {\n${body}\nreturn { validate, isValid };\n})();\n`
 }
 
+// The options of `new Validator(schema, options)` as a third argument for
+// fromCompiled(), or NOT_STATIC when the call has to stay on the runtime: options
+// that are not a literal the build can read, or that name anything this
+// ata-validator's wrapper does not reproduce. `useDefaults: true` is the default
+// and needs no argument.
+function compiledOptionsArg(node, ctx, supported) {
+  const opts = staticValue(node, ctx)
+  if (opts === NOT_STATIC || opts === null || typeof opts !== 'object' || Array.isArray(opts)) return NOT_STATIC
+  for (const [key, value] of Object.entries(opts)) {
+    if (!supported.includes(key)) return NOT_STATIC
+    if (key === 'useDefaults' && typeof value !== 'boolean') return NOT_STATIC
+  }
+  return opts.useDefaults === false ? '{"useDefaults":false}' : ''
+}
+
 export function compileAway(code, id, ata) {
   const { compiledModuleFor, compiledSchemaFor } = ata
+  const supportedOptions = Array.isArray(ata.compiledOptions) ? ata.compiledOptions : []
   if (!code.includes('ata-validator')) return null
   let ast
   try {
@@ -221,7 +237,13 @@ export function compileAway(code, id, ata) {
   for (const r of refs) {
     if (r.node.name !== validatorName) continue
     const expr = r.parent
-    if (!expr || expr.type !== 'NewExpression' || r.key !== 'callee' || expr.arguments.length !== 1) continue
+    if (!expr || expr.type !== 'NewExpression' || r.key !== 'callee') continue
+    if (expr.arguments.length !== 1 && expr.arguments.length !== 2) continue
+    let optionsArg = ''
+    if (expr.arguments.length === 2) {
+      optionsArg = compiledOptionsArg(expr.arguments[1], ctx, supportedOptions)
+      if (optionsArg === NOT_STATIC) continue
+    }
     if (!replaceableBinding(expr, ctx)) continue
     const schema = staticValue(expr.arguments[0], ctx)
     if (schema === NOT_STATIC || schema === null || typeof schema !== 'object' || Array.isArray(schema)) continue
@@ -230,7 +252,7 @@ export function compileAway(code, id, ata) {
     if (!src) continue
     const index = modules.length
     modules.push(inlineModule(src, index))
-    s.overwrite(expr.start, expr.end, `__ataFromCompiled(__ataCompiled${index}, ${JSON.stringify(compiledSchemaFor(schema))})`)
+    s.overwrite(expr.start, expr.end, `__ataFromCompiled(__ataCompiled${index}, ${JSON.stringify(compiledSchemaFor(schema))}${optionsArg ? ', ' + optionsArg : ''})`)
     done.add(expr)
   }
   if (done.size === 0) return null

package/src/core.js

@@ -41,7 +41,7 @@ const DEFAULT_OPTIONS = {
   format: 'esm',
   abortEarly: false,
   types: true,
-  compileAway: false,
+  compileAway: true,
   nameFromFile: (file) => {
     const base = path.basename(file, path.extname(file)).replace(/\.schema$/i, '')
     return pascal(base)
@@ -69,6 +69,9 @@ async function loadAta() {
     toStandaloneModule: build.toStandaloneModule,
     compiledModuleFor: canCompileAway ? build.compiledModuleFor : null,
     compiledSchemaFor: canCompileAway ? build.compiledSchemaFor : null,
+    // The Validator options fromCompiled() reproduces, from ata-validator
+    // 1.37.0; before it, only calls without options are replaced.
+    compiledOptions: canCompileAway && Array.isArray(build.compiledOptions) ? build.compiledOptions : [],
   }
 }
 

package/src/index.d.ts

@@ -27,7 +27,7 @@ export interface Options {
    * only used through validate(), isValidObject(), validateJSON() and
    * isValidJSON(), so the runtime compiler stays out of the bundle. Results are
    * the ones the runtime gives. Needs ata-validator 1.35.0 or later.
-   * Default: `false`.
+   * Default: `true`; `false` turns it off.
    */
   compileAway?: boolean
 }

package/src/index.js

@@ -34,8 +34,11 @@ export const unpluginFactory = (userOptions = {}) => {
     // compileAway: `new Validator(schema)` with a schema the build can read
     // becomes a validator compiled here, and the runtime compiler leaves the
     // bundle. See src/compile-away.js for what is replaced and what is not.
+    // On unless the caller turned it off. It replaces a call only where the
+    // compiled validator answers exactly as the runtime would, so being on by
+    // default can cost a saving but not change a result.
     transformInclude(id) {
-      if (!userOptions.compileAway) return false
+      if (userOptions.compileAway === false) return false
       const file = id.split('?')[0]
       return SOURCE.test(file) && !file.split(/[\\/]/).includes('node_modules')
     },
@@ -44,7 +47,9 @@ export const unpluginFactory = (userOptions = {}) => {
       if (!code.includes('ata-validator')) return null
       const api = await session.api()
       if (!api.compiledModuleFor) {
-        if (!session.warnedCompileAway) {
+        // Only a caller who asked for it hears that it could not happen; on
+        // by default, an older ata-validator just keeps the runtime.
+        if (userOptions.compileAway === true && !session.warnedCompileAway) {
           session.warnedCompileAway = true
           session.logger?.warn?.('[unplugin-ata] compileAway needs ata-validator 1.36.0 or later; nothing was replaced')
         }