@tilua/compiler 8.1.0 → 9.0.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as T from '@tilua/parser';
 import { OutputMode, TiluaConfig, ConfigProblem, LoweringPlugin, TypeAnalysis, ScopeAnalysis } from '@tilua/parser';
-export { LoweringPlugin, LuaSyntax, MethodCall, MethodLowering } from '@tilua/parser';
+export { EntryExports, EntryExportsLowering, FilesAnswer, FilesLayout, LoweringPlugin, LuaSyntax, MethodCall, MethodLowering, PluginContext } from '@tilua/parser';
 import * as L from 'luau-parser';
 
 /** What `tilua.config.json` holds. */
@@ -15,8 +15,15 @@ interface TiluaConfigJson {
     sourceMap?: string | null;
     /** How many files the output is. `"single"` (the default) is one file;
      *  `"chunks"` also writes a file for what only an `import()` reaches,
-     *  loaded when it is first asked for; `"modules"` writes one per module. */
+     *  loaded when it is first asked for; `"files"` has no entry, and
+     *  compiles every file under `rootDir` to one of its own under `outDir`. */
     output?: OutputMode;
+    /** With `"files"`, the folder whose files are compiled. Default: the
+     *  config's folder. */
+    rootDir?: string;
+    /** With `"files"`, the folder the output goes in, laid out as `rootDir`
+     *  is. Default: `rootDir`, each `.luau` beside its `.tilua`. */
+    outDir?: string;
     /** Leave out Lua's standard library — `print`, `string`, `pcall` — which
      *  is otherwise there for every file, as JavaScript's is in TypeScript. */
     noLib?: boolean;
@@ -25,6 +32,15 @@ interface TiluaConfigJson {
     /** Write the map from the bundle's lines back to the project's, which
      *  error reports and `console` read. Default: true. */
     lineMap?: boolean;
+    /** Indent the output, a block level at a time: `"\t"` or a number of
+     *  spaces. Default: no indentation. */
+    indent?: "\t" | number;
+    /** Write the output on one line, with as few `;` as it can take, and
+     *  without the line map. Default: false. */
+    minify?: boolean;
+    /** The options a type library in `types` declares, such as
+     *  `@tilua-types/luau`'s `typedExports`. */
+    [option: string]: unknown;
 }
 /** A config file's path, or the config itself. Relative paths — to a config
  *  file, and inside an inline config — resolve from `cwd`. */
@@ -38,8 +54,9 @@ interface ResolvedConfig {
 declare function resolveConfig(input: ConfigInput | undefined, entry: string, cwd?: string): ResolvedConfig;
 
 interface BundleOptions {
-    /** The file the bundle runs. */
-    readonly entry: string;
+    /** The file the bundle runs. Needed unless the output is `"files"`,
+     *  which has no entry: every file under the config's `rootDir` is one. */
+    readonly entry?: string;
     /** A `tilua.config.json` path or contents. Default: the nearest config above the entry. */
     readonly config?: ConfigInput;
     /** The project folder. Modules are named by their path from it, and an
@@ -49,7 +66,8 @@ interface BundleOptions {
     /** Check types against the config's `types` too. Default: true. */
     readonly typeCheck?: boolean;
     /** How many files to make. Overrides the config's `output`; `"single"`
-     *  without either. */
+     *  without either. With `"files"`, every file under the config's
+     *  `rootDir` is compiled to a file of its own, its path from `rootDir`. */
     readonly output?: OutputMode;
     /** Leave out what the entry never reaches. Overrides the config's
      *  `treeShaking`; off without either. */
@@ -58,11 +76,26 @@ interface BundleOptions {
      *  the config's `lineMap`; on without either. Without it an error names
      *  the bundle's lines, and the entry does not run under `xpcall`. */
     readonly lineMap?: boolean;
+    /** Indent the output: `"\t"` or a number of spaces. Overrides the
+     *  config's `indent`; no indentation without either. */
+    readonly indent?: "\t" | number;
+    /** Write the output on one line, with as few `;` as it can take — and so
+     *  without the line map, which one line cannot have. Overrides the
+     *  config's `minify`; off without either. */
+    readonly minify?: boolean;
+    /** With `"files"`, the folder the output is written to — where a host's
+     *  layout (a Rojo project) finds it. Overrides the config's `outDir`;
+     *  `rootDir` without either. */
+    readonly outDir?: string;
     /** What the entry's file is called: `main.luau`. The other files of
      *  `"chunks"` are named after it (`main_shop.luau`), and every file takes
      *  its extension. Default: the entry's own name, with `.luau`. */
     readonly outFile?: string;
 }
+/** How the last line of every file `"files"` writes starts: what says a
+ *  file is tilua's to replace or remove, and not one written by hand. On the
+ *  last line, so no line the line map counts moves. */
+declare const WRITTEN_BY_TILUA = "-- Written by tilua";
 /** One file of the output. */
 interface BundleFile {
     /** Where it goes, from the folder the output is written to: `main.luau`,
@@ -88,9 +121,9 @@ interface BundleDiagnostic {
     readonly severity?: "warning";
 }
 interface BundleResult {
-    /** The bundle — the entry's file, when there are several — or `undefined`
-     *  when a module could not be compiled. Type errors are reported but do
-     *  not stop it. */
+    /** The bundle — the entry's file, when there are several, and the first
+     *  module's with `"files"` — or `undefined` when a module could not be
+     *  compiled. Type errors are reported but do not stop it. */
     readonly code?: string;
     /** Every file of the output, the entry's first. Empty when there is no
      *  bundle. */
@@ -145,6 +178,9 @@ interface LoadedLowering {
      *  analyzer was given: a method read from a metatable they declare is
      *  this lowering's to answer. Absent for the language's own. */
     readonly library?: number;
+    /** The library's own options, as the config sets them. None for the
+     *  language's own. */
+    readonly options?: Readonly<Record<string, boolean | number | string | undefined>>;
 }
 interface LoweringProblem {
     readonly file: string;
@@ -157,6 +193,7 @@ declare function loadLowerings(modules: readonly {
     file: string;
     from: string;
     library?: number;
+    options?: LoadedLowering["options"];
 }[]): Promise<{
     lowerings: LoadedLowering[];
     problems: LoweringProblem[];
@@ -209,6 +246,12 @@ interface ModuleContext {
     /** What `import("./x")` calls, with the module's name: the bundle's
      *  wrapper around its `require`. Default: `require` itself. */
     readonly import?: L.Expression;
+    /** Where a module is a file of its own: a function, passed after its
+     *  name, that loads the file it is in — `function() return
+     *  require("./shape") end`, with the path written out, for the tools that
+     *  follow a `require`. `require` calls it only if the module is not
+     *  already there. */
+    loader?(name: string): L.Expression | undefined;
     /** Luau reaching the bundle's line map — what a library's runtime reads,
      *  as `__LINES__`, to name the file a frame was written in. */
     readonly lines?: string;
@@ -343,4 +386,4 @@ interface ModuleInfo {
 }
 declare function lower(program: T.Program, scopes: ScopeAnalysis, options?: LowerOptions): LowerResult;
 
-export { type BundleDiagnostic, type BundleFile, type BundleOptions, type BundleResult, type CompileResult, type ConfigInput, type Diagnostic, type LoadedLowering, type LowerDiagnostic, type LowerOptions, type LowerResult, type LoweringProblem, type ModuleContext, type ResolvedConfig, type TiluaConfigJson, bundle, compile, loadLowerings, lower, resolveConfig };
+export { type BundleDiagnostic, type BundleFile, type BundleOptions, type BundleResult, type CompileResult, type ConfigInput, type Diagnostic, type LoadedLowering, type LowerDiagnostic, type LowerOptions, type LowerResult, type LoweringProblem, type ModuleContext, type ResolvedConfig, type TiluaConfigJson, WRITTEN_BY_TILUA, bundle, compile, loadLowerings, lower, resolveConfig };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as T from '@tilua/parser';
 import { OutputMode, TiluaConfig, ConfigProblem, LoweringPlugin, TypeAnalysis, ScopeAnalysis } from '@tilua/parser';
-export { LoweringPlugin, LuaSyntax, MethodCall, MethodLowering } from '@tilua/parser';
+export { EntryExports, EntryExportsLowering, FilesAnswer, FilesLayout, LoweringPlugin, LuaSyntax, MethodCall, MethodLowering, PluginContext } from '@tilua/parser';
 import * as L from 'luau-parser';
 
 /** What `tilua.config.json` holds. */
@@ -15,8 +15,15 @@ interface TiluaConfigJson {
     sourceMap?: string | null;
     /** How many files the output is. `"single"` (the default) is one file;
      *  `"chunks"` also writes a file for what only an `import()` reaches,
-     *  loaded when it is first asked for; `"modules"` writes one per module. */
+     *  loaded when it is first asked for; `"files"` has no entry, and
+     *  compiles every file under `rootDir` to one of its own under `outDir`. */
     output?: OutputMode;
+    /** With `"files"`, the folder whose files are compiled. Default: the
+     *  config's folder. */
+    rootDir?: string;
+    /** With `"files"`, the folder the output goes in, laid out as `rootDir`
+     *  is. Default: `rootDir`, each `.luau` beside its `.tilua`. */
+    outDir?: string;
     /** Leave out Lua's standard library — `print`, `string`, `pcall` — which
      *  is otherwise there for every file, as JavaScript's is in TypeScript. */
     noLib?: boolean;
@@ -25,6 +32,15 @@ interface TiluaConfigJson {
     /** Write the map from the bundle's lines back to the project's, which
      *  error reports and `console` read. Default: true. */
     lineMap?: boolean;
+    /** Indent the output, a block level at a time: `"\t"` or a number of
+     *  spaces. Default: no indentation. */
+    indent?: "\t" | number;
+    /** Write the output on one line, with as few `;` as it can take, and
+     *  without the line map. Default: false. */
+    minify?: boolean;
+    /** The options a type library in `types` declares, such as
+     *  `@tilua-types/luau`'s `typedExports`. */
+    [option: string]: unknown;
 }
 /** A config file's path, or the config itself. Relative paths — to a config
  *  file, and inside an inline config — resolve from `cwd`. */
@@ -38,8 +54,9 @@ interface ResolvedConfig {
 declare function resolveConfig(input: ConfigInput | undefined, entry: string, cwd?: string): ResolvedConfig;
 
 interface BundleOptions {
-    /** The file the bundle runs. */
-    readonly entry: string;
+    /** The file the bundle runs. Needed unless the output is `"files"`,
+     *  which has no entry: every file under the config's `rootDir` is one. */
+    readonly entry?: string;
     /** A `tilua.config.json` path or contents. Default: the nearest config above the entry. */
     readonly config?: ConfigInput;
     /** The project folder. Modules are named by their path from it, and an
@@ -49,7 +66,8 @@ interface BundleOptions {
     /** Check types against the config's `types` too. Default: true. */
     readonly typeCheck?: boolean;
     /** How many files to make. Overrides the config's `output`; `"single"`
-     *  without either. */
+     *  without either. With `"files"`, every file under the config's
+     *  `rootDir` is compiled to a file of its own, its path from `rootDir`. */
     readonly output?: OutputMode;
     /** Leave out what the entry never reaches. Overrides the config's
      *  `treeShaking`; off without either. */
@@ -58,11 +76,26 @@ interface BundleOptions {
      *  the config's `lineMap`; on without either. Without it an error names
      *  the bundle's lines, and the entry does not run under `xpcall`. */
     readonly lineMap?: boolean;
+    /** Indent the output: `"\t"` or a number of spaces. Overrides the
+     *  config's `indent`; no indentation without either. */
+    readonly indent?: "\t" | number;
+    /** Write the output on one line, with as few `;` as it can take — and so
+     *  without the line map, which one line cannot have. Overrides the
+     *  config's `minify`; off without either. */
+    readonly minify?: boolean;
+    /** With `"files"`, the folder the output is written to — where a host's
+     *  layout (a Rojo project) finds it. Overrides the config's `outDir`;
+     *  `rootDir` without either. */
+    readonly outDir?: string;
     /** What the entry's file is called: `main.luau`. The other files of
      *  `"chunks"` are named after it (`main_shop.luau`), and every file takes
      *  its extension. Default: the entry's own name, with `.luau`. */
     readonly outFile?: string;
 }
+/** How the last line of every file `"files"` writes starts: what says a
+ *  file is tilua's to replace or remove, and not one written by hand. On the
+ *  last line, so no line the line map counts moves. */
+declare const WRITTEN_BY_TILUA = "-- Written by tilua";
 /** One file of the output. */
 interface BundleFile {
     /** Where it goes, from the folder the output is written to: `main.luau`,
@@ -88,9 +121,9 @@ interface BundleDiagnostic {
     readonly severity?: "warning";
 }
 interface BundleResult {
-    /** The bundle — the entry's file, when there are several — or `undefined`
-     *  when a module could not be compiled. Type errors are reported but do
-     *  not stop it. */
+    /** The bundle — the entry's file, when there are several, and the first
+     *  module's with `"files"` — or `undefined` when a module could not be
+     *  compiled. Type errors are reported but do not stop it. */
     readonly code?: string;
     /** Every file of the output, the entry's first. Empty when there is no
      *  bundle. */
@@ -145,6 +178,9 @@ interface LoadedLowering {
      *  analyzer was given: a method read from a metatable they declare is
      *  this lowering's to answer. Absent for the language's own. */
     readonly library?: number;
+    /** The library's own options, as the config sets them. None for the
+     *  language's own. */
+    readonly options?: Readonly<Record<string, boolean | number | string | undefined>>;
 }
 interface LoweringProblem {
     readonly file: string;
@@ -157,6 +193,7 @@ declare function loadLowerings(modules: readonly {
     file: string;
     from: string;
     library?: number;
+    options?: LoadedLowering["options"];
 }[]): Promise<{
     lowerings: LoadedLowering[];
     problems: LoweringProblem[];
@@ -209,6 +246,12 @@ interface ModuleContext {
     /** What `import("./x")` calls, with the module's name: the bundle's
      *  wrapper around its `require`. Default: `require` itself. */
     readonly import?: L.Expression;
+    /** Where a module is a file of its own: a function, passed after its
+     *  name, that loads the file it is in — `function() return
+     *  require("./shape") end`, with the path written out, for the tools that
+     *  follow a `require`. `require` calls it only if the module is not
+     *  already there. */
+    loader?(name: string): L.Expression | undefined;
     /** Luau reaching the bundle's line map — what a library's runtime reads,
      *  as `__LINES__`, to name the file a frame was written in. */
     readonly lines?: string;
@@ -343,4 +386,4 @@ interface ModuleInfo {
 }
 declare function lower(program: T.Program, scopes: ScopeAnalysis, options?: LowerOptions): LowerResult;
 
-export { type BundleDiagnostic, type BundleFile, type BundleOptions, type BundleResult, type CompileResult, type ConfigInput, type Diagnostic, type LoadedLowering, type LowerDiagnostic, type LowerOptions, type LowerResult, type LoweringProblem, type ModuleContext, type ResolvedConfig, type TiluaConfigJson, bundle, compile, loadLowerings, lower, resolveConfig };
+export { type BundleDiagnostic, type BundleFile, type BundleOptions, type BundleResult, type CompileResult, type ConfigInput, type Diagnostic, type LoadedLowering, type LowerDiagnostic, type LowerOptions, type LowerResult, type LoweringProblem, type ModuleContext, type ResolvedConfig, type TiluaConfigJson, WRITTEN_BY_TILUA, bundle, compile, loadLowerings, lower, resolveConfig };

package/dist/index.js

@@ -1,16 +1,19 @@
 import {
+  WRITTEN_BY_TILUA,
   bundle,
   loadLowerings,
   lower,
+  printOptions,
+  printOutput,
   program,
-  resolveConfig
-} from "./chunk-WOBHMGGC.js";
+  resolveConfig,
+  syntaxOf
+} from "./chunk-VUIF62OE.js";
 
 // src/compile.ts
 import { readFileSync } from "fs";
 import { resolve } from "path";
 import { parse, analyzeScopes, analyzeTypes, resolveTypeLibraries, ParseError, LexError } from "@tilua/parser";
-import { print } from "luau-parser";
 async function compile(source, config) {
   let program2;
   try {
@@ -30,7 +33,7 @@ async function compile(source, config) {
     line: d.node.line.start,
     column: d.node.column.start
   }));
-  const libraries = resolved ? resolveTypeLibraries(resolved) : { files: [], lowerings: [], problems: [] };
+  const libraries = resolved ? resolveTypeLibraries(resolved) : { files: [], lowerings: [], options: [], problems: [] };
   const { lowerings, problems: loweringProblems } = await loadLowerings(libraries.lowerings);
   for (const p of [...problems, ...libraries.problems]) {
     diagnostics.push({ message: p.message, line: p.line ?? 1, column: p.column ?? 1 });
@@ -45,9 +48,15 @@ async function compile(source, config) {
   });
   diagnostics.push(...lowered.diagnostics);
   if (diagnostics.length) return { diagnostics };
-  return { code: print(program(lowered.statements)) + "\n", diagnostics };
+  const printed = printOutput(program(lowered.statements), printOptions(syntaxOf(lowerings), {
+    indent: resolved?.indent,
+    minify: resolved?.minify
+  }));
+  if ("problem" in printed) return { diagnostics: [{ message: printed.problem, line: 1, column: 1 }] };
+  return { code: printed.code + "\n", diagnostics };
 }
 export {
+  WRITTEN_BY_TILUA,
   bundle,
   compile,
   loadLowerings,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tilua/compiler",
-  "version": "8.1.0",
+  "version": "9.0.0",
   "description": "Compiles tilua to Luau: lowers the @tilua/parser AST to a luau-parser AST and prints it",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -37,8 +37,8 @@
   "license": "ISC",
   "type": "module",
   "dependencies": {
-    "luau-parser": "^1.0.3",
-    "@tilua/parser": "^8.1.0"
+    "@tilua/parser": "^9.0.0",
+    "luau-parser": "^1.1.0"
   },
   "devDependencies": {
     "@types/node": "^22.20.2",