@thigasdevelopment/luam 0.12.0 → 0.13.0

package/lua/env.lua

@@ -0,0 +1,91 @@
+local ENVIRONMENT_FILE = '__LUAM_ENV_FILE__'; -- Replaced at build time with the file the manifest selects. (.env, .env.development, ...)
+
+---@param str string
+---@return string
+local function trim (str)
+	return str:match ('^%s*(.-)%s*$');
+end
+
+---@param path string
+---@return string
+local function load (path)
+	local pathType = type (path);
+	if (pathType ~= 'string') then
+		error ('bad argument #1 to \'load\' (\'string\' expected got \'' .. pathType .. '\').', 2);
+	end
+
+	if (not fileExists (path)) then return end
+
+	local file = fileOpen (path, true);
+	if (not file) then
+		error ('Failed to open environment file.', 2);
+	end
+
+	local content = fileRead (file, fileGetSize (file));
+	fileClose (file);
+
+	return content;
+end
+
+---@param value string
+---@return boolean | number | string
+local function normalize (value)
+	local number = tonumber (value);
+	if (number) then
+		value = number;
+	elseif (value:lower () == 'true') then
+		value = true;
+	elseif (value:lower () == 'false') then
+		value = false;
+	end
+	return value;
+end
+
+---@param content string
+---@return table<string, any>
+local function parse (content)
+	local result = { };
+
+	local lines = content:gmatch ('[^\r\n]+');
+	for line in lines do
+		line = trim (line);
+		if (line ~= '') and (not line:find ('^#')) then
+			local key, value = line:match ('^([%w_]+)%s*=%s*(.*)$');
+			if (key and value) then
+				if (value:sub (1, 1) == '"' and value:sub (-1) == '"') or (value:sub (1, 1) == "'" and value:sub (-1) == "'") then
+					value = value:sub (2, -2);
+				end
+
+				local value = normalize (value);
+				result[key] = value;
+			end
+		end
+	end
+
+	return result;
+end
+
+local content = load (ENVIRONMENT_FILE);
+if (not content) then return end
+content = parse (content);
+
+env = setmetatable ({ }, {
+	---@param _ string | number
+	---@param key string
+	---@return boolean | number | string
+	__index = function (_, key)
+		local value = content[key];
+		if (value == nil) then
+			error ('"' .. tostring(key) .. '" is not declared in "' .. ENVIRONMENT_FILE .. '".', 2);
+		end
+		return value;
+	end,
+
+	---@param _ string | number
+	---@param key string
+	__newindex = function (_, key)
+		error ('The environment is read-only and "' .. tostring(key) .. '" cannot be assigned.', 2);
+	end,
+
+	__metatable = false,
+});

package/luam.mjs

