@adonisjs/repl 3.1.11 → 4.0.0-1

package/package.json

@@ -1,103 +1,65 @@
 {
   "name": "@adonisjs/repl",
-  "version": "3.1.11",
   "description": "REPL for AdonisJS",
-  "main": "build/providers/ReplProvider.js",
+  "version": "4.0.0-1",
+  "main": "build/index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "files": [
-    "build/adonis-typings",
-    "build/commands",
-    "build/providers",
     "build/src",
-    "build/standalone.d.ts",
-    "build/standalone.js"
+    "build/factories",
+    "build/index.d.ts",
+    "build/index.js"
   ],
-  "typings": "./build/adonis-typings/index.d.ts",
+  "exports": {
+    ".": "./build/index.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",
+    "typecheck": "tsc --noEmit",
     "compile": "npm run lint && npm run clean && tsc",
     "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 --enable-source-maps --loader=ts-node/esm bin/test.ts",
+    "format": "prettier --write .",
+    "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/core": "^5.8.2",
-    "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/require-ts": "^2.0.12",
-    "@japa/assert": "^1.3.4",
-    "@japa/run-failed-tests": "^1.0.7",
-    "@japa/runner": "^2.0.8",
-    "@japa/spec-reporter": "^1.1.12",
-    "@poppinss/dev-utils": "^2.0.3",
-    "@types/node": "^17.0.35",
-    "commitizen": "^4.2.4",
-    "cz-conventional-changelog": "^3.3.0",
-    "del-cli": "^4.0.1",
-    "doctoc": "^2.2.0",
-    "eslint": "^8.16.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": "^8.0.1",
-    "mrm": "^4.0.0",
-    "np": "^7.6.1",
-    "prettier": "^2.6.2",
-    "typescript": "^4.6.4"
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "node ./node_modules/@adonisjs/mrm-preset/validateCommit/conventional/validate.js"
-    }
-  },
-  "nyc": {
-    "exclude": [
-      "test"
-    ],
-    "extension": [
-      ".ts"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
-  "np": {
-    "contents": ".",
-    "anyBranch": false
-  },
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
+    "@adonisjs/core": "^6.1.5-4",
+    "@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.44.0",
+    "github-label-sync": "^2.3.1",
+    "husky": "^8.0.3",
+    "np": "^8.0.4",
+    "prettier": "^2.8.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.3"
   },
   "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"
+    "@poppinss/colors": "4.1.0-2",
+    "string-width": "^6.1.0"
   },
+  "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 +67,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/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/build/adonis-typings/container.d.ts

@@ -1,6 +0,0 @@
-declare module '@ioc:Adonis/Core/Application' {
-    import { ReplContract } from '@ioc:Adonis/Addons/Repl';
-    interface ContainerBindings {
-        'Adonis/Addons/Repl': ReplContract;
-    }
-}

package/build/adonis-typings/index.d.ts

@@ -1,2 +0,0 @@
-/// <reference path="container.d.ts" />
-/// <reference path="repl.d.ts" />

package/build/adonis-typings/index.js

@@ -1,10 +0,0 @@
-/*
- * @adonisjs/repl
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference path="./container.ts" />
-/// <reference path="./repl.ts" />

package/build/adonis-typings/repl.d.ts

@@ -1,46 +0,0 @@
-/// <reference types="node" />
-declare module '@ioc:Adonis/Addons/Repl' {
-    import { REPLServer } from 'repl';
-    import { getBest } from '@poppinss/colors';
-    /**
-     * Custom method callback
-     */
-    export type Handler = (repl: ReplContract, ...args: any[]) => any;
-    /**
-     * Options that can be set when defining a loader
-     * method
-     */
-    export type ContextOptions = {
-        description?: string;
-        usage?: string;
-    };
-    /**
-     * Shape of the REPL class
-     */
-    export interface ReplContract {
-        colors: ReturnType<typeof getBest>;
-        /**
-         * Reference to the REPL server
-         */
-        server: REPLServer;
-        /**
-         * Start the repl
-         */
-        start(): this;
-        /**
-         * Notify by writing message to the console
-         * and resuming the prompt
-         */
-        notify(message: string): void;
-        /**
-         * Add a method. Loader methods works as a shortcut for
-         */
-        addMethod(name: string, handler: Handler, options?: ContextOptions): this;
-        /**
-         * Register a callback to be invoked once the server is ready
-         */
-        ready(callback: (repl: ReplContract) => void): this;
-    }
-    const Repl: ReplContract;
-    export default Repl;
-}

