@inquirer/editor TS migration (#1137)

* feat: @inquirer/editor migrated to TS * docs: Added default param to editor README * Keep MD table consistent In case other systems aren't using the same parser as GH which could lead to a broken table layout. Co-authored-by: Simon Boudrias <admin@simonboudrias.com>
SBoudrias · Jul 12, 2022 · cd3dc72 · cd3dc72
1 parent 6b76a9e
commit cd3dc72
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 7 deletions.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -25,6 +25,7 @@ const answer = await editor({
 | Property | Type      | Required | Description                    |
 | -------- | --------- | -------- | ------------------------------ |
 | message  | `string`  | yes      | The question to ask            |
+| default  | `string`  | no       | Default value which will automatically be present in the editor |
 | validate    | `string => boolean \| string \| Promise<string \| boolean>` | no       | On submit, validate the content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
 | postfix  | `string`  | no (default to `.txt`) | The postfix of the file being edited. Adding this will add color highlighting to the file content in most editors. |
 

diff --git a/packages/editor/demo.js → packages/editor/demo.ts b/packages/editor/demo.js → packages/editor/demo.ts
@@ -1,4 +1,4 @@
-import editor from './index.js';
+import editor from './src/index.js';
 
 (async () => {
   const answer = await editor({

diff --git a/packages/editor/package.json b/packages/editor/package.json
@@ -3,7 +3,11 @@
   "type": "module",
   "version": "0.0.14-alpha.0",
   "description": "Inquirer multiline editor prompt",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
   "repository": "SBoudrias/Inquirer.js",
   "keywords": [
     "cli",
@@ -19,6 +23,9 @@
     "chalk": "^5.0.1",
     "external-editor": "^3.0.3"
   },
+  "scripts": {
+    "tsc": "tsc"
+  },
   "publishConfig": {
     "access": "public"
   }

diff --git a/packages/editor/index.js → packages/editor/src/index.ts b/packages/editor/index.js → packages/editor/src/index.ts
@@ -6,12 +6,18 @@ import {
   useKeypress,
   usePrefix,
   isEnterKey,
+  AsyncPromptConfig,
 } from '@inquirer/core';
 
-export default createPrompt((config, done) => {
-  const [status, setStatus] = useState('pending');
-  const [value, setValue] = useState(config.default || '');
-  const [errorMsg, setError] = useState();
+type EditorConfig = AsyncPromptConfig & {
+  default?: string;
+  postfix?: string;
+};
+
+export default createPrompt<string, EditorConfig>((config, done) => {
+  const [status, setStatus] = useState<string>('pending');
+  const [value, setValue] = useState<string>(config.default || '');
+  const [errorMsg, setError] = useState<string | undefined>(undefined);
 
   useKeypress(async (key, rl) => {
     // Ignore keypress while our prompt is doing other processing.
@@ -26,7 +32,7 @@ export default createPrompt((config, done) => {
         async (error, answer) => {
           rl.resume();
           if (error) {
-            setError(error);
+            setError(error.toString());
           } else {
             setStatus('loading');
             const isValid = await config.validate(answer);

diff --git a/packages/editor/tsconfig.json b/packages/editor/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}