@adonisjs/repl 5.0.0-next.0 → 5.0.0-next.2

package/build/index.d.ts

@@ -1 +1 @@
-export { Repl } from './src/repl.js';
+export { Repl } from './src/repl.ts';

package/build/index.js

@@ -1,306 +1,204 @@
-// src/repl.ts
 import stringWidth from "string-width";
 import useColors from "@poppinss/colors";
-import { inspect, promisify as utilPromisify } from "util";
-import { Recoverable, start as startRepl } from "repl";
-var GLOBAL_NODE_PROPERTIES = [
-  "performance",
-  "global",
-  "clearInterval",
-  "clearTimeout",
-  "setInterval",
-  "setTimeout",
-  "queueMicrotask",
-  "clearImmediate",
-  "setImmediate",
-  "structuredClone",
-  "atob",
-  "btoa",
-  "fetch",
-  "crypto",
-  "navigator"
+import { inspect, promisify } from "node:util";
+import { Recoverable, start } from "node:repl";
+const GLOBAL_NODE_PROPERTIES = [
+	"performance",
+	"global",
+	"clearInterval",
+	"clearTimeout",
+	"setInterval",
+	"setTimeout",
+	"queueMicrotask",
+	"clearImmediate",
+	"setImmediate",
+	"structuredClone",
+	"atob",
+	"btoa",
+	"fetch",
+	"crypto",
+	"navigator",
+	"localStorage",
+	"sessionStorage"
 ];
-var TS_UTILS_HELPERS = [
-  "__extends",
-  "__assign",
-  "__rest",
-  "__decorate",
-  "__param",
-  "__esDecorate",
-  "__runInitializers",
-  "__propKey",
-  "__setFunctionName",
-  "__metadata",
-  "__awaiter",
-  "__generator",
-  "__exportStar",
-  "__createBinding",
-  "__values",
-  "__read",
-  "__spread",
-  "__spreadArrays",
-  "__spreadArray",
-  "__await",
-  "__asyncGenerator",
-  "__asyncDelegator",
-  "__asyncValues",
-  "__makeTemplateObject",
-  "__importStar",
-  "__importDefault",
-  "__classPrivateFieldGet",
-  "__classPrivateFieldSet",
-  "__classPrivateFieldIn"
+const TS_UTILS_HELPERS = [
+	"__extends",
+	"__assign",
+	"__rest",
+	"__decorate",
+	"__param",
+	"__esDecorate",
+	"__runInitializers",
+	"__propKey",
+	"__setFunctionName",
+	"__metadata",
+	"__awaiter",
+	"__generator",
+	"__exportStar",
+	"__createBinding",
+	"__values",
+	"__read",
+	"__spread",
+	"__spreadArrays",
+	"__spreadArray",
+	"__await",
+	"__asyncGenerator",
+	"__asyncDelegator",
+	"__asyncValues",
+	"__makeTemplateObject",
+	"__importStar",
+	"__importDefault",
+	"__classPrivateFieldGet",
+	"__classPrivateFieldSet",
+	"__classPrivateFieldIn"
 ];
 var Repl = class {
-  #replOptions;
-  /**
-   * Length of the longest custom method name. We need to show a
-   * symmetric view of custom methods and their description
-   */
-  #longestCustomMethodName = 0;
-  /**
-   * Reference to the original `eval` method of the repl server.
-   * Since we are monkey patching it, we need a reference to it
-   * to call it after our custom logic
-   */
-  #originalEval;
-  /**
-   * Compiler that will transform the user input just
-   * before evaluation
-   */
-  #compiler;
-  /**
-   * Path to the history file
-   */
-  #historyFilePath;
-  /**
-   * Set of registered ready callbacks
-   */
-  #onReadyCallbacks = [];
-  /**
-   * A set of registered custom methods
-   */
-  #customMethods = {};
-  /**
-   * Colors reference
-   */
-  colors = useColors.ansi();
-  /**
-   * Reference to the repl server. Available after the `start` method
-   * is invoked
-   */
-  server;
-  constructor(options) {
-    const { compiler, historyFilePath, ...rest } = options || {};
-    this.#compiler = compiler;
-    this.#historyFilePath = historyFilePath;
-    this.#replOptions = rest;
-  }
-  /**
-   * Registering custom methods with the server context by wrapping
-   * them inside a function and passes the REPL server instance
-   * to the method
-   */
-  #registerCustomMethodWithContext(name) {
-    const customMethod = this.#customMethods[name];
-    if (!customMethod) {
-      return;
-    }
-    const handler = (...args) => customMethod.handler(this, ...args);
-    Object.defineProperty(handler, "name", { value: customMethod.handler.name });
-    this.server.context[name] = handler;
-  }
-  /**
-   * Setup context with default globals
-   */
-  #setupContext() {
-    this.addMethod(
-      "clear",
-      function clear(repl, key) {
-        if (!key) {
-          console.log(repl.colors.red("Define a property name to remove from the context"));
-        } else {
-          delete repl.server.context[key];
-        }
-        repl.server.displayPrompt();
-      },
-      {
-        description: "Clear a property from the REPL context",
-        usage: `clear ${this.colors.gray("(propertyName)")}`
-      }
-    );
-    this.addMethod(
-      "p",
-      function promisify(_, fn) {
-        return utilPromisify(fn);
-      },
-      {
-        description: 'Promisify a function. Similar to Node.js "util.promisify"',
-        usage: `p ${this.colors.gray("(function)")}`
-      }
-    );
-    Object.keys(this.#customMethods).forEach((name) => {
-      this.#registerCustomMethodWithContext(name);
-    });
-  }
-  /**
-   * Find if the error is recoverable or not
-   */
-  #isRecoverableError(error) {
-    return /^(Unexpected end of input|Unexpected token|' expected)/.test(error.message);
-  }
-  /**
-   * Custom eval method to execute the user code
-   *
-   * Basically we are monkey patching the original eval method, because
-   * we want to:
-   * - Compile the user code before executing it
-   * - And also benefit from the original eval method that supports
-   *   cool features like top level await
-   */
-  #eval(code, context, filename, callback) {
-    try {
-      const compiled = this.#compiler ? this.#compiler.compile(code, filename) : code;
-      return this.#originalEval(compiled, context, filename, callback);
-    } catch (error) {
-      if (this.#isRecoverableError(error)) {
-        callback(new Recoverable(error), null);
-        return;
-      }
-      callback(error, null);
-    }
-  }
-  /**
-   * Setup history file
-   */
-  #setupHistory() {
-    if (!this.#historyFilePath) {
-      return;
-    }
-    this.server.setupHistory(this.#historyFilePath, (error) => {
-      if (!error) {
-        return;
-      }
-      console.log(this.colors.red("Unable to write to the history file. Exiting"));
-      console.error(error);
-      process.exit(1);
-    });
-  }
-  /**
-   * Prints the help for the context properties
-   */
-  #printContextHelp() {
-    console.log("");
-    console.log(this.colors.green("CONTEXT PROPERTIES/METHODS:"));
-    const context = Object.keys(this.server.context).reduce(
-      (result, key) => {
-        if (!this.#customMethods[key] && !GLOBAL_NODE_PROPERTIES.includes(key) && !TS_UTILS_HELPERS.includes(key)) {
-          result[key] = this.server.context[key];
-        }
-        return result;
-      },
-      {}
-    );
-    console.log(inspect(context, false, 1, true));
-  }
-  /**
-   * Prints the help for the custom methods
-   */
-  #printCustomMethodsHelp() {
-    console.log("");
-    console.log(this.colors.green("GLOBAL METHODS:"));
-    Object.keys(this.#customMethods).forEach((method) => {
-      const { options } = this.#customMethods[method];
-      const usage = this.colors.yellow(options.usage || method);
-      const spaces = " ".repeat(this.#longestCustomMethodName - options.width + 2);
-      const description = this.colors.dim(options.description || "");
-      console.log(`${usage}${spaces}${description}`);
-    });
-  }
-  /**
-   * Prints the context to the console
-   */
-  #ls() {
-    this.#printCustomMethodsHelp();
-    this.#printContextHelp();
-    this.server.displayPrompt();
-  }
-  /**
-   * Notify by writing to the console
-   */
-  notify(message) {
-    console.log(this.colors.yellow().italic(message));
-    if (this.server) {
-      this.server.displayPrompt();
-    }
-  }
-  /**
-   * Register a callback to be invoked once the server is ready
-   */
-  ready(callback) {
-    this.#onReadyCallbacks.push(callback);
-    return this;
-  }
-  /**
-   * Register a custom loader function to be added to the context
-   */
-  addMethod(name, handler, options) {
-    const width = stringWidth(options?.usage || name);
-    if (width > this.#longestCustomMethodName) {
-      this.#longestCustomMethodName = width;
-    }
-    this.#customMethods[name] = { handler, options: Object.assign({ width }, options) };
-    if (this.server) {
-      this.#registerCustomMethodWithContext(name);
-    }
-    return this;
-  }
-  /**
-   * Returns the collection of registered methods
-   */
-  getMethods() {
-    return this.#customMethods;
-  }
-  /**
-   * Register a compiler. Make sure register the compiler before
-   * calling the start method
-   */
-  useCompiler(compiler) {
-    this.#compiler = compiler;
-    return this;
-  }
-  /**
-   * Start the REPL server
-   */
-  start(context) {
-    console.log("");
-    this.notify('Type ".ls" to a view list of available context methods/properties');
-    this.server = startRepl({
-      prompt: `> ${this.#compiler?.supportsTypescript ? "(ts) " : "(js) "}`,
-      input: process.stdin,
-      output: process.stdout,
-      terminal: process.stdout.isTTY && !Number.parseInt(process.env.NODE_NO_READLINE, 10),
-      useGlobal: true,
-      ...this.#replOptions
-    });
-    if (context) {
-      Object.keys(context).forEach((key) => {
-        this.server.context[key] = context[key];
-      });
-    }
-    this.server.defineCommand("ls", {
-      help: "View list of available context methods/properties",
-      action: this.#ls.bind(this)
-    });
-    this.#setupContext();
-    this.#setupHistory();
-    this.#originalEval = this.server.eval;
-    this.server.eval = this.#eval.bind(this);
-    this.server.displayPrompt();
-    this.#onReadyCallbacks.forEach((callback) => callback(this));
-    return this;
-  }
-};
-export {
-  Repl
+	#replOptions;
+	#longestCustomMethodName = 0;
+	#originalEval;
+	#compiler;
+	#historyFilePath;
+	#onReadyCallbacks = [];
+	#customMethods = {};
+	colors = useColors.ansi();
+	server;
+	constructor(options) {
+		const { compiler, historyFilePath, ...rest } = options || {};
+		this.#compiler = compiler;
+		this.#historyFilePath = historyFilePath;
+		this.#replOptions = rest;
+	}
+	#registerCustomMethodWithContext(name) {
+		const customMethod = this.#customMethods[name];
+		if (!customMethod) return;
+		const handler = (...args) => customMethod.handler(this, ...args);
+		Object.defineProperty(handler, "name", { value: customMethod.handler.name });
+		this.server.context[name] = handler;
+	}
+	#setupContext() {
+		this.addMethod("clear", function clear(repl, key) {
+			if (!key) console.log(repl.colors.red("Define a property name to remove from the context"));
+			else delete repl.server.context[key];
+			repl.server.displayPrompt();
+		}, {
+			description: "Clear a property from the REPL context",
+			usage: `clear ${this.colors.gray("(propertyName)")}`
+		});
+		this.addMethod("p", function promisify$1(_, fn) {
+			return promisify(fn);
+		}, {
+			description: "Promisify a function. Similar to Node.js \"util.promisify\"",
+			usage: `p ${this.colors.gray("(function)")}`
+		});
+		Object.keys(this.#customMethods).forEach((name) => {
+			this.#registerCustomMethodWithContext(name);
+		});
+	}
+	#isRecoverableError(error) {
+		return /^(Unexpected end of input|Unexpected token|' expected)/.test(error.message);
+	}
+	#eval(code, context, filename, callback) {
+		try {
+			const compiled = this.#compiler ? this.#compiler.compile(code, filename) : code;
+			return this.#originalEval(compiled, context, filename, callback);
+		} catch (error) {
+			if (this.#isRecoverableError(error)) {
+				callback(new Recoverable(error), null);
+				return;
+			}
+			callback(error, null);
+		}
+	}
+	#setupHistory() {
+		if (!this.#historyFilePath) return;
+		this.server.setupHistory(this.#historyFilePath, (error) => {
+			if (!error) return;
+			console.log(this.colors.red("Unable to write to the history file. Exiting"));
+			console.error(error);
+			process.exit(1);
+		});
+	}
+	#printContextHelp() {
+		console.log("");
+		console.log(this.colors.green("CONTEXT PROPERTIES/METHODS:"));
+		const context = Object.keys(this.server.context).reduce((result, key) => {
+			if (!this.#customMethods[key] && !GLOBAL_NODE_PROPERTIES.includes(key) && !TS_UTILS_HELPERS.includes(key)) result[key] = this.server.context[key];
+			return result;
+		}, {});
+		console.log(inspect(context, false, 1, true));
+	}
+	#printCustomMethodsHelp() {
+		console.log("");
+		console.log(this.colors.green("GLOBAL METHODS:"));
+		Object.keys(this.#customMethods).forEach((method) => {
+			const { options } = this.#customMethods[method];
+			const usage = this.colors.yellow(options.usage || method);
+			const spaces = " ".repeat(this.#longestCustomMethodName - options.width + 2);
+			const description = this.colors.dim(options.description || "");
+			console.log(`${usage}${spaces}${description}`);
+		});
+	}
+	#ls() {
+		this.#printCustomMethodsHelp();
+		this.#printContextHelp();
+		this.server.displayPrompt();
+	}
+	notify(message) {
+		console.log(this.colors.yellow().italic(message));
+		if (this.server) this.server.displayPrompt();
+	}
+	ready(callback) {
+		this.#onReadyCallbacks.push(callback);
+		return this;
+	}
+	addMethod(name, handler, options) {
+		const width = stringWidth(options?.usage || name);
+		if (width > this.#longestCustomMethodName) this.#longestCustomMethodName = width;
+		this.#customMethods[name] = {
+			handler,
+			options: Object.assign({ width }, options)
+		};
+		if (this.server) this.#registerCustomMethodWithContext(name);
+		return this;
+	}
+	getMethods() {
+		return this.#customMethods;
+	}
+	useCompiler(compiler) {
+		this.#compiler = compiler;
+		return this;
+	}
+	start(context) {
+		console.log("");
+		this.notify("Type \".ls\" to a view list of available context methods/properties");
+		this.server = start({
+			prompt: `> ${this.#compiler?.supportsTypescript ? "(ts) " : "(js) "}`,
+			input: process.stdin,
+			output: process.stdout,
+			terminal: process.stdout.isTTY && !Number.parseInt(process.env.NODE_NO_READLINE, 10),
+			useGlobal: true,
+			writer(output) {
+				return inspect(output, {
+					showProxy: false,
+					colors: true
+				});
+			},
+			...this.#replOptions
+		});
+		if (context) Object.keys(context).forEach((key) => {
+			this.server.context[key] = context[key];
+		});
+		this.server.defineCommand("ls", {
+			help: "View list of available context methods/properties",
+			action: this.#ls.bind(this)
+		});
+		this.#setupContext();
+		this.#setupHistory();
+		this.#originalEval = this.server.eval;
+		this.server.eval = this.#eval.bind(this);
+		this.server.displayPrompt();
+		this.#onReadyCallbacks.forEach((callback) => callback(this));
+		return this;
+	}
 };
