@adonisjs/repl 3.1.10 → 4.0.0-0

package/build/src/repl.js

@@ -0,0 +1,214 @@
+import useColors from '@poppinss/colors';
+import { Recoverable } from 'node:repl';
+import prettyRepl from 'pretty-repl';
+import stringWidth from 'string-width';
+import { inspect, promisify as utilPromisify } from 'node:util';
+import { colorizer } from './colorizer.js';
+const GLOBAL_NODE_PROPERTIES = [
+    'performance',
+    'global',
+    'clearInterval',
+    'clearTimeout',
+    'setInterval',
+    'setTimeout',
+    'queueMicrotask',
+    'clearImmediate',
+    'setImmediate',
+    'structuredClone',
+    'atob',
+    'btoa',
+    'fetch',
+    'crypto',
+];
+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',
+];
+const icons = process.platform === 'win32' && !process.env.WT_SESSION
+    ? { tick: '√', pointer: '>' }
+    : { tick: '✔', pointer: '❯' };
+export class Repl {
+    #longestCustomMethodName = 0;
+    #originalEval = null;
+    colors = useColors.ansi();
+    server;
+    #compiler;
+    #onReadyCallbacks = [];
+    #customMethods = {};
+    #historyFilePath;
+    constructor(options) {
+        this.#compiler = options?.compiler;
+        this.#historyFilePath = options?.historyFilePath;
+    }
+    #printWelcomeMessage() {
+        console.log('');
+        if (this.#compiler?.supportsTypescript) {
+            console.log(`${this.colors.green(icons.tick)} ${this.colors.dim('typescript compilation supported')}`);
+            console.log('');
+        }
+        this.notify('Type ".ls" to a view list of available context methods/properties');
+    }
+    #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)')}`,
+        });
+        this.#registerCustomMethodsWithContext();
+    }
+    #registerCustomMethodsWithContext() {
+        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.compile(code, filename)
+                .replace('export { };', '')
+                .replace(/\/\/# sourceMappingURL=(.*)$/, '/** sourceMappingURL=$1 */');
+            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 spaces = new Array(this.#longestCustomMethodName - options.width + 2).join(' ');
+            console.log(`${this.colors.yellow(options.usage || method)}${spaces}${this.colors.dim(options.description || '')}`);
+        });
+    }
+    #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;
+    }
+    #ls() {
+        this.#printCustomMethodsHelp();
+        this.#printContextHelp();
+        this.server.displayPrompt();
+    }
+    notify(message) {
+        console.log(this.colors.yellow().italic(message));
+        if (this.server) {
+            this.server.displayPrompt();
+        }
+    }
+    start() {
+        this.#printWelcomeMessage();
+        this.server = prettyRepl.start({
+            prompt: '> ',
+            input: process.stdin,
+            output: process.stdout,
+            terminal: process.stdout.isTTY && !Number.parseInt(process.env.NODE_NO_READLINE, 10),
+            useGlobal: true,
+            colorize: colorizer(),
+        });
+        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;
+    }
+    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;
+    }
+}

package/build/src/types/extended.d.ts

@@ -0,0 +1,7 @@
+import { Repl } from '../repl.js';
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        repl: Repl;
+    }
+}
+//# sourceMappingURL=extended.d.ts.map

package/build/src/types/extended.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extended.d.ts","sourceRoot":"","sources":["../../../src/types/extended.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAEjC,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAiB,iBAAiB;QAChC,IAAI,EAAE,IAAI,CAAA;KACX;CACF"}

package/build/src/types/extended.js

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

package/build/src/types/main.d.ts

@@ -0,0 +1,11 @@
+import { Repl } from '../repl.js';
+export type Handler = (repl: Repl, ...args: any[]) => any;
+export type ContextOptions = {
+    description?: string;
+    usage?: string;
+};
+export type Compiler = {
+    compile: (code: string, fileName: string) => string;
+    supportsTypescript: boolean;
+};
+//# sourceMappingURL=main.d.ts.map

