@adonisjs/repl 4.0.0-0 → 4.0.0-1

package/build/index.d.ts

@@ -1,3 +1,2 @@
 import './src/types/extended.js';
 export { Repl } from './src/repl.js';
-//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -1,2 +1,10 @@
+/*
+ * @adonisjs/repl
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import './src/types/extended.js';
 export { Repl } from './src/repl.js';

package/build/src/repl.d.ts

@@ -1,17 +1,36 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
+import type { Colors } from '@poppinss/colors/types';
 import { REPLServer } from 'node:repl';
-import { Handler, ContextOptions, Compiler } from './types/main.js';
+import { Handler, ContextOptions, Compiler } from './types.js';
 export declare class Repl {
     #private;
-    colors: import("@poppinss/colors/types").Colors;
+    /**
+     * Colors reference
+     */
+    colors: Colors;
+    /**
+     * Reference to the repl server. Available after the `start` method
+     * is invoked
+     */
     server?: REPLServer;
     constructor(options?: {
         compiler?: Compiler;
         historyFilePath?: string;
     });
+    /**
+     * Notify by writing to the console
+     */
     notify(message: string): void;
+    /**
+     * Start the REPL server
+     */
     start(): this;
+    /**
+     * Register a callback to be invoked once the server is ready
+     */
     ready(callback: (repl: Repl) => void): this;
+    /**
+     * Register a custom loader function to be added to the context
+     */
     addMethod(name: string, handler: Handler, options?: ContextOptions): this;
 }
-//# sourceMappingURL=repl.d.ts.map

package/build/src/repl.js

@@ -1,9 +1,19 @@
+/*
+ * @adonisjs/repl
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import useColors from '@poppinss/colors';
-import { Recoverable } from 'node:repl';
-import prettyRepl from 'pretty-repl';
+import { Recoverable, start as startRepl } from 'node:repl';
 import stringWidth from 'string-width';
 import { inspect, promisify as utilPromisify } from 'node:util';
-import { colorizer } from './colorizer.js';
+/**
+ * List of node global properties to remove from the
+ * ls inspect
+ */
 const GLOBAL_NODE_PROPERTIES = [
     'performance',
     'global',
@@ -55,27 +65,71 @@ const icons = process.platform === 'win32' && !process.env.WT_SESSION
     ? { tick: '√', pointer: '>' }
     : { tick: '✔', pointer: '❯' };
 export class Repl {
+    /**
+     * 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 = null;
-    colors = useColors.ansi();
-    server;
+    /**
+     * Compiler that will transform the user input just
+     * before evaluation
+     */
     #compiler;
+    /**
+     * Set of registered ready callbacks
+     */
     #onReadyCallbacks = [];
+    /**
+     * A set of registered custom methods
+     */
     #customMethods = {};
+    /**
+     * Path to the history file
+     */
     #historyFilePath;
+    /**
+     * Colors reference
+     */
+    colors = useColors.ansi();
+    /**
+     * Reference to the repl server. Available after the `start` method
+     * is invoked
+     */
+    server;
     constructor(options) {
         this.#compiler = options?.compiler;
         this.#historyFilePath = options?.historyFilePath;
     }
+    /**
+     * Prints the welcome message
+     */
     #printWelcomeMessage() {
         console.log('');
+        /**
+         * Log about typescript support
+         */
         if (this.#compiler?.supportsTypescript) {
             console.log(`${this.colors.green(icons.tick)} ${this.colors.dim('typescript compilation supported')}`);
             console.log('');
         }
+        /**
+         * Log about help command
+         */
         this.notify('Type ".ls" to a view list of available context methods/properties');
     }
+    /**
+     * Setup context with default globals
+     */
     #setupContext() {
+        /**
+         * Register "clear" method
+         */
         this.addMethod('clear', function clear(repl, key) {
             if (!key) {
                 console.log(repl.colors.red('Define a property name to remove from the context'));
@@ -88,22 +142,43 @@ export class Repl {
             description: 'Clear a property from the REPL context',
             usage: `clear ${this.colors.gray('(propertyName)')}`,
         });
+        /**
+         * Register "p" method
+         */
         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)')}`,
         });