+export { Repl };

package/build/src/repl.d.ts

@@ -1,6 +1,21 @@
 import type { Colors } from '@poppinss/colors/types';
 import { type REPLServer, type ReplOptions } from 'node:repl';
-import type { MethodCallback, MethodOptions, Compiler } from './types.js';
+import type { MethodCallback, MethodOptions, Compiler } from './types.ts';
+/**
+ * A REPL (Read-Eval-Print Loop) server implementation that provides an interactive
+ * command line interface for executing JavaScript/TypeScript code with custom methods
+ * and context management.
+ *
+ * @example
+ * const repl = new Repl({ historyFilePath: '.repl_history' })
+ *
+ * repl.addMethod('greet', (repl, name) => `Hello ${name}!`, {
+ *   description: 'Greets a person',
+ *   usage: 'greet (name)'
+ * })
+ *
+ * repl.start({ myVar: 'Hello World' })
+ */
 export declare class Repl {
     #private;
     /**
@@ -12,24 +27,65 @@ export declare class Repl {
      * is invoked
      */
     server?: REPLServer;
+    /**
+     * Creates a new REPL instance with optional configuration
+     *
+     * @param options - Configuration options for the REPL
+     * @param options.compiler - Custom compiler for transforming user input
+     * @param options.historyFilePath - Path to store command history
+     *
+     * @example
+     * const repl = new Repl({
+     *   historyFilePath: '.repl_history',
+     *   compiler: myTypeScriptCompiler
+     * })
+     */
     constructor(options?: {
         compiler?: Compiler;
         historyFilePath?: string;
     } & ReplOptions);
     /**
      * Notify by writing to the console
+     *
+     * @param message - The message to display
+     *
+     * @example
+     * repl.notify('Server connected successfully')
      */
     notify(message: string): void;
     /**
      * Register a callback to be invoked once the server is ready
+     *
+     * @param callback - Function to call when the REPL is ready
+     *
+     * @example
+     * repl.ready((repl) => {
+     *   repl.notify('REPL is ready!')
+     * })
      */
     ready(callback: (repl: Repl) => void): this;
     /**
      * Register a custom loader function to be added to the context
+     *
+     * @param name - The name of the method
+     * @param handler - The function to execute
+     * @param options - Optional configuration for the method
+     *
+     * @example
+     * repl.addMethod('greet', (repl, name) => {
+     *   return `Hello ${name}!`
+     * }, {
+     *   description: 'Greets a person by name',
+     *   usage: 'greet (name)'
+     * })
      */
     addMethod(name: string, handler: MethodCallback, options?: MethodOptions): this;
     /**
      * Returns the collection of registered methods
+     *
+     * @example
+     * const methods = repl.getMethods()
+     * console.log(Object.keys(methods)) // ['clear', 'p', 'myCustomMethod']
      */
     getMethods(): {
         [name: string]: {
@@ -42,10 +98,27 @@ export declare class Repl {
     /**
      * Register a compiler. Make sure register the compiler before
      * calling the start method
+     *
+     * @param compiler - The compiler instance to use for transforming code
+     *
+     * @example
+     * const tsCompiler = {
+     *   compile: (code, filename) => ts.transpile(code),
+     *   supportsTypescript: true
+     * }
+     * repl.useCompiler(tsCompiler)
      */
     useCompiler(compiler: Compiler): this;
     /**
      * Start the REPL server
+     *
+     * @param context - Optional initial context to populate the REPL with
+     *
+     * @example
+     * repl.start({
+     *   db: databaseConnection,
+     *   utils: myUtilities
+     * })
      */
     start(context?: Record<string, any>): this;
 }

package/build/src/types.d.ts

@@ -1,4 +1,4 @@
-import { type Repl } from './repl.js';
+import { type Repl } from './repl.ts';
 /**
  * Custom method callback function
  */

package/build/src/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@adonisjs/repl",
   "description": "REPL for AdonisJS",
-  "version": "5.0.0-next.0",
+  "version": "5.0.0-next.2",
   "engines": {
-    "node": ">=18.16.0"
+    "node": ">=24.0.0"
   },
   "type": "module",
   "files": [
@@ -23,29 +23,30 @@
     "typecheck": "tsc --noEmit",
     "clean": "del-cli build",
     "precompile": "npm run lint && npm run clean",
-    "compile": "tsup-node && tsc --emitDeclarationOnly --declaration",
+    "compile": "tsdown && tsc --emitDeclarationOnly --declaration",
     "build": "npm run compile",
     "version": "npm run build",
     "prepublishOnly": "npm run build",
     "release": "release-it"
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^3.0.0-next.1",
+    "@adonisjs/eslint-config": "^3.0.0-next.5",
     "@adonisjs/prettier-config": "^1.4.5",
-    "@adonisjs/tsconfig": "^2.0.0-next.0",
+    "@adonisjs/tsconfig": "^2.0.0-next.3",
     "@poppinss/ts-exec": "^1.4.1",
-    "@release-it/conventional-changelog": "^10.0.1",
-    "@types/node": "^24.3.0",
-    "del-cli": "^6.0.0",
-    "eslint": "^9.33.0",
-    "prettier": "^3.6.2",
-    "release-it": "^19.0.4",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
+    "@release-it/conventional-changelog": "^10.0.4",
+    "@types/node": "^25.0.8",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.2",
+    "prettier": "^3.8.0",
+    "release-it": "^19.2.3",
+    "tsdown": "^0.19.0",
+    "typedoc": "^0.28.16",
+    "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@poppinss/colors": "^4.1.5",
-    "string-width": "^7.2.0"
+    "@poppinss/colors": "^4.1.6",
+    "string-width": "^8.1.0"
   },
   "homepage": "https://github.com/adonisjs/repl#readme",
   "repository": {
@@ -66,7 +67,7 @@
     "access": "public",
     "provenance": true
   },
-  "tsup": {
+  "tsdown": {
     "entry": [
       "./index.ts",
       "./src/types.ts"
@@ -74,8 +75,11 @@
     "outDir": "./build",
     "clean": true,
     "format": "esm",
+    "minify": "dce-only",
+    "fixedExtension": false,
     "dts": false,
-    "sourcemap": false,
+    "treeshake": false,
+    "sourcemaps": false,
     "target": "esnext"
   },
   "release-it": {