@adonisjs/repl 3.1.11 → 4.0.0-1

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/README.md

@@ -1,216 +1,36 @@
-<div align="center">
-  <h1> AdonisJS REPL </h1>
-  <p>A slick <strong>framework agnostic REPL for Node.js</strong> with first class support for <br /> <code>top level await</code>, <code>typescript compilation</code>, <code>accurate stack traces</code> and a lot more.</p>
-</div>
+# @adonisjs/repl
 
 <br />
 
-<div align="center">
+[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![snyk-image]][snyk-url]
 
-[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]
+## Introduction
+REPL for AdonisJS applications. Syntax highlighting, bracket matching, ESM and TypeScript support out of the box.
 
-</div>
+## Official Documentation
+The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/repl)
 
-<div align="center">
-  <h3>
-    <a href="#installation">
-      Usage
-    </a>
-    <span> | </span>
-    <a href="CONTRIBUTING.md">
-      Contributing
-    </a>
-    <span> | </span>
-    <a href="https://preview.adonisjs.com">
-      Checkout AdonisJS
-    </a>
-  </h3>
-</div>
+## Contributing
+One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
 
-<div align="center">
-  <sub>Built with ❤︎ by <a href="https://github.com/thetutlage">Harminder Virk</a>
-</div>
+We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
 