+        /**
+         * Register all custom methods with the context
+         */
         this.#registerCustomMethodsWithContext();
     }
+    /**
+     * Register custom methods with the server context
+     */
     #registerCustomMethodsWithContext() {
         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.
+     * The reason why we need to do that is 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.compile(code, filename)
@@ -119,6 +194,9 @@ export class Repl {
             callback(error, null);
         }
     }
+    /**
+     * Setup history file
+     */
     #setupHistory() {
         if (!this.#historyFilePath) {
             return;
@@ -132,7 +210,13 @@ export class Repl {
             process.exit(1);
         });
     }
+    /**
+     * Prints the help for the context properties
+     */
     #printContextHelp() {
+        /**
+         * Print context properties
+         */
         console.log('');
         console.log(this.colors.green('CONTEXT PROPERTIES/METHODS:'));
         const context = Object.keys(this.server.context).reduce((result, key) => {
@@ -145,7 +229,13 @@ export class Repl {
         }, {});
         console.log(inspect(context, false, 1, true));
     }
+    /**
+     * Prints the help for the custom methods
+     */
     #printCustomMethodsHelp() {
+        /**
+         * Print loader methods
+         */
         console.log('');
         console.log(this.colors.green('GLOBAL METHODS:'));
         Object.keys(this.#customMethods).forEach((method) => {
@@ -159,53 +249,95 @@ export class Repl {
         if (!customMethod) {
             return;
         }
+        /**
+         * Wrap handler
+         */
         const handler = (...args) => customMethod.handler(this, ...args);
+        /**
+         * Re-define the function name to be more description
+         */
         Object.defineProperty(handler, 'name', { value: customMethod.handler.name });
+        /**
+         * Register with the context
+         */
         this.server.context[name] = handler;
     }
+    /**
+     * 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();
         }
     }
+    /**
+     * Start the REPL server
+     */
     start() {
         this.#printWelcomeMessage();
-        this.server = prettyRepl.start({
+        this.server = startRepl({
             prompt: '> ',
             input: process.stdin,
             output: process.stdout,
             terminal: process.stdout.isTTY && !Number.parseInt(process.env.NODE_NO_READLINE, 10),
             useGlobal: true,
-            colorize: colorizer(),
         });
+        /**
+         * Define the `ls` command
+         */
         this.server.defineCommand('ls', {
             help: 'View list of available context methods/properties',
             action: this.#ls.bind(this),
         });
+        /**
+         * Setup context and history
+         */
         this.#setupContext();
         this.#setupHistory();
+        /**
+         * Monkey patch the eval method
+         */
         this.#originalEval = this.server.eval;
+        // @ts-ignore
         this.server.eval = this.#eval.bind(this);
+        /**
+         * Display prompt
+         */
         this.server.displayPrompt();
+        /**
+         * Execute onReady callbacks
+         */
         this.#onReadyCallbacks.forEach((callback) => callback(this));
         return this;
     }
+    /**
+     * 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) };
+        /**
+         * Register method right away when server has been started
+         */
         if (this.server) {
             this.#registerCustomMethodWithContext(name);
         }

package/build/src/{types/main.d.ts → types.d.ts}

@@ -1,11 +1,21 @@
-import { Repl } from '../repl.js';
+import { Repl } from './repl.js';
+/**
+ * Custom method handler
+ */
 export type Handler = (repl: Repl, ...args: any[]) => any;
+/**
+ * Options that can be set when defining a loader
+ * method
+ */
 export type ContextOptions = {
     description?: string;
     usage?: string;
 };
+/**
+ * Shape of the Compiler that must be passed to the
+ * repl constructor
+ */
 export type Compiler = {
     compile: (code: string, fileName: string) => string;
     supportsTypescript: boolean;
 };
-//# sourceMappingURL=main.d.ts.map

package/{index.ts → build/src/types.js}

@@ -6,7 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-import './src/types/extended.js'
-
-export { Repl } from './src/repl.js'
+export {};

package/package.json

@@ -1,39 +1,20 @@
 {
   "name": "@adonisjs/repl",
   "description": "REPL for AdonisJS",
-  "version": "4.0.0-0",
+  "version": "4.0.0-1",
   "main": "build/index.js",
   "type": "module",
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "files": [
-    "commands",
-    "index.ts",
-    "configure.ts",
-    "src",
-    "services",
-    "providers",
-    "factories",
-    "build/configure.js",
-    "build/configure.d.ts",
-    "build/configure.d.ts.map",
-    "build/index.js",
-    "build/index.d.ts",
-    "build/index.d.ts.map",
     "build/src",
-    "build/services",
-    "build/providers",
-    "build/commands",
     "build/factories",
-    "build/stubs",
     "build/index.d.ts",
-    "build/index.d.ts.map",
     "build/index.js"
   ],
   "exports": {
     ".": "./build/index.js",
-    "./commands": "./build/commands/main.js",
-    "./commands/*": "./build/commands/*.js",
-    "./providers/repl_provider": "./build/providers/repl_provider.js",
-    "./services/main": "./build/services/main.js",
     "./types": "./build/src/types/main.js"
   },
   "scripts": {
@@ -41,58 +22,41 @@
     "test": "c8 npm run quick:test",
     "lint": "eslint . --ext=.ts",
     "clean": "del-cli build",
-    "compile": "npm run lint && npm run clean && tsc && npm run copy:templates && npm run index:commands",
-    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
     "release": "np --message=\"chore(release): %s\"",
     "version": "npm run build",
     "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/repl",
-    "quick:test": "node --loader=ts-node/esm bin/test.ts",
+    "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts",
     "format": "prettier --write .",
-    "prepublishOnly": "npm run build",
-    "index:commands": "adonis-kit index build/commands"
+    "prepublishOnly": "npm run build"
   },
   "devDependencies": {
     "@adonisjs/core": "^6.1.5-4",
-    "@adonisjs/eslint-config": "^1.1.2",
-    "@adonisjs/prettier-config": "^1.1.2",
-    "@adonisjs/tsconfig": "^1.1.2",
-    "@japa/assert": "^1.4.1",
-    "@japa/file-system": "^1.1.0",
-    "@japa/run-failed-tests": "^1.1.1",
-    "@japa/runner": "^2.5.1",
-    "@japa/spec-reporter": "^1.3.3",
-    "@swc/core": "^1.3.66",
-    "@types/node": "^20.3.1",
+    "@adonisjs/eslint-config": "^1.1.7",
+    "@adonisjs/prettier-config": "^1.1.7",
+    "@adonisjs/tsconfig": "^1.1.7",
+    "@japa/assert": "^2.0.0-1",
+    "@japa/file-system": "^2.0.0-1",
+    "@japa/runner": "^3.0.0-2",
+    "@swc/core": "^1.3.67",
+    "@types/node": "^20.3.3",
     "c8": "^8.0.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.0.0",
-    "eslint": "^8.43.0",
+    "eslint": "^8.44.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
-    "np": "^7.6.1",
+    "np": "^8.0.4",
     "prettier": "^2.8.8",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.3"
   },
   "dependencies": {
     "@poppinss/colors": "4.1.0-2",
-    "emphasize": "^6.0.0",
-    "pretty-repl": "^4.0.0",
     "string-width": "^6.1.0"
   },
-  "peerDependencies": {
-    "@adonisjs/core": "^6.1.5-4",
-    "ts-node": "^10.4.0"
-  },
-  "peerDependenciesMeta": {
-    "@adonisjs/core": {
-      "optional": true
-    },
-    "ts-node": {
-      "optional": true
-    }
-  },
   "author": "virk,julien-r44,adonisjs",
   "license": "MIT",
   "homepage": "https://github.com/adonisjs/repl#readme",
@@ -109,7 +73,7 @@
     "node-repl"
   ],
   "eslintConfig": {
-    "extends": "@adonisjs/eslint-config/typescript-package"
+    "extends": "@adonisjs/eslint-config/package"
   },
   "prettier": "@adonisjs/prettier-config",
   "commitlint": {

package/build/commands/adonis_repl.d.ts

@@ -1,9 +0,0 @@
-import { BaseCommand } from '@adonisjs/core/ace';
-import { CommandOptions } from '@adonisjs/core/types/ace';
-export default class ReplCommand extends BaseCommand {
-    static commandName: string;
-    static description: string;
-    static options: CommandOptions;
-    run(): Promise<void>;
-}
-//# sourceMappingURL=adonis_repl.d.ts.map

package/build/commands/adonis_repl.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"adonis_repl.d.ts","sourceRoot":"","sources":["../../commands/adonis_repl.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAEzD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,WAAW,SAAS;IAC3B,MAAM,CAAC,WAAW,SAA6B;IAE/C,MAAM,CAAC,OAAO,EAAE,cAAc,CAG7B;IAEK,GAAG;CAgBV"}

package/build/commands/adonis_repl.js

@@ -1,17 +0,0 @@
-import { BaseCommand } from '@adonisjs/core/ace';
-export default class ReplCommand extends BaseCommand {
-    static commandName = 'repl';
-    static description = 'Start a new REPL session';
-    static options = {
-        startApp: true,
-        staysAlive: true,
-    };
-    async run() {
-        this.app.container.resolving('router', (router) => router.commit());
-        const repl = await this.app.container.make('repl');
-        repl.start();
-        repl.server.on('exit', async () => {
-            await this.app.terminate();
-        });
-    }
-}

package/build/commands/commands.json

@@ -1 +0,0 @@
-{"commands":[{"commandName":"repl","description":"Start a new REPL session","help":"","namespace":null,"aliases":[],"flags":[],"args":[],"options":{"startApp":true,"staysAlive":true},"filePath":"adonis_repl.js"}],"version":1}

package/build/commands/main.js

@@ -1,36 +0,0 @@
-import { readFile } from 'node:fs/promises'
-
-/**
- * In-memory cache of commands after they have been loaded
- */
-let commandsMetaData
-
-/**
- * Reads the commands from the "./commands.json" file. Since, the commands.json
- * file is generated automatically, we do not have to validate its contents
- */
-export async function getMetaData() {
-  if (commandsMetaData) {
-    return commandsMetaData
-  }
-
-  const commandsIndex = await readFile(new URL('./commands.json', import.meta.url), 'utf-8')
-  commandsMetaData = JSON.parse(commandsIndex).commands
-
-  return commandsMetaData
-}
-
-/**
- * Imports the command by lookingup its path from the commands
- * metadata
- */
-export async function getCommand(metaData) {
-  const commands = await getMetaData()
-  const command = commands.find(({ commandName }) => metaData.commandName === commandName)
-  if (!command) {
-    return null
-  }
-
-  const { default: commandConstructor } = await import(new URL(command.filePath, import.meta.url).href)
-  return commandConstructor
-}

package/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AASA,OAAO,yBAAyB,CAAA;AAEhC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA"}

package/build/providers/repl_provider.d.ts

@@ -1,8 +0,0 @@
-import { ApplicationService } from '@adonisjs/core/types';
-export default class ReplProvider {
-    #private;
-    protected app: ApplicationService;
-    constructor(app: ApplicationService);
-    register(): void;
-}
-//# sourceMappingURL=repl_provider.d.ts.map

package/build/providers/repl_provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"repl_provider.d.ts","sourceRoot":"","sources":["../../providers/repl_provider.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAKzD,MAAM,CAAC,OAAO,OAAO,YAAY;;IACnB,SAAS,CAAC,GAAG,EAAE,kBAAkB;gBAAvB,GAAG,EAAE,kBAAkB;IAwB7C,QAAQ;CAmBT"}

package/build/providers/repl_provider.js

@@ -1,40 +0,0 @@
-import { join } from 'node:path';
-import { homedir } from 'node:os';
-import { isModuleInstalled } from '../src/utils.js';
-import { fileURLToPath } from 'node:url';
-import { defineReplBindings } from '../src/adonis_bindings.js';
-export default class ReplProvider {
-    app;
-    constructor(app) {
-        this.app = app;
-    }
-    async #createCompiler() {
-        const { create } = await import('ts-node');
-        const tsConfigPath = new URL('./tsconfig.json', this.app.appRoot);
-        const tsNode = create({
-            project: fileURLToPath(tsConfigPath),
-            compilerOptions: { module: 'ESNext' },
-        });
-        return {
-            supportsTypescript: true,
-            compile(code, fileName) {
-                return tsNode.compile(code, fileName);
-            },
-        };
-    }
-    register() {
-        this.app.container.singleton('repl', async () => {
-            const { Repl } = await import('../src/repl.js');
-            let compiler;
-            if (isModuleInstalled('ts-node')) {
-                compiler = await this.#createCompiler();
-            }
-            const repl = new Repl({
-                compiler,
-                historyFilePath: join(homedir(), '.adonis_repl_history'),
-            });
-            defineReplBindings(this.app, repl);
-            return repl;
-        });
-    }
-}

package/build/src/adonis_bindings.d.ts

@@ -1,4 +0,0 @@
-import { ApplicationService } from '@adonisjs/core/types';
-import { Repl } from './repl.js';
-export declare function defineReplBindings(application: ApplicationService, replService: Repl): void;
-//# sourceMappingURL=adonis_bindings.d.ts.map

package/build/src/adonis_bindings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"adonis_bindings.d.ts","sourceRoot":"","sources":["../../src/adonis_bindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAShC,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,IAAI,QAoDpF"}

package/build/src/adonis_bindings.js

@@ -1,26 +0,0 @@
-function setupReplState(repl, key, value) {
-    repl.server.context[key] = value;
-    repl.notify(`Loaded ${key} module. You can access it using the "${repl.colors.underline(key)}" variable`);
-}
-export function defineReplBindings(application, replService) {
-    replService.addMethod('loadEncryption', async (repl) => {
-        setupReplState(repl, 'encryption', await application.container.make('encryption'));
-    }, {
-        description: 'Load encryption provider and save reference to the "encryption" variable',
-    });
-    replService.addMethod('loadHash', async (repl) => {
-        setupReplState(repl, 'hash', await application.container.make('hash'));
-    }, {
-        description: 'Load hash provider and save reference to the "hash" variable',
-    });
-    replService.addMethod('loadRouter', async (repl) => {
-        setupReplState(repl, 'router', await application.container.make('router'));
-    }, {
-        description: 'Load router and save reference to the "router" variable',
-    });
-    replService.addMethod('loadConfig', async (repl) => {
-        setupReplState(repl, 'config', await application.container.make('config'));
-    }, {
-        description: 'Load config and save reference to the "config" variable',
-    });
-}

package/build/src/colorizer.d.ts

@@ -1,5 +0,0 @@
-export declare function colorizer(): {
-    (s: string): string;
-    colorizeMatchingBracket(s: string): string;
-};
-//# sourceMappingURL=colorizer.d.ts.map

package/build/src/colorizer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"colorizer.d.ts","sourceRoot":"","sources":["../../src/colorizer.ts"],"names":[],"mappings":"AAqDA,wBAAgB,SAAS;QAID,MAAM;+BACY,MAAM;EAG/C"}