package/build/src/types/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/types/main.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAKjC,MAAM,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;AAMzD,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAMD,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;IACnD,kBAAkB,EAAE,OAAO,CAAA;CAC5B,CAAA"}

package/build/src/types/main.js

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

package/build/src/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function isModuleInstalled(moduleName: string): boolean;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAKA,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,WAQnD"}

package/build/src/utils.js

@@ -0,0 +1,11 @@
+import { createRequire } from 'node:module';
+export function isModuleInstalled(moduleName) {
+    const require = createRequire(import.meta.url);
+    try {
+        require.resolve(moduleName);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}

package/commands/adonis_repl.ts

@@ -0,0 +1,38 @@
+/*
+ * @adonisjs/repl
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { BaseCommand } from '@adonisjs/core/ace'
+import { CommandOptions } from '@adonisjs/core/types/ace'
+
+export default class ReplCommand extends BaseCommand {
+  static commandName = 'repl'
+  static description = 'Start a new REPL session'
+
+  static options: CommandOptions = {
+    startApp: true,
+    staysAlive: true,
+  }
+
+  async run() {
+    this.app.container.resolving('router', (router) => router.commit())
+
+    /**
+     * Start the repl
+     */
+    const repl = await this.app.container.make('repl')
+    repl.start()
+
+    /**
+     * Gracefully shutdown the app
+     */
+    repl.server!.on('exit', async () => {
+      await this.app.terminate()
+    })
+  }
+}

package/{build/adonis-typings/repl.js → index.ts}