@@ -4942,8 +4942,8 @@ function createObjectType(members) {
   return createRecord(keys.length === 0 ? "{}" : `{ ${keys.join(", ")} }`, members);
 }
 function createLiteralRecord(members) {
-  const literal2 = createObjectType(members);
-  return literal2.kind === "record" ? { ...literal2, isLiteral: true } : literal2;
+  const literal = createObjectType(members);
+  return literal.kind === "record" ? { ...literal, isLiteral: true } : literal;
 }
 function isEmptyLiteral(type) {
   return type.kind === "record" && type.isLiteral === true && type.members.size === 0;
@@ -5279,6 +5279,7 @@ var RUNTIME_HELPERS = {
     injection: "automatic",
     features: ["class-declaration", "class-inheritance", "class-instantiation", "super-call", "enum-declaration"]
   },
+  env: { name: "env", file: "env.lua", injection: "manual", features: [], environment: "server" },
   math: { name: "math", file: "math.lua", injection: "automatic", features: ["number-extension"] },
   string: { name: "string", file: "string.lua", injection: "automatic", features: ["string-extension", "template-string"] },
   table: { name: "table", file: "table.lua", injection: "automatic", features: ["table-extension"] },
@@ -6490,7 +6491,7 @@ import { tmpdir } from "node:os";
 import { join as join2 } from "node:path";
 
 // src/cli/version.ts
-var VERSION = true ? "0.12.0" : "0.0.0-dev";
+var VERSION = true ? "0.13.0" : "0.0.0-dev";
 var PROGRAM_NAME = "luam";
 var PROGRAM_DESCRIPTION = "luam \u2014 the Luam compiler for Multi Theft Auto resources.";
 
@@ -7647,80 +7648,49 @@ function mergeEnvFiles(base, overrides) {
   return { entries: [...merged.values()], errors: [...base.errors, ...overrides.errors] };
 }
 
-// ../compiler/src/project/env-script.ts
+// ../compiler/src/project/env-template.ts
 var HEADER = [
-  "-- Deployment values for this resource.",
-  '-- Generated once by "luam build" and owned by the server administrator.',
-  "-- The compiler never overwrites this file, and it is never sent to clients.",
-  "--",
-  "-- Edit the values below. Text values must stay quoted; numbers and booleans must not.",
-  ""
-];
-var FOOTER = [
-  "",
-  "env = setmetatable({}, {",
-  "    __index = function(_, key)",
-  "        local value = values[key]",
-  "",
-  "        if value == nil then",
-  `            error('"' .. tostring(key) .. '" is not declared in "env.lua".', 2)`,
-  "        end",
-  "",
-  "        return value",
-  "    end,",
-  "    __newindex = function(_, key)",
-  `        error('The environment is read-only and "' .. tostring(key) .. '" cannot be assigned.', 2)`,
-  "    end,",
-  "    __metatable = false,",
-  "})",
-  "",
-  "if type(process) ~= 'table' then",
-  "    process = {}",
-  "end",
-  "",
-  "process.env = env",
+  "# Deployment values for this resource.",
+  '# Generated once by "luam build" and owned by the server administrator.',
+  "# The compiler never overwrites this file, and it is never sent to clients.",
+  "#",
+  "# Edit a value and restart the resource. A key left out falls back to nothing,",
+  "# so keep every key the project declares.",
   ""
 ];
-var BLANK = { boolean: "false", number: "0", string: "''" };
-function quote(value) {
-  return `'${value.replace(/\\/g, "\\\\").replace(/'/g, "\\'").replace(/\n/g, "\\n").replace(/\r/g, "\\r")}'`;
-}
-function literal(entry) {
-  if (isSensitiveKey(entry.key)) {
-    return BLANK[entry.kind];
+function quote(entry) {
+  if (entry.kind !== "string" || /^[A-Za-z0-9._:/@-]*$/.test(entry.value)) {
+    return entry.value;
   }
-  return entry.kind === "string" ? quote(entry.value) : entry.value;
+  return `"${entry.value.replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
 }
 function line(entry) {
-  return `    ${entry.key} = ${literal(entry)},`;
+  return `${entry.key}=${isSensitiveKey(entry.key) ? "" : quote(entry)}`;
 }
-function renderEnvironmentScript(file) {
-  const entries2 = [...file.entries].sort((left, right) => left.key.localeCompare(right.key));
-  return [...HEADER, "local values = {", ...entries2.map(line), "}", ...FOOTER].join("\n");
+function renderEnvironmentTemplate(file) {
+  return [...HEADER, ...file.entries.map(line), ""].join("\n");
 }
 
 // ../compiler/src/project/resource.ts
 var ENVIRONMENT_FILE = ".env";
-var ENVIRONMENT_SCRIPT = "env.lua";
+var ENVIRONMENT_FILE_PLACEHOLDER = "__LUAM_ENV_FILE__";
 function configurationScript(configuration) {
   if (configuration === null || configuration === void 0) {
     return null;
   }
   return { path: configuration.path, source: configuration.source, environment: "shared", content: configuration.content, lines: [] };
 }
-function environmentScript(content) {
-  if (content === null || content === void 0) {
-    return null;
-  }
-  return { path: ENVIRONMENT_SCRIPT, source: ENVIRONMENT_FILE, environment: "server", content, lines: [] };
+function withEnvironmentFile(helpers, file) {
+  return helpers.map(
+    (helper) => helper.helper === "env" ? { ...helper, replacements: { [ENVIRONMENT_FILE_PLACEHOLDER]: file ?? ENVIRONMENT_FILE } } : helper
+  );
 }
 function helperEntry(helper) {
   return { src: helper.path, environment: helper.environment, group: "library" };
 }
-function manifestScripts(helpers, environment, configuration, sources) {
-  const deployment = environment === null ? [] : [{ src: environment.path, environment: "server", group: "configuration" }];
+function manifestScripts(helpers, configuration, sources) {
   const settings = configuration === null ? [] : [{ src: configuration.path, environment: "shared", group: "configuration" }];
-  return [...helpers.map(helperEntry), ...deployment, ...settings, ...sources];
+  return [...helpers.map(helperEntry), ...settings, ...sources];
 }
 function collectContributions(project) {
   return project.modules.flatMap((module) => module.contributions);
@@ -7790,11 +7760,11 @@ function assembleResource(project, options, onStep) {
   if (project.hasErrors) {
     return { build: null, diagnostics: project.diagnostics };
   }
-  const helpers = [...collectHelpers(project.modules, options.helpers ?? []), ...collectDevelopmentLogHelpers(options.developmentLogs)];
+  const collected = [...collectHelpers(project.modules, options.helpers ?? []), ...collectDevelopmentLogHelpers(options.developmentLogs)];
+  const helpers = withEnvironmentFile(collected, options.environmentFile);
   const scripts = collectScripts(project.modules);
   const configuration = configurationScript(options.configuration);
-  const environment = environmentScript(options.environmentScript);
-  const deployment = [configuration, environment].filter((script) => script !== null);
+  const deployment = configuration === null ? [] : [configuration];
   const sorted = [...options.assets ?? []].sort((left, right) => left.path.localeCompare(right.path));
   const order = resolveLoadOrder(options.loadOrder ?? [], scripts, sorted);
   const layout = options.layout ?? "tree";
@@ -7811,17 +7781,14 @@ function assembleResource(project, options, onStep) {
   const manifestHelpers = layout === "tree" ? helpers : [];
   const manifest = generateManifest(
     manifestInfo(options),
-    manifestScripts(manifestHelpers, environment, configuration, sources),
+    manifestScripts(manifestHelpers, configuration, sources),
     manifestFiles(assets),
     collectContributions(project),
     { oop: options.oop === true, minMtaVersion: options.minMtaVersion ?? null, dependencies: options.dependencies ?? [] }
   );
   onStep?.("manifest");
   const map = layout === "tree" ? treeResourceMap(options.resourceName ?? "", scripts) : null;
-  return {
-    build: { manifest, scripts: layout === "tree" ? scripts : [], helpers, configuration, environmentScript: environment, assets, bundles, layout, map },
-    diagnostics
-  };
+  return { build: { manifest, scripts: layout === "tree" ? scripts : [], helpers, configuration, assets, bundles, layout, map }, diagnostics };
 }
 
 // src/build/asset-resolution.ts
@@ -8058,8 +8025,6 @@ function fn(parameters, returnType, minimumArguments2, isVariadic = false) {
 
 // ../compiler/src/checker/project-declarations.ts
 var EMPTY_PROJECT_DECLARATIONS = { globals: [] };
-var PROCESS_GLOBAL = "process";
-var PROCESS_ENV = "process.env";
 var ENV_GLOBAL = "env";
 var VALUE_TYPES = { boolean: BOOLEAN, number: NUMBER, string: STRING };
 function envMembers(entries2) {
@@ -8069,11 +8034,6 @@ function envMembers(entries2) {
   }
   return [...members.values()].sort((left, right) => left.name.localeCompare(right.name));
 }
-function environmentDeclaration(entries2, origin) {
-  const env = record(PROCESS_ENV, envMembers(entries2), origin);
-  const process2 = record(PROCESS_GLOBAL, [{ name: ENV_GLOBAL, type: env }], origin);
-  return { name: PROCESS_GLOBAL, environment: "server", source: "project", type: process2 };
-}
 function envDeclaration(entries2, origin) {
   const env = record(ENV_GLOBAL, envMembers(entries2), origin);
   return { name: ENV_GLOBAL, environment: "server", source: "project", type: env };
@@ -8082,7 +8042,7 @@ function projectDeclarations(entries2, origin) {
   if (entries2 === null) {
     return EMPTY_PROJECT_DECLARATIONS;
   }
-  return { globals: [environmentDeclaration(entries2, origin), envDeclaration(entries2, origin)] };
+  return { globals: [envDeclaration(entries2, origin)] };
 }
 
 // ../compiler/src/checker/ambient.ts
@@ -13591,8 +13551,8 @@ var EXTENSION_RESULTS = {
   table: TABLE_TYPE
 };
 function extensionType(receiver, property) {
-  const literal2 = receiver.kind === "string-literal" ? "string" : receiver.kind === "number-literal" ? "number" : null;
-  const kind = literal2 ?? (receiver.kind === "string" || receiver.kind === "number" ? receiver.kind : null);
+  const literal = receiver.kind === "string-literal" ? "string" : receiver.kind === "number-literal" ? "number" : null;
+  const kind = literal ?? (receiver.kind === "string" || receiver.kind === "number" ? receiver.kind : null);
   const target = kind ?? (isTableLike(receiver) ? "table" : null);
   if (target === null) {
     return null;
@@ -15376,14 +15336,21 @@ function createProjectCache() {
 }
 
 // src/build/build-runner.ts
+function helperList(config, inputs) {
+  if (inputs.declared === null || config.helpers.includes("env")) {
+    return config.helpers;
+  }
+  const helpers = [...config.helpers, "env"];
+  return helpers.sort();
+}
 function resourceOptions(config, inputs, minMtaVersion, developmentLogs, layout) {
   const options = {
     oop: config.compilerOptions.oop,
     dependencies: config.dependencies,
-    helpers: config.helpers,
+    helpers: helperList(config, inputs),
     assets: inputs.assets,
     configuration: inputs.configuration,
-    environmentScript: inputs.deployed === null ? null : renderEnvironmentScript(inputs.deployed),
+    environmentFile: config.environment.file,
     loadOrder: config.loadOrder,
     minMtaVersion,
     developmentLogs,
@@ -15437,6 +15404,7 @@ function runCompile(root, config, options = {}) {
       fileCount: 0,
       durationMs: performance.now() - started,
       stats: null,
+      environmentTemplate: null,
       phases: tracker.durations(),
       sources: /* @__PURE__ */ new Map(),
       map: null
@@ -15468,6 +15436,7 @@ function runCompile(root, config, options = {}) {
     fileCount: sources.files.length,
     durationMs: performance.now() - started,
     stats: project.stats,
+    environmentTemplate: inputs.deployed === null ? null : renderEnvironmentTemplate(inputs.deployed),
     phases: tracker.durations(),
     sources: diagnosticSources(sources.files, assembly.diagnostics),
     map: build?.map ?? null
@@ -15814,7 +15783,7 @@ import { existsSync as existsSync6, readdirSync as readdirSync3, rmdirSync, unli
 import { join as join5, relative as relative3, resolve as resolve9 } from "node:path";
 var GENERATED_MANIFEST = "meta.xml";
 var GENERATED_EXTENSION = ".lua";
-var PROTECTED = /* @__PURE__ */ new Set([ENVIRONMENT_FILE, ENVIRONMENT_SCRIPT, ".env.local"]);
+var PROTECTED = /* @__PURE__ */ new Set([ENVIRONMENT_FILE, ".env.local"]);
 function normalize(path) {
   return path.replace(/\\/g, "/");
 }
@@ -15903,23 +15872,23 @@ function writeIfChanged(absolute, content) {
   writeFileSync4(absolute, content);
   return true;
 }
-function writeEnvironmentScript(targetDir, script) {
-  if (script === null) {
+function writeEnvironmentFile(targetDir, template) {
+  if (template === null) {
     return false;
   }
-  const absolute = resolveInside(targetDir, script.path);
+  const absolute = resolveInside(targetDir, ENVIRONMENT_FILE);
   if (existsSync7(absolute)) {
     return false;
   }
   mkdirSync3(dirname3(absolute), { recursive: true });
-  writeFileSync4(absolute, script.content, "utf8");
+  writeFileSync4(absolute, template, "utf8");
   return true;
 }
 function writeResource(targetDir, build, options) {
   const assembled = resourceFiles(build);
   const files = options.minify === true ? minifyLuaFiles(assembled) : assembled;
   const written = [];
-  const total = files.size + build.assets.length + (build.environmentScript === null ? 0 : 1);
+  const total = files.size + build.assets.length + (options.environmentTemplate === null ? 0 : 1);
   let index = 0;
   let unchanged = 0;
   const advance = (path) => {
@@ -15944,13 +15913,13 @@ function writeResource(targetDir, build, options) {
     unchanged += 1;
     advance(asset.path);
   }
-  if (build.environmentScript !== null) {
-    if (writeEnvironmentScript(targetDir, build.environmentScript)) {
-      written.push(build.environmentScript.path);
+  if (options.environmentTemplate !== null) {
+    if (writeEnvironmentFile(targetDir, options.environmentTemplate)) {
+      written.push(ENVIRONMENT_FILE);
     }
-    advance(build.environmentScript.path);
+    advance(ENVIRONMENT_FILE);
   }
-  const keep = /* @__PURE__ */ new Set([...files.keys(), ...build.assets.map((asset) => asset.path), ENVIRONMENT_FILE, ENVIRONMENT_SCRIPT]);
+  const keep = /* @__PURE__ */ new Set([...files.keys(), ...build.assets.map((asset) => asset.path), ENVIRONMENT_FILE]);
   const removed = pruneResource(targetDir, keep, { generatedFiles: options.generatedFiles, generatedRoots: options.generatedRoots });
   return { written: written.sort((left, right) => left.localeCompare(right)), removed, unchanged };
 }
@@ -15968,18 +15937,19 @@ function generatedRoots(config) {
   const roots = config.assets.map(destinationRoot).filter((root) => root.length > 0);
   return [.../* @__PURE__ */ new Set([...roots, LIBRARY_DIRECTORY])];
 }
-function trackedWriteOptions(root, config, tracker) {
+function trackedWriteOptions(root, config, environmentTemplate, tracker) {
   return {
     root,
     generatedFiles: generatedFiles(),
     generatedRoots: generatedRoots(config),
+    environmentTemplate,
     onProgress: (event) => {
       tracker.advance(event.item, event.index, event.total);
     }
   };
 }
-function productionWriteOptions(root, config, tracker, minify) {
-  return { ...trackedWriteOptions(root, config, tracker), minify: minify ?? config.output.minify };
+function productionWriteOptions(root, config, environmentTemplate, tracker, minify) {
+  return { ...trackedWriteOptions(root, config, environmentTemplate, tracker), minify: minify ?? config.output.minify };
 }
 
 // src/commands/command-context.ts
@@ -16172,7 +16142,7 @@ async function runBuildCommand(context, options = {}) {
   const target = resolveBuildTarget(context.root, context.config);
   tracker.begin("write");
   const minify = options.minify ?? context.config.output.minify;
-  const writeOptions = productionWriteOptions(context.root, context.config, tracker, minify);
+  const writeOptions = productionWriteOptions(context.root, context.config, outcome.environmentTemplate, tracker, minify);
   let result;
   try {
     result = writeResource(target, outcome.build, writeOptions);
@@ -16281,7 +16251,7 @@ async function runOnce(scope, transport, target, cache3, options) {
     reporter.warn("Skipping sync and restart because the build reported errors.");
     return failed(outcome);
   }
-  const writeOptions = trackedWriteOptions(context.root, context.config, tracker);
+  const writeOptions = trackedWriteOptions(context.root, context.config, outcome.environmentTemplate, tracker);
   reportBuildOutcome(context, outcome, "Build");
   tracker.begin("sync");
   const sync = writeResource(target, outcome.build, writeOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thigasdevelopment/luam",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "description": "The Luam compiler for Multi Theft Auto resources.",
     "keywords": [
         "mta",