@adonisjs/repl 4.0.0-3 → 4.0.0-5

package/LICENSE.md

@@ -1,9 +1,9 @@
-# The MIT License
-
-Copyright 2022 Harminder Virk, contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# The MIT License
+
+Copyright 2022 Harminder Virk, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/build/src/repl.d.ts

@@ -1,7 +1,7 @@
 /// <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.js';
+import type { MethodCallback, MethodOptions, Compiler } from './types.js';
 export declare class Repl {
     #private;
     /**
@@ -21,10 +21,6 @@ export declare class Repl {
      * 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
      */
@@ -32,5 +28,25 @@ export declare class Repl {
     /**
      * Register a custom loader function to be added to the context
      */
-    addMethod(name: string, handler: Handler, options?: ContextOptions): this;
+    addMethod(name: string, handler: MethodCallback, options?: MethodOptions): this;
+    /**
+     * Returns the collection of registered methods
+     */
+    getMethods(): {
+        [name: string]: {
+            handler: MethodCallback;
+            options: MethodOptions & {
+                width: number;
+            };
+        };
+    };
+    /**
+     * Register a compiler. Make sure register the compiler before
+     * calling the start method
+     */
+    useCompiler(compiler: Compiler): this;
+    /**
+     * Start the REPL server
+     */
+    start(): this;
 }

package/build/src/repl.js

@@ -6,10 +6,10 @@
  * 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, start as startRepl } from 'node:repl';
 import stringWidth from 'string-width';
+import useColors from '@poppinss/colors';
 import { inspect, promisify as utilPromisify } from 'node:util';
+import { Recoverable, start as startRepl } from 'node:repl';
 /**
  * List of node global properties to remove from the
  * ls inspect
@@ -61,9 +61,6 @@ const TS_UTILS_HELPERS = [
     '__classPrivateFieldSet',
     '__classPrivateFieldIn',
 ];
-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
@@ -75,12 +72,16 @@ export class Repl {
      * Since we are monkey patching it, we need a reference to it
      * to call it after our custom logic
      */
-    #originalEval = null;
+    #originalEval;
     /**
      * Compiler that will transform the user input just
      * before evaluation
      */
     #compiler;
+    /**
+     * Path to the history file
+     */
+    #historyFilePath;
     /**
      * Set of registered ready callbacks
      */
@@ -89,10 +90,6 @@ export class Repl {
      * A set of registered custom methods
      */
     #customMethods = {};
-    /**
-     * Path to the history file
-     */
-    #historyFilePath;
     /**
      * Colors reference
      */
@@ -107,21 +104,27 @@ export class Repl {
         this.#historyFilePath = options?.historyFilePath;
     }
     /**
-     * Prints the welcome message
+     * Registering custom methods with the server context by wrapping
+     * them inside a function and passes the REPL server instance
+     * to the method
      */
-    #printWelcomeMessage() {
-        console.log('');
+    #registerCustomMethodWithContext(name) {
+        const customMethod = this.#customMethods[name];
+        if (!customMethod) {
+            return;
+        }
         /**
-         * Log about typescript support
+         * Wrap handler
          */
-        if (this.#compiler?.supportsTypescript) {
-            console.log(`${this.colors.green(icons.tick)} ${this.colors.dim('typescript compilation supported')}`);
-            console.log('');
-        }
+        const handler = (...args) => customMethod.handler(this, ...args);
         /**
-         * Log about help command
+         * Re-define the function name to be more description
          */
-        this.notify('Type ".ls" to a view list of available context methods/properties');
+        Object.defineProperty(handler, 'name', { value: customMethod.handler.name });
+        /**
+         * Register with the context
+         */
+        this.server.context[name] = handler;
     }
     /**
      * Setup context with default globals
@@ -154,12 +157,6 @@ export class Repl {
         /**
          * 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);
         });
@@ -173,17 +170,15 @@ export class Repl {
     /**
      * 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.
+     * 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.compile(code, filename)
-                .replace('export { };', '')
-                .replace(/\/\/# sourceMappingURL=(.*)$/, '/** sourceMappingURL=$1 */');
+            const compiled = this.#compiler ? this.#compiler.compile(code, filename) : code;
             return this.#originalEval(compiled, context, filename, callback);
         }
         catch (error) {
@@ -240,28 +235,12 @@ export class Repl {
         console.log(this.colors.green('GLOBAL METHODS:'));
         Object.keys(this.#customMethods).forEach((method) => {
             const { options } = this.#customMethods[method];
-            const spaces = new Array(this.#longestCustomMethodName - options.width + 2).join(' ');
-            console.log(`${this.colors.yellow(options.usage || method)}${spaces}${this.colors.dim(options.description || '')}`);
+            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}`);
         });
     }
-    #registerCustomMethodWithContext(name) {
-        const customMethod = this.#customMethods[name];
-        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
      */
@@ -279,13 +258,52 @@ export class Repl {
             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) };
+        /**
+         * Register method right away when server has been started
+         */
+        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() {
-        this.#printWelcomeMessage();
+        console.log('');
+        this.notify('Type ".ls" to a view list of available context methods/properties');
         this.server = startRepl({
-            prompt: '> ',
+            prompt: `> ${this.#compiler?.supportsTypescript ? '(ts) ' : '(js) '}`,
             input: process.stdin,
             output: process.stdout,
             terminal: process.stdout.isTTY && !Number.parseInt(process.env.NODE_NO_READLINE, 10),
@@ -319,28 +337,4 @@ export class Repl {
         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);
-        }
-        return this;
-    }
 }

package/build/src/types.d.ts

@@ -1,13 +1,12 @@
 import { Repl } from './repl.js';
 /**
- * Custom method handler
+ * Custom method callback function
  */
-export type Handler = (repl: Repl, ...args: any[]) => any;
+export type MethodCallback = (repl: Repl, ...args: any[]) => any;
 /**
- * Options that can be set when defining a loader
- * method
+ * Options that can be set when defining a custom method
  */
-export type ContextOptions = {
+export type MethodOptions = {
     description?: string;
     usage?: string;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/repl",
   "description": "REPL for AdonisJS",
-  "version": "4.0.0-3",
+  "version": "4.0.0-5",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -9,7 +9,6 @@
   "type": "module",
   "files": [
     "build/src",
-    "build/factories",
     "build/index.d.ts",
     "build/index.js"
   ],
@@ -33,12 +32,12 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/core": "^6.1.5-4",
     "@adonisjs/eslint-config": "^1.1.7",
     "@adonisjs/prettier-config": "^1.1.7",
     "@adonisjs/tsconfig": "^1.1.7",
+    "@commitlint/cli": "^17.6.6",
+    "@commitlint/config-conventional": "^17.6.6",
     "@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",
@@ -83,7 +82,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "next"
   },
   "np": {
     "message": "chore(release): %s",