package/build/commands/AdonisRepl.d.ts

@@ -1,11 +0,0 @@
-import { BaseCommand } from '@adonisjs/core/build/standalone';
-export default class ReplCommand extends BaseCommand {
-    static commandName: string;
-    static description: string;
-    static settings: {
-        loadApp: boolean;
-        environment: "repl";
-        stayAlive: boolean;
-    };
-    run(): Promise<void>;
-}

package/build/commands/AdonisRepl.js

@@ -1,33 +0,0 @@
-"use strict";
-/*
- * @adonisjs/repl
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const standalone_1 = require("@adonisjs/core/build/standalone");
-class ReplCommand extends standalone_1.BaseCommand {
-    async run() {
-        this.application.container.withBindings(['Adonis/Core/Route'], (Route) => {
-            Route.commit();
-        });
-        this.application.container.use('Adonis/Addons/Repl').start();
-        /**
-         * Gracefully shutdown the application
-         */
-        this.application.container.use('Adonis/Addons/Repl').server.on('exit', async () => {
-            await this.application.shutdown();
-        });
-    }
-}
-exports.default = ReplCommand;
-ReplCommand.commandName = 'repl';
-ReplCommand.description = 'Start a new REPL session';
-ReplCommand.settings = {
-    loadApp: true,
-    environment: 'repl',
-    stayAlive: true,
-};

package/build/commands/index.d.ts

@@ -1,2 +0,0 @@
-declare const _default: string[];
-export default _default;

package/build/commands/index.js

@@ -1,11 +0,0 @@
-"use strict";
-/*
- * @adonisjs/repl
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = ['@adonisjs/repl/build/commands/AdonisRepl'];

package/build/providers/ReplProvider.d.ts

@@ -1,7 +0,0 @@
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-export default class ReplProvider {
-    protected app: ApplicationContract;
-    constructor(app: ApplicationContract);
-    static needsApplication: boolean;
-    register(): void;
-}

package/build/providers/ReplProvider.js

@@ -1,26 +0,0 @@
-"use strict";
-/*
- * @adonisjs/repl
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const os_1 = require("os");
-class ReplProvider {
-    constructor(app) {
-        this.app = app;
-    }
-    register() {
-        this.app.container.singleton('Adonis/Addons/Repl', () => {
-            const compiler = global[Symbol.for('REQUIRE_TS_COMPILER')];
-            const { Repl } = require('../src/Repl');
-            return new Repl(compiler, (0, path_1.join)((0, os_1.homedir)(), '.adonis_repl_history'));
-        });
-    }
-}
-exports.default = ReplProvider;
-ReplProvider.needsApplication = true;

package/build/src/Compiler/index.d.ts

@@ -1,29 +0,0 @@
-import { Compiler as TsCompiler } from '@adonisjs/require-ts/build/src/Compiler';
-/**
- * Exposes the API to compile the user land code to be executed
- * inside Node.JS REPL.
- */
-export declare class Compiler {
-    private tsCompiler?;
-    compilesTs: boolean;
-    constructor(tsCompiler?: TsCompiler | undefined);
-    /**
-     * Process the await keywords in the code
-     */
-    private processAwait;
-    /**
-     * Compiles code using typescript
-     */
-    private compileTypescript;
-    /**
-     * Compiles the code to be executed in the Node.js REPL. Under
-     * the hood
-     *
-     * - Typescript code is compiled
-     * - Await keywords are wrapped in async IIFE
-     */
-    compile(statement: string, filename: string): Promise<{
-        compiled: string;
-        awaitPromise: boolean;
-    }>;
-}