-<br />
-
-![](./assets/imports_and_await.png)
-
-<hr />
-
-AdonisJS REPL is a standalone and framework agnostic package to create custom Node.js REPL with first class support for:
-
-<p>
-👉 <strong>Execute typescript code with in-memory compilation.</strong>	<br />
-👉 <strong> Support for top level await keyword. </strong><br />
-👉 <strong> Ability to define custom method with a help description. </strong><br />
-</p>
-
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of contents
-
-- [Table of contents](#table-of-contents)
-- [Installation](#installation)
-- [Usage](#usage)
-	- [Typescript support](#typescript-support)
-	- [History file](#history-file)
-- [Accurate Stack Trace](#accurate-stack-trace)
-- [The `.ls` command](#the-ls-command)
-- [Adding custom properties](#adding-custom-properties)
-	- [Global methods](#global-methods)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## Installation
-
-Install the package from the npm registry as follows:
-
-```sh
-npm i @adonisjs/repl
-
-# Yarn
-yarn add @adonisjs/repl
-```
-
-## Usage
-
-Import the `Repl` class from the standalone module.
-
-```ts
-import { Repl } from '@adonisjs/repl/build/standalone'
-const repl = new Repl()
-
-repl.start()
-```
-
-### Typescript support
-
-You will have to make use of [@adonisjs/require-ts](https://npm.im/@adonisjs/require-ts) in order for the REPL to compile and run the typescript code. For example:
-
-```ts
-import { loadCompiler } from '@adonisjs/require-ts'
-import { Repl } from '@adonisjs/repl/build/standalone'
-
-const compilerOptions = {
-  target: 'es2019',
-  module: 'commonjs',
-  allowSyntheticDefaultImports: true,
-  esModuleInterop: true,
-}
-
-const repl = new Repl(loadCompiler(compilerOptions))
-```
-
-If you are using `@adonisjs/require-ts` as a require hook, then there is no need to instantiate another instance of the compiler as you can reference the compiler instance from the global object.
-
-```ts
-const compiler = global[Symbol.for('REQUIRE_TS_COMPILER')]
-const repl = new Repl(compiler)
-```
-
-And now run the file containing the above code as follows:
-
-```ts
-node -r @adonisjs/require-ts/build/register repl.ts
-```
-
-![](./assets/typescript.png)
-
-### History file
-
-AdonisJS REPL allows you store the commands history inside a file so that the subsequent sessions can reference the commands executed in an earlier session.
+## Code of Conduct
+In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).
 
-You need to just pass the path to the history file and rest is taken care for you.
+## License
+AdonisJS Repl is open-sourced software licensed under the [MIT license](LICENSE.md).
 
-```ts
-import { join } from 'path'
-import { homedir } from 'os'
-import { Repl } from '@adonisjs/repl/build/standalone'
-
-const repl = new Repl(compiler, join(homedir(), '.adonis_repl_history'))
-
-repl.start()
-```
-
-![](./assets/history.gif)
-
-## Accurate Stack Trace
-
-The stack trace for the Typescript files points back to the correct file, line and the column number.
-
-![](./assets/stack-trace.png)
-
-## The `.ls` command
-
-The `.ls` command prints the REPL session context. The output is divided to two sections.
-
-![](./assets/ls-command.png)
-
-- **Global Methods** are the methods in the repl context object, but has some description associated with them.
-- **Context properties**: are the properties/methods in the context object. Only the first level of properties are printed on the console (to avoid noisy output).
-
-## Adding custom properties
-
-If you are aware about the [Node.js repl context](https://nodejs.org/dist/latest-v14.x/docs/api/repl.html#repl_global_and_local_scope), then you would know that you can add properties to the context as follows:
-
-```ts
-// NODE.JS EXAMPLE
-const { start } = require('repl')
-
-const server = start({})
-server.context.foo = 'bar'
-```
-
-Similarly, you can add properties to the AdonisJS repl `context` by referencing the underlying `server` property.
-
-```ts
-import { Repl } from '@adonisjs/repl/build/standalone'
-
-const repl = new Repl().start()
-repl.server.context.foo = 'bar'
-```
-
-### Global methods
-
-In addition to adding properties to the `context` directly. You can also define custom methods with a description and its usage text. For example:
-
-```ts
-import { Repl } from '@adonisjs/repl/build/standalone'
-const repl = new Repl()
-
-repl.addMethod(
-  'getUsers',
-  () => {
-    return [
-      { id: 1, name: 'virk' },
-      { id: 2, name: 'romain' },
-    ]
-  },
-  {
-    description: 'Returns a list of users',
-  }
-)
-
-repl.start()
-```
-
-There is no technical advantage for using `addMethod` over adding properties to the `context` directly. It's just that `addMethod` properties are given special treatment during the [.ls command](#ls-command).
-
-Checkout the following example
-
-![](./assets/context-behavior.png)
-
-[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/repl/test?style=for-the-badge
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/repl/test.yml?style=for-the-badge
 [gh-workflow-url]: https://github.com/adonisjs/repl/actions/workflows/test.yml "Github action"
 
-[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
-[typescript-url]: "typescript"
+[npm-image]: https://img.shields.io/npm/v/@adonisjs/repl/latest.svg?style=for-the-badge&logo=npm
+[npm-url]: https://www.npmjs.com/package/@adonisjs/repl/v/latest "npm"
 
-[npm-image]: https://img.shields.io/npm/v/@adonisjs/repl.svg?style=for-the-badge&logo=npm
-[npm-url]: https://npmjs.org/package/@adonisjs/repl 'npm'
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
 
-[license-image]: https://img.shields.io/npm/l/@adonisjs/repl?color=blueviolet&style=for-the-badge
-[license-url]: LICENSE.md 'license'
+[license-url]: LICENSE.md
+[license-image]: https://img.shields.io/github/license/adonisjs/repl?style=for-the-badge
 
-[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/repl?label=Synk%20Vulnerabilities&style=for-the-badge
-[synk-url]: https://snyk.io/test/github/adonisjs/repl?targetFile=package.json "synk"
+[snyk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/repl?label=Snyk%20Vulnerabilities&style=for-the-badge
+[snyk-url]: https://snyk.io/test/github/adonisjs/repl?targetFile=package.json "snyk"

package/build/index.d.ts

@@ -0,0 +1,2 @@
+import './src/types/extended.js';
+export { Repl } from './src/repl.js';

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

@@ -1,8 +1,10 @@
 /*
  * @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/build/src/repl.d.ts

@@ -0,0 +1,36 @@
+/// <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';
+export declare class Repl {
+    #private;
+    /**
+     * 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;
+}