luaut-parser 1.2.0 → 2.0.0

package/dist/index.js

@@ -3176,7 +3176,11 @@ function isAssignableInner(a, b) {
   if (a.kind === "union") return a.types.every((t) => isAssignable(t, b));
   if (b.kind === "union") return b.types.some((t) => isAssignable(a, t));
   if (b.kind === "intersection") return b.types.every((t) => isAssignable(a, t));
-  if (a.kind === "intersection") return a.types.some((t) => isAssignable(t, b));
+  if (a.kind === "intersection") {
+    if (a.types.some((t) => isAssignable(t, b))) return true;
+    const merged = mergeObjectMembers(a.types);
+    return merged !== void 0 && isAssignable(merged, b);
+  }
   if (a.kind === "literal") {
     if (b.kind === "literal") return a.value === b.value;
     if (b.kind === "primitive") return b.name === a.base;
@@ -3531,6 +3535,39 @@ var IDENT_KEY = /^[A-Za-z_][A-Za-z0-9_]*$/;
 function formatKey(k) {
   return IDENT_KEY.test(k) ? k : JSON.stringify(k);
 }
+function mergeObjectMembers(types) {
+  const objects = [];
+  const seen = /* @__PURE__ */ new Set();
+  const collect = (t) => {
+    if (seen.has(t)) return true;
+    seen.add(t);
+    if (t.kind === "genericRef") {
+      const expanded = expandAlias?.(t);
+      return expanded !== void 0 && expanded !== t && collect(expanded);
+    }
+    if (t.kind === "intersection") return t.types.every(collect);
+    if (t.kind === "object") {
+      objects.push(t);
+      return true;
+    }
+    return false;
+  };
+  if (!types.every(collect) || objects.length < 2) return void 0;
+  const properties = /* @__PURE__ */ new Map();
+  let indexer;
+  for (const object of objects) {
+    indexer ??= object.indexer;
+    for (const [name, property] of object.properties) {
+      const existing = properties.get(name);
+      properties.set(name, existing ? {
+        type: intersection([existing.type, property.type]),
+        optional: existing.optional && property.optional,
+        readonly: existing.readonly || property.readonly
+      } : property);
+    }
+  }
+  return objectType([...properties], indexer);
+}
 
 // src/ast/analyzeTypes.ts
 function analyzeTypes(program, scopes, options = {}) {
@@ -5823,22 +5860,368 @@ function briefType(t) {
   return formatType(t);
 }
 
-// src/lib/luau.ts
-import { readFileSync } from "fs";
-import { fileURLToPath } from "url";
-var luauDefsPath = fileURLToPath(new URL("./luau.d.luaut", import.meta.url));
-var luauDefs = readFileSync(luauDefsPath, "utf8");
-var luauLib = parse(luauDefs);
+// src/project/host.ts
+import { readFileSync, statSync } from "fs";
+var nodeHost = {
+  readFile(path) {
+    try {
+      return statSync(path).isFile() ? readFileSync(path, "utf8") : void 0;
+    } catch {
+      return void 0;
+    }
+  }
+};
+
+// src/project/config.ts
+import { dirname, join, resolve } from "path";
+var CONFIG_FILE_NAMES = ["luaut.config.json", "luaut.config.jsonc"];
+function findConfig(file, host = nodeHost) {
+  const searched = [];
+  let directory = dirname(resolve(file));
+  for (; ; ) {
+    const found = [];
+    for (const name of CONFIG_FILE_NAMES) {
+      const path = join(directory, name);
+      searched.push(path);
+      if (host.readFile(path) !== void 0) found.push(path);
+    }
+    if (found.length > 1) {
+      const message = `Only one luaut config may be in a folder, but both ${CONFIG_FILE_NAMES.join(" and ")} are in ${directory}`;
+      return { searched, problems: found.map((path) => ({ file: path, message, line: 1, column: 1 })) };
+    }
+    if (found.length === 1) {
+      const { config, problems } = loadConfig(found[0], host);
+      return { config, problems, searched };
+    }
+    const parent = dirname(directory);
+    if (parent === directory) return { searched, problems: [] };
+    directory = parent;
+  }
+}
+var OPTIONS = ["types", "paths", "baseUrl", "sourceMap"];
+function loadConfig(path, host = nodeHost) {
+  const file = resolve(path);
+  const source = host.readFile(file);
+  if (source === void 0) return { problems: [{ file, message: "Cannot read the config file" }] };
+  let raw;
+  try {
+    raw = JSON.parse(stripJsonComments(source));
+  } catch (error) {
+    const message = error.message;
+    return { problems: [{ file, message: `Invalid JSON: ${message}`, ...jsonErrorPosition(source, message) }] };
+  }
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) {
+    return { problems: [{ file, message: "The config must be a JSON object", line: 1, column: 1 }] };
+  }
+  const directory = dirname(file);
+  const options = raw;
+  const problems = [];
+  const at = (key) => keyPosition(source, key);
+  const problem = (key, message) => {
+    problems.push({ file, message, ...at(key) });
+  };
+  for (const key of Object.keys(options)) {
+    if (!OPTIONS.includes(key)) {
+      problem(key, `Unknown option '${key}'. Options are: ${OPTIONS.join(", ")}`);
+    }
+  }
+  let types = [];
+  if (options.types !== void 0) {
+    if (Array.isArray(options.types) && options.types.every((t) => typeof t === "string")) types = options.types;
+    else problem("types", `'types' must be an array of strings, such as ["luau"]`);
+  }
+  const paths = {};
+  if (options.paths !== void 0) {
+    const value = options.paths;
+    if (value && typeof value === "object" && !Array.isArray(value)) {
+      for (const [pattern, targets] of Object.entries(value)) {
+        if (Array.isArray(targets) && targets.every((t) => typeof t === "string")) paths[pattern] = targets;
+        else problem(pattern, `'paths' entry '${pattern}' must be an array of strings`);
+        if (pattern.split("*").length > 2) problem(pattern, `'paths' pattern '${pattern}' may contain at most one '*'`);
+      }
+    } else {
+      problem("paths", `'paths' must be an object, such as { "@shared/*": ["src/shared/*"] }`);
+    }
+  }
+  let baseUrl = directory;
+  if (options.baseUrl !== void 0) {
+    if (typeof options.baseUrl === "string") baseUrl = resolve(directory, options.baseUrl);
+    else problem("baseUrl", "'baseUrl' must be a string");
+  }
+  let sourceMap = null;
+  if (options.sourceMap !== void 0 && options.sourceMap !== null) {
+    if (typeof options.sourceMap === "string") sourceMap = resolve(directory, options.sourceMap);
+    else problem("sourceMap", "'sourceMap' must be a path string, or null for none");
+  }
+  return { config: { path: file, directory, source, types, paths, baseUrl, sourceMap }, problems };
+}
+function stripJsonComments(text) {
+  const out = text.split("");
+  let i = 0;
+  let inString = false;
+  while (i < text.length) {
+    const ch = text[i];
+    if (inString) {
+      if (ch === "\\") i += 2;
+      else {
+        if (ch === '"') inString = false;
+        i++;
+      }
+      continue;
+    }
+    if (ch === '"') {
+      inString = true;
+      i++;
+    } else if (ch === "/" && text[i + 1] === "/") {
+      while (i < text.length && text[i] !== "\n") out[i++] = " ";
+    } else if (ch === "/" && text[i + 1] === "*") {
+      out[i++] = " ";
+      out[i++] = " ";
+      while (i < text.length && !(text[i] === "*" && text[i + 1] === "/")) {
+        if (text[i] !== "\n") out[i] = " ";
+        i++;
+      }
+      if (i < text.length) {
+        out[i++] = " ";
+        out[i++] = " ";
+      }
+    } else if (ch === ",") {
+      let j = i + 1;
+      while (j < text.length && /\s/.test(text[j])) j++;
+      if (text[j] === "}" || text[j] === "]") out[i] = " ";
+      i++;
+    } else {
+      i++;
+    }
+  }
+  return out.join("");
+}
+function jsonErrorPosition(source, message) {
+  const lineColumn = /line (\d+) column (\d+)/.exec(message);
+  if (lineColumn) return { line: Number(lineColumn[1]), column: Number(lineColumn[2]) };
+  const position = /position (\d+)/.exec(message);
+  return position ? offsetPosition(source, Number(position[1])) : { line: 1, column: 1 };
+}
+function keyPosition(source, key) {
+  const offset = source.indexOf(JSON.stringify(key));
+  return offset < 0 ? { line: 1, column: 1 } : offsetPosition(source, offset);
+}
+function offsetPosition(source, offset) {
+  const before = source.slice(0, offset);
+  const line = before.split("\n").length;
+  return { line, column: offset - before.lastIndexOf("\n") };
+}
 
-// src/lib/roblox.ts
-import { readFileSync as readFileSync2 } from "fs";
-import { fileURLToPath as fileURLToPath2 } from "url";
-var robloxDefsPath = fileURLToPath2(new URL("./roblox.d.luaut", import.meta.url));
-var robloxDefs = readFileSync2(robloxDefsPath, "utf8");
-var robloxLib = parse(robloxDefs);
+// src/project/libraries.ts
+import { dirname as dirname2, join as join2, resolve as resolve2 } from "path";
+function resolveTypeLibraries(config, host = nodeHost) {
+  const files = [];
+  const problems = [];
+  const loaded = /* @__PURE__ */ new Set();
+  const addFile = (file) => {
+    const key = pathKey(file);
+    if (loaded.has(key)) return;
+    loaded.add(key);
+    files.push(file);
+  };
+  const addPackage = (directory, entryFile, visiting) => {
+    const key = pathKey(directory);
+    if (visiting.has(key)) return;
+    visiting.add(key);
+    for (const dependency of dependencyNames(directory, host)) {
+      const found = findPackage(dependency, directory, host);
+      if (found) addPackage(found.directory, found.file, visiting);
+    }
+    addFile(entryFile);
+  };
+  for (const entry of config.types) {
+    const relative = entry.startsWith("./") || entry.startsWith("../") || entry.startsWith("/") || /^[A-Za-z]:[\\/]/.test(entry);
+    if (relative) {
+      const target = resolve2(config.directory, entry);
+      if (entry.endsWith(".luaut")) {
+        if (host.readFile(target) !== void 0) addFile(target);
+        else problems.push({ file: config.path, message: `Cannot find type library file '${entry}'`, ...entryPosition(config, entry) });
+        continue;
+      }
+      const file = packageEntry(target, host);
+      if (file) addPackage(target, file, /* @__PURE__ */ new Set());
+      else problems.push({ file: config.path, message: `'${entry}' has no ${ENTRY_FILE} (or 'luaut.types' in its package.json)`, ...entryPosition(config, entry) });
+      continue;
+    }
+    const names = entry.startsWith("@") || entry.includes("/") ? [entry] : [`@luaut/${entry}`, entry];
+    const found = names.map((name) => findPackage(name, config.directory, host)).find(Boolean);
+    if (found) addPackage(found.directory, found.file, /* @__PURE__ */ new Set());
+    else {
+      problems.push({
+        file: config.path,
+        message: `Cannot find type library '${entry}'. Install it with: npm i -D ${names[0]}`,
+        ...entryPosition(config, entry)
+      });
+    }
+  }
+  return { files, problems };
+}
+var ENTRY_FILE = "index.d.luaut";
+function packageEntry(directory, host) {
+  const manifest = readJson(join2(directory, "package.json"), host);
+  const declared = manifest?.luaut?.types;
+  const file = resolve2(directory, typeof declared === "string" ? declared : ENTRY_FILE);
+  return host.readFile(file) !== void 0 ? file : void 0;
+}
+function findPackage(name, from, host) {
+  let directory = resolve2(from);
+  for (; ; ) {
+    const candidate = join2(directory, "node_modules", ...name.split("/"));
+    const file = packageEntry(candidate, host);
+    if (file) return { directory: candidate, file };
+    const parent = dirname2(directory);
+    if (parent === directory) return void 0;
+    directory = parent;
+  }
+}
+function dependencyNames(directory, host) {
+  const manifest = readJson(join2(directory, "package.json"), host);
+  const names = /* @__PURE__ */ new Set();
+  for (const field of ["dependencies", "peerDependencies"]) {
+    const deps = manifest?.[field];
+    if (deps && typeof deps === "object") for (const name of Object.keys(deps)) names.add(name);
+  }
+  return [...names];
+}
+function readJson(path, host) {
+  const text = host.readFile(path);
+  if (text === void 0) return void 0;
+  try {
+    const value = JSON.parse(text);
+    return value && typeof value === "object" ? value : void 0;
+  } catch {
+    return void 0;
+  }
+}
+function entryPosition(config, entry) {
+  return keyPosition(config.source, entry);
+}
+function pathKey(path) {
+  const normalized = resolve2(path);
+  return process.platform === "win32" ? normalized.toLowerCase() : normalized;
+}
+
+// src/project/modules.ts
+import { dirname as dirname3, join as join3, resolve as resolve3 } from "path";
+function moduleCandidates(fromFile, specifier, config) {
+  const bases = specifier.startsWith("./") || specifier.startsWith("../") ? [resolve3(dirname3(fromFile), specifier)] : config ? aliasTargets(config, specifier) : [];
+  return bases.flatMap((base) => base.endsWith(".luaut") ? [base] : [`${base}.luaut`, `${base}.d.luaut`, join3(base, "index.luaut")]);
+}
+function resolveModulePath(fromFile, specifier, config, host = nodeHost) {
+  return moduleCandidates(fromFile, specifier, config).find((path) => host.readFile(path) !== void 0);
+}
+function aliasTargets(config, specifier) {
+  let match;
+  let prefixLength = -1;
+  for (const pattern2 of Object.keys(config.paths)) {
+    const star = pattern2.indexOf("*");
+    if (star < 0) {
+      if (pattern2 === specifier) {
+        match = { pattern: pattern2, wildcard: "" };
+        break;
+      }
+      continue;
+    }
+    const prefix = pattern2.slice(0, star);
+    const suffix = pattern2.slice(star + 1);
+    const fits = specifier.length >= prefix.length + suffix.length && specifier.startsWith(prefix) && specifier.endsWith(suffix);
+    if (fits && prefix.length > prefixLength) {
+      prefixLength = prefix.length;
+      match = { pattern: pattern2, wildcard: specifier.slice(prefix.length, specifier.length - suffix.length) };
+    }
+  }
+  if (!match) return [];
+  const { pattern, wildcard } = match;
+  return config.paths[pattern].map((target) => resolve3(config.baseUrl, target.replace("*", wildcard)));
+}
+
+// src/project/sourcemap.ts
+import { dirname as dirname4, extname, resolve as resolve4 } from "path";
+var IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
+var INSTANCE_MEMBERS = /* @__PURE__ */ new Set(["Name", "ClassName", "Parent", "Archivable"]);
+var SCRIPT_EXTENSIONS = /* @__PURE__ */ new Set([".luaut", ".luau", ".lua"]);
+function sourceMapTypes(text, path, options) {
+  let root;
+  try {
+    root = JSON.parse(text);
+  } catch (error) {
+    return { problem: `Invalid sourcemap: ${error.message}` };
+  }
+  if (!isNode(root)) return { problem: "Invalid sourcemap: the root must be an object with 'name' and 'className'" };
+  const directory = dirname4(resolve4(path));
+  const lines = [];
+  const aliasOfFile = /* @__PURE__ */ new Map();
+  const used = /* @__PURE__ */ new Set();
+  const canOmit = options.classes.has("Omit");
+  const aliasOfNode = /* @__PURE__ */ new Map();
+  const aliasFor = (segments) => {
+    const base = `SourceMap_${segments.map((s) => s.replace(/[^A-Za-z0-9_]/g, "_")).join("_")}`;
+    let alias = base;
+    for (let n = 2; used.has(alias); n++) alias = `${base}_${n}`;
+    used.add(alias);
+    return alias;
+  };
+  const visit = (node, segments, parent) => {
+    const alias = aliasFor(segments);
+    aliasOfNode.set(node, alias);
+    for (const filePath of node.filePaths ?? []) aliasOfFile.set(fileKey(resolve4(directory, filePath)), alias);
+    const className = IDENTIFIER.test(node.className) && options.classes.has(node.className) ? node.className : "Instance";
+    const taken = options.membersOf?.(className) ?? INSTANCE_MEMBERS;
+    const members = [];
+    if (parent && canOmit) members.push(`Parent: ${parent}`);
+    const named = /* @__PURE__ */ new Set();
+    for (const child of node.children ?? []) {
+      if (!isNode(child)) continue;
+      const childAlias = visit(child, [...segments, child.name], alias);
+      if (!IDENTIFIER.test(child.name) || taken.has(child.name) || named.has(child.name)) continue;
+      named.add(child.name);
+      members.push(`${child.name}: ${childAlias}`);
+    }
+    const base = parent && canOmit ? `Omit<${className}, "Parent">` : className;
+    lines.push(`type ${alias} = ${members.length ? `${base} & { ${members.join(", ")} }` : base}`);
+    return alias;
+  };
+  const rootAlias = visit(root, [root.name], void 0);
+  if (root.className === "DataModel") {
+    lines.push(`declare game: ${rootAlias}`);
+    const workspace = (root.children ?? []).find((child) => isNode(child) && child.className === "Workspace");
+    const workspaceAlias = workspace && aliasOfNode.get(workspace);
+    if (workspaceAlias) lines.push(`declare workspace: ${workspaceAlias}`);
+  }
+  let program;
+  try {
+    program = parse(lines.join("\n"));
+  } catch (error) {
+    return { problem: `Could not turn the sourcemap into types: ${error.message}` };
+  }
+  return {
+    types: {
+      program,
+      scriptFor(file) {
+        const alias = aliasOfFile.get(fileKey(file));
+        return alias ? parse(`declare script: ${alias}`) : void 0;
+      }
+    }
+  };
+}
+function isNode(value) {
+  if (!value || typeof value !== "object") return false;
+  const node = value;
+  return typeof node.name === "string" && typeof node.className === "string";
+}
+function fileKey(path) {
+  const extension = extname(path);
+  const bare = SCRIPT_EXTENSIONS.has(extension) ? path.slice(0, -extension.length) : path;
+  const normalized = resolve4(bare);
+  return process.platform === "win32" ? normalized.toLowerCase() : normalized;
+}
 
 // src/index.ts
-var defaultLibs = [luauLib, robloxLib];
 var luautparser = {
   tokenize,
   parseTokens,
@@ -5854,6 +6237,7 @@ var luautparser = {
 var index_default = luautparser;
 export {
   BinaryOperators,
+  CONFIG_FILE_NAMES,
   Keywords,
   LexError,
   Operators,
@@ -5868,10 +6252,10 @@ export {
   bufferType,
   containsTypeParam,
   index_default as default,
-  defaultLibs,
   difference,
   equalTypes,
   falsyType,
+  findConfig,
   fn,
   formatType,
   getBinding,
@@ -5882,11 +6266,10 @@ export {
   isPossiblyTruthy,
   isUnassignedGlobal,
   literal,
-  luauDefs,
-  luauDefsPath,
-  luauLib,
+  loadConfig,
   luautparser,
   matchInfer,
+  moduleCandidates,
   moduleExports,
   narrowExclude,
   narrowFalsy,
@@ -5894,6 +6277,7 @@ export {
   narrowTruthy,
   neverType,
   nilType,
+  nodeHost,
   numberType,
   objectType,
   optional,
@@ -5903,11 +6287,12 @@ export {
   parseTokens,
   parseWithRecovery,
   primitive,
-  robloxDefs,
-  robloxDefsPath,
-  robloxLib,
+  resolveModulePath,
+  resolveTypeLibraries,
   setAliasExpander,
+  sourceMapTypes,
   stringType,
+  stripJsonComments,
   substitute,
   templateMatches,
   threadType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "luaut-parser",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "luaut parser for roblox",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -23,7 +23,7 @@
     }
   },
   "scripts": {
-    "test": "tsx scripts/test.ts",
+    "test": "tsx scripts/test.ts && tsx scripts/project.test.ts",
     "build": "tsup",
     "typecheck": "tsc --noEmit"
   },
@@ -32,6 +32,8 @@
   "license": "ISC",
   "type": "module",
   "devDependencies": {
+    "@luaut/luau": "^1.0.0",
+    "@luaut/roblox": "^1.0.0",
     "@types/node": "^22.0.0",
     "tsup": "^8.5.1",
     "tsx": "^4.19.0",