@@ -1,8 +1,12 @@
 /*
  * @adonisjs/repl
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (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/package.json

@@ -1,103 +1,101 @@
 {
   "name": "@adonisjs/repl",
-  "version": "3.1.10",
   "description": "REPL for AdonisJS",
-  "main": "build/providers/ReplProvider.js",
+  "version": "4.0.0-0",
+  "main": "build/index.js",
+  "type": "module",
   "files": [
-    "build/adonis-typings",
-    "build/commands",
-    "build/providers",
+    "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/standalone.d.ts",
-    "build/standalone.js"
+    "build/services",
+    "build/providers",
+    "build/commands",
+    "build/factories",
+    "build/stubs",
+    "build/index.d.ts",
+    "build/index.d.ts.map",
+    "build/index.js"
   ],
-  "typings": "./build/adonis-typings/index.d.ts",
+  "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": {
-    "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "node -r @adonisjs/require-ts/build/register ./bin/test.ts",
+    "test": "c8 npm run quick:test",
+    "lint": "eslint . --ext=.ts",
     "clean": "del-cli build",
-    "compile": "npm run lint && npm run clean && tsc",
+    "compile": "npm run lint && npm run clean && tsc && npm run copy:templates && npm run index:commands",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
     "build": "npm run compile",
-    "prepublishOnly": "npm run build",
-    "lint": "eslint . --ext=.ts",
-    "format": "prettier --write .",
-    "commit": "git-cz",
     "release": "np --message=\"chore(release): %s\"",
     "version": "npm run build",
-    "sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/repl"
-  },
-  "keywords": [
-    "adonisjs",
-    "repl",
-    "node-repl"
-  ],
-  "author": "virk,adonisjs",
-  "license": "MIT",
-  "peerDependencies": {
-    "@adonisjs/core": "^5.1.0"
+    "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/repl",
+    "quick:test": "node --loader=ts-node/esm bin/test.ts",
+    "format": "prettier --write .",
+    "prepublishOnly": "npm run build",
+    "index:commands": "adonis-kit index build/commands"
   },
   "devDependencies": {
-    "@adonisjs/core": "^5.6.2",
-    "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/require-ts": "^2.0.11",
-    "@japa/assert": "^1.3.3",
-    "@japa/run-failed-tests": "^1.0.7",
-    "@japa/runner": "^2.0.6",
-    "@japa/spec-reporter": "^1.1.12",
-    "@poppinss/dev-utils": "^2.0.3",
-    "@types/node": "^17.0.23",
-    "commitizen": "^4.2.4",
-    "cz-conventional-changelog": "^3.3.0",
-    "del-cli": "^4.0.1",
-    "doctoc": "^2.1.0",
-    "eslint": "^8.12.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-adonis": "^2.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "github-label-sync": "^2.2.0",
-    "husky": "^7.0.4",
-    "mrm": "^4.0.0",
+    "@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",
+    "c8": "^8.0.0",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.43.0",
+    "github-label-sync": "^2.3.1",
+    "husky": "^8.0.3",
     "np": "^7.6.1",
-    "prettier": "^2.6.2",
-    "typescript": "^4.6.3"
+    "prettier": "^2.8.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.3"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "node ./node_modules/@adonisjs/mrm-preset/validateCommit/conventional/validate.js"
-    }
+  "dependencies": {
+    "@poppinss/colors": "4.1.0-2",
+    "emphasize": "^6.0.0",
+    "pretty-repl": "^4.0.0",
+    "string-width": "^6.1.0"
   },
-  "nyc": {
-    "exclude": [
-      "test"
-    ],
-    "extension": [
-      ".ts"
-    ]
+  "peerDependencies": {
+    "@adonisjs/core": "^6.1.5-4",
+    "ts-node": "^10.4.0"
   },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
+  "peerDependenciesMeta": {
+    "@adonisjs/core": {
+      "optional": true
+    },
+    "ts-node": {
+      "optional": true
     }
   },
-  "np": {
-    "contents": ".",
-    "anyBranch": false
-  },
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
-  },
-  "dependencies": {
-    "@poppinss/colors": "^3.0.2",
-    "node-repl-await": "^0.1.2",
-    "parse-imports": "0.0.5",
-    "string-width": "^4.2.2"
-  },
-  "directories": {
-    "example": "example",
-    "test": "test"
-  },
+  "author": "virk,julien-r44,adonisjs",
+  "license": "MIT",
+  "homepage": "https://github.com/adonisjs/repl#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/adonisjs/repl.git"
@@ -105,57 +103,37 @@
   "bugs": {
     "url": "https://github.com/adonisjs/repl/issues"
   },
-  "homepage": "https://github.com/adonisjs/repl#readme",
-  "adonisjs": {
-    "aceProviders": [
-      "@adonisjs/repl"
-    ],
-    "commands": [
-      "@adonisjs/repl/build/commands"
-    ],
-    "types": "@adonisjs/repl"
-  },
-  "mrmConfig": {
-    "core": true,
-    "license": "MIT",
-    "services": [
-      "github-actions"
-    ],
-    "minNodeVersion": "14.15.4",
-    "probotApps": [
-      "stale",
-      "lock"
-    ],
-    "runGhActionsOnWindows": true
-  },
+  "keywords": [
+    "adonisjs",
+    "repl",
+    "node-repl"
+  ],
   "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/typescript-package"
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "commitlint": {
     "extends": [
-      "plugin:adonis/typescriptPackage",
-      "prettier"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "endOfLine": "auto"
-        }
-      ]
-    }
+      "@commitlint/config-conventional"
+    ]
   },
-  "eslintIgnore": [
-    "build"
-  ],
-  "prettier": {
-    "trailingComma": "es5",
-    "semi": false,
-    "singleQuote": true,
-    "useTabs": false,
-    "quoteProps": "consistent",
-    "bracketSpacing": true,
-    "arrowParens": "always",
-    "printWidth": 100
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "next",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
   }
 }

package/providers/repl_provider.ts

@@ -0,0 +1,61 @@
+/*
+ * @adonisjs/repl
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { join } from 'node:path'
+import { homedir } from 'node:os'
+import { ApplicationService } from '@adonisjs/core/types'
+import { isModuleInstalled } from '../src/utils.js'
+import { fileURLToPath } from 'node:url'
+import { defineReplBindings } from '../src/adonis_bindings.js'
+
+export default class ReplProvider {
+  constructor(protected app: ApplicationService) {}
+
+  /**
+   * Create the typescript compiler to be used for compiling
+   * the user code inside the REPL
+   */
+  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: string, fileName: string) {
+        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
+    })
+  }
+}