Move to ES module syntax

LICENSE

@@ -1,7 +1,8 @@
 MIT License
 
 Copyright © 2017-2019 Benoit Giannangeli
-Copyright © 2017-2025 Daurnimator
+Copyright © 2017-2024 Daurnimator
+Copyright © 2026 CtrlO Ltd
 Copyright © 1994–2017 Lua.org, PUC-Rio.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

NEWS

@@ -1,3 +1,7 @@
+0.1.6 - 2026-06-04
+
+  - Move across to ES modules
+
 0.1.5 - 2025-12-26
 
   - Add os.setlocale that only understands the C locale

README.md

@@ -1,7 +1,5 @@
 [![Build Status](https://github.com/fengari-lua/fengari/actions/workflows/ci.yaml/badge.svg)](https://github.com/fengari-lua/fengari/actions/workflows/ci.yaml?query=event%3Apush)
-[![npm](https://img.shields.io/npm/v/fengari.svg)](https://npmjs.com/package/fengari)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![#fengari on libera.chat](https://img.shields.io/badge/chat-%23fengari-brightgreen)](https://web.libera.chat/?channels=#fengari)
 
 <p align="center">
     <img src="https://github.com/fengari-lua/fengari/raw/master/logo.png" alt="Fengari" width="304" height="304">
@@ -10,13 +8,13 @@
 
 # Fengari
 
-🌙 φεγγάρι - The Lua VM written in JS ES6 for Node and the browser
+🌙 φεγγάρι - The Lua VM written in JS ES for Node and the browser
 
 This repository contains the core fengari code (which is a port of the Lua C library) which includes parser, virtual machine and base libraries.
 However it is rare to use this repository directly.
 
-- To use fengari in a web browser as easily as you might use JavaScript, see [fengari-web](https://github.com/fengari-lua/fengari-web)
-- [fengari-interop](https://github.com/fengari-lua/fengari-interop) is a lua library that makes interoperating with JavaScript objects simple, it is already included in fengari-web.
+- To use fengari in a web browser as easily as you might use JavaScript, see [fengari-web](https://github.com/droberts-ctrlo/fengari-web)
+- [fengari-interop](https://github.com/droberts-ctrlo/fengari-interop) is a lua library that makes interoperating with JavaScript objects simple, it is already included in fengari-web.
 - For a clone of the `lua` command line tool, but running under node.js, see [fengari-node-cli](https://github.com/fengari-lua/fengari-node-cli)
 
 ### The JS API

babel.config.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+    "presets": [
+        "@babel/preset-env",
+    ],
+};

eslint.config.js

@@ -0,0 +1,25 @@
+import js from "@eslint/js";
+import globals from "globals";
+import {defineConfig} from "eslint/config";
+import stylistic from "@stylistic/eslint-plugin";
+
+export default defineConfig([
+    { ignores: ["dist", "node_modules", "*.config.*"] },
+    { files: ["**/src/*.js"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: { ...globals.node, ...globals.browser, ...globals.worker } } },
+    { files: ["**/test/*.test.js"], languageOptions: { globals: { ...globals.node, ...globals.browser, ...globals.worker, ...globals.jest } } },
+    { plugins: {'@stylistic': stylistic} },
+    {
+        rules: {
+            "@stylistic/semi": "error",
+            "@typescript-eslint/no-explicit-any": "off",
+            '@stylistic/quotes': ['error', 'single'],
+            '@stylistic/no-extra-semi': 'error',
+            '@stylistic/semi': ['error', 'always'],
+            '@stylistic/curly-newline': 'error',
+            '@stylistic/indent': ['error', 4],
+            '@stylistic/comma-dangle': ['error', 'never'],
+            'no-unused-vars': ['error', { argsIgnorePattern: '^_', caughtErrors: 'none' }],
+            'no-empty': ['error', { allowEmptyCatch: true }]
+        }
+    }
+]);

jest.config.cjs

@@ -0,0 +1,199 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rt",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  //moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "./test/**/*.test.js",
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: [
+    "/node_modules/"
+  ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    "^.+\\.js$": "babel-jest",
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+module.exports = config;

package.json

@@ -1,8 +1,9 @@
 {
-  "name": "fengari",
-  "version": "0.1.5",
-  "description": "A Lua VM written in JS ES6 targeting the browser",
+  "name": "@ctrlo/fengari",
+  "version": "0.1.6",
+  "description": "A Lua VM written in JS modules targeting the browser",
   "main": "src/fengari.js",
+  "type": "module",
   "directories": {
     "lib": "src",
     "test": "test"
@@ -14,29 +15,37 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/fengari-lua/fengari.git"
+    "url": "git+https://github.com/droberts-ctrlo/fengari.git"
   },
   "keywords": [
     "lua",
     "vm"
   ],
   "contributors": [
     "Benoit Giannangeli",
-    "Daurnimator <quae@daurnimator.com>"
+    "Daurnimator <quae@daurnimator.com>",
+    "Dave Roberts <d.roberts@ctrlo.com>"
   ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/fengari-lua/fengari/issues"
+    "url": "https://github.com/droberts-ctrlo/fengari/issues"
   },
-  "homepage": "https://github.com/fengari-lua/fengari#readme",
+  "homepage": "https://github.com/droberts-ctrlo/fengari#readme",
   "devDependencies": {
-    "eslint": "^9.39.2",
-    "jest": "^30.2.0"
+    "@babel/core": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "babel-jest": "^30.4.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint": "^10.0.0",
+    "globals": "^17.6.0",
+    "jest": "^24.5.0"
   },
   "dependencies": {
-    "readline-sync": "^1.4.10",
-    "sprintf-js": "^1.1.3",
-    "tmp": "^0.2.5"
+    "readline-sync": "^1.4.9",
+    "sprintf-js": "^1.1.2",
+    "tmp": "^0.0.33"
   },
   "sideEffects": false
 }

src/common.js

@@ -0,0 +1,9 @@
+const conf = (typeof process !== 'undefined' && process.env.FENGARICONF ? JSON.parse(process.env.FENGARICONF) : {});
+
+/*
+@@ LUAI_MAXSTACK limits the size of the Lua stack.
+** CHANGE it if you need a different limit. This limit is arbitrary;
+** its only purpose is to stop Lua from consuming unlimited stack
+** space (and to reserve some numbers for pseudo-indices).
+*/
+export const LUAI_MAXSTACK = conf.LUAI_MAXSTACK || 1000000;