package/build/src/Compiler/index.js

@@ -1,68 +0,0 @@
-"use strict";
-/*
- * @adonisjs/repl
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Compiler = void 0;
-const node_repl_await_1 = require("node-repl-await");
-const ImportsParser_1 = require("../ImportsParser");
-/**
- * Exposes the API to compile the user land code to be executed
- * inside Node.JS REPL.
- */
-class Compiler {
-    constructor(tsCompiler) {
-        this.tsCompiler = tsCompiler;
-        this.compilesTs = !!this.tsCompiler;
-    }
-    /**
-     * Process the await keywords in the code
-     */
-    processAwait(statement) {
-        const potentialWrappedCode = (0, node_repl_await_1.processTopLevelAwait)(statement);
-        if (!potentialWrappedCode) {
-            return { compiled: statement, awaitPromise: false };
-        }
-        return { compiled: potentialWrappedCode, awaitPromise: true };
-    }
-    /**
-     * Compiles code using typescript
-     */
-    async compileTypescript(statement, filename) {
-        const lines = statement.split(/\n|\r\n/);
-        let compiledOutput = statement;
-        /**
-         * In case of a single line, we process the import
-         * keywords and define local variables to hold
-         * the import reference
-         */
-        if (lines.length <= 2) {
-            compiledOutput = await new ImportsParser_1.ImportsParser().parse(statement);
-        }
-        /**
-         * Compile using typescript compiler and patch the
-         * `sourceMappingUrl` comment to be a block level comment.
-         */
-        compiledOutput = this.tsCompiler.compile(filename, compiledOutput, true);
-        return `${compiledOutput.replace('//# sourceMappingURL=', '/**# sourceMappingURL=')} */`;
-    }
-    /**
-     * Compiles the code to be executed in the Node.js REPL. Under
-     * the hood
-     *
-     * - Typescript code is compiled
-     * - Await keywords are wrapped in async IIFE
-     */
-    async compile(statement, filename) {
-        if (this.tsCompiler) {
-            statement = await this.compileTypescript(statement, filename);
-        }
-        return this.processAwait(statement);
-    }
-}
-exports.Compiler = Compiler;

package/build/src/ImportsParser/index.d.ts

@@ -1,51 +0,0 @@
-/**
- * This is a crazy attempt to hack around the Typescript behavior around un-used
- * imports. Writing half baked parsers is something I want to avoid everytime.
- * However, there isn't any other way (atleast I don't know about it).
- *
- * In REPL, you usually write one line of code at a time. For example:
- * - You write 2 + 2 and then press enter. The REPL prints 4
- * - You write `await Database.query().first()` and it prints the query result.
- *
- * However, when you write `import User from 'App/Models/User'` and expect to
- * access User variable then you are out of luck.
- *
- * - The import statement will go to the typescript compiler
- * - It will compile the code and sees that no one is using this import.
- *   And hence it will just remove it from the compiled output.
- *
- * Bang! No import/require exists and hence no `User` variable exists.
- *
- * To hack around it, we need to monitor and parse import statements and hold
- * a reference to them so that the compiler doesn't remove. For example:
- *
- * Converting
- * ```ts
- * 	import User from 'App/Models/User'
- * ```
- *
- * To
- * ```ts
- * 	import repl_User from 'App/Models/User'; var User = repl_User
- * ```
- *
- * Now you can access the `User` variable.
- *
- * The tough part is attempting to parse all styles in which an import
- * statement can be written. Lucikly, there are 4 different ways to
- * do that as per the spec http://www.ecma-international.org/ecma-262/6.0/#table-40
- *
- * 		import v from "mod";									(Import default)
- * 		import * as ns from "mod";						(Import alias)
- * 		import {x} from "mod";								(Import named)
- * 		import {x as v} from "mod";						(Import named + aliases)
- *
- * However, we have to be tolerant to the white spaces.
- */
-export declare class ImportsParser {
-    private parseImport;
-    /**
-     * Parse a given line of code
-     */
-    parse(line: string): Promise<string>;
-}