Update TypeScript types, check types against JavaScript tests/examples #307

bitjson · 2020-08-04T23:00:58Z

Still a work in progress – I'm just trying to get @unional's fantastic work on #261 over the finish line.

This PR builds on #261 – I've removed the duplicated set of tests (which were being used to develop the types), and instead I'm checking the rest of the repo (guide, examples, lib, recipes, test) with the new types. I also reverted some formatting changes to keep this PR as thin as possible.

There are ~500 TS issues remaining (many of which were already marked as TODO by @unional), but once these issues are fixed, the types should be very complete, and much easier to maintain (npm test now validates them). If you're interested in helping, please send PRs to this branch, and I'll merge them to add them to this PR.

Closes #82
Closes #135
Closes #202
Closes #204
Closes #212
Closes #252
Closes #258
Closes #261
Closes #262
Closes #263
Closes #286

Converted some support functions to TypeScript

input, confirm, numberal, password, invisible, toggle, basicauth

bitjson · 2020-08-07T18:55:16Z

Ok, I cleaned up a few more issues – there are still places we need to improve, but I think we're in a good spot to make smaller, iterative changes now. (Especially now that we're testing against the actual JS examples.)

@jonschlinkert would you be willing to merge these TypeScript changes? Is there anything else you'd like me change?

bitjson · 2020-08-07T19:01:15Z

.travis.yml

@@ -9,3 +9,5 @@ node_js:
  - '11'
  - '10'
  - '8'
+before_script:
+  - cd examples && npm install && cd ../guide && npm install && cd ..


Some of the examples use external dependencies which aren't in the top-level package.json, so we have to install them before running tsc in Travis. (Otherwise TypeScript throws errors for missing dependencies.)

bitjson · 2020-08-10T18:39:09Z

(I force-pushed to retry CI. Tests on Node.js 8 fail randomly – not related to this PR, which doesn't touch any JS.)

jonschlinkert

the code is breaking some SOLID principles

Yeah, there are tradeoffs. If you've seen any of my other libraries, I'm a big fan of SOLID principles, I tend to favor responsibility libraries. IMHO, in Enquirer the benefits of inheritance far outweigh the advantages of SOLID, from the standpoints of both maintenance and implementation. It's just too much work to redefine everything on every class, and repeated code everywhere lends itself to inconsistencies when minor improvements or tweaks are made.

(I force-pushed to retry CI. Tests on Node.js 8 fail randomly – not related to this PR, which doesn't touch any JS.)

I think it's related to a dev dependency (time-require I think). Don't worry about it, I'll get that fixed. If that is indeed what's causing it, I'll either fix the node version inconsistency or just remove that unnecessary dev dep.

I'm still looking through, but I'd love to get this merged. I'm getting caught up. ~~Please let me know if you think it's ready.~~ I just #307 (comment) but missed that earlier. Sounds good!

jonschlinkert · 2020-09-06T18:43:50Z

.travis.yml

@@ -9,3 +9,5 @@ node_js:
  - '11'
  - '10'
  - '8'
+before_script:
+  - cd examples && npm install && cd ../guide && npm install && cd ..


bitjson · 2020-09-08T16:34:40Z

@jonschlinkert thanks for taking a look! Please let me know if there's anything else you'd like me to change before merging this. 🚀

I'm current using a version of this PR in my development branch of Bitauth CLI, where I'm continuing to improve the types as needed.

After this PR is merged, future PRs should have much smaller diffs and only increase "TypeScript coverage". (In this PR, only a few examples are "covered", but we can slowly expand that list until it includes everything in the examples, guide, and test directories.)

jonschlinkert · 2020-09-10T16:03:09Z

@bitjson I'm amazed at the amount of effort that you, @unional and others have put into adding typescript support. You are very much appreciated!

@doowb and I have both looked over the code, neither of us had any issues at all running the code. One of us will try to get these changes merged in ASAP. Thanks!

linzhiq · 2020-11-02T10:22:26Z

^ any update on this 😬

KamalAman · 2020-11-18T17:48:06Z

@jonschlinkert / @doowb 🙏 💖 🙏 Getting this in would be very much appreciated 🙏 💖 🙏

kherock · 2020-11-26T22:11:41Z

👍 Just confirming that these changes work great in a CLI project I'm writing in TS, would really appreciate if these changes made in in soon!

bitjson · 2021-02-01T23:38:38Z

Hey @jonschlinkert and @doowb, I think this has been well-reviewed by some of the above commenters, and the changes are contained to only TypeScript-related parts of the project. (It also resolves/closes 11 other issues and PRs! 😄)

I think merging is pretty low-risk now: would it be possible to get this released soon?

eleith · 2021-03-10T20:37:23Z

as a workaround till this lands, you can update your tsconfig.json to use the types provided by this branch as follows (the below example assumes you download index.d.ts from this branch to types/enquirer.d.ts)

{                                                                                                                                                                                                                
   "compilerOptions": {                                                                                                                                                                                                                                                                                                                                                                                   
     "paths": {                                                                                                                                                                                                   
       "enquirer": ["./types/enquirer.d.ts"]                                                                                                                                                                      
     }                                                                                                                                                                                                            
   }                                                                                                                                                                                                                                                                                                                                                                                          
}

ericvera · 2021-04-27T20:45:32Z

Thanks @eleith for the workaround! In case someone runs into issues with the solution you also need to set baseUrl for this paths work.

{
 "compilerOptions": {
   "baseUrl": ".",
   "paths": {
     "enquirer": ["./types/enquirer.d.ts"]
   }
 }                                                                                                                                                                                                                                                                                                                                                                              }

youbek · 2022-01-30T18:29:36Z

Any updates on this? Thanks :)

lenovouser · 2022-03-10T10:08:59Z

I've tested this as well, seems to work flawlessly so far. Can this be merged @jonschlinkert and @doowb?

bestickley · 2022-03-17T14:45:28Z

Using TypeScript, would really appreciate for this to be merged.

D3SOX · 2022-04-12T08:19:57Z

I encountered some issues while trying to use these definitions

Many SymbolsTypes are missing
Can't find Type here
And an interesting warning here

I would like to use Enquirer because it supports more prompts ootb but for the moment Inquirer seems to be a better maintained project

ProdigySim · 2022-04-25T16:27:43Z

index.d.ts

+        Options &
+        types.Initializer<string | number, string> &
+        types.Formatter<string, string>;
+      export type MultipleOptions = { multiple: true } & Type &


This Type & seems superfluous, it resolves to nothing in my local setup. Similar on SingleOptions in this namespace.

ProdigySim · 2022-04-25T16:33:53Z

rebeccahum · 2024-05-09T14:43:12Z

Hi! We are seeing that the type definition for ConfirmQuestionOptions is expecting a string for the initial property, however, it should allow a boolean per

enquirer/lib/prompts/confirm.js

Line 8 in 70bdb0f

this.default = this.options.default || (this.initial ? '(Y/n)' : '(y/N)');

I think we need to change initial?: T | ( () => Promise< T > | T ); to initial?: T | ( () => Promise< T > | T ) | boolean | ( () => Promise< boolean > | boolean ); under export type Question< T extends types.Answer = string, P extends Prompt< T > = Prompt< T > > = {

Thankssss

unional added 30 commits January 11, 2020 17:28

feat: add types for Prompt

3806a8f

fix: add types for prompts

feccc7e

fix: import types for BooleanPrompt

f08ac84

fix: add types for NumberPrompt and StringPrompt

47394c7

fix: add ArrayPrompt type

43857ac

Converted some support functions to TypeScript

fix: add Input type

ba5efa0

fix: adjust Enquirer.register(,fn) type

f501d40

fix: add type for PasswordPrompt

e33e9f7

fix: add type for ConfirmPrompt

42ceb65

fix: add type for Invisible

5070649

fix: add type for AutoComplete

986aee3

fix: add type for Toggle

32fef40

fix: add type for multiselect

fffb5d4

fix: adjust other prompt types base class

493238c

fix: reorganize types

9d3933d

fix: add header prop

9ed86b4

fix: add type questions for a few prompts

b0b21c5

input, confirm, numberal, password, invisible, toggle, basicauth

fix: add input type for quiz

9610fe2

chore: skipping Survey prompt as it is too alpha

592475b

fix: add scale input type

d05f956

fix: add type for scale question

135ed4c

fix: add type for sort question

e84a830

fix: add type for snippet question

67d8377

fix: add type for list question

1db9e72

fix: remove extra initial type from QuizQuestion

4977a9d

fix: add type for select question

229b555

fix: add separator for list question

803a92f

fix: add type for multiselect question

cca9fbd

fix: add type for form question

186c50b

fix: add align to form and scale question

cbab419

bitjson marked this pull request as ready for review August 7, 2020 18:40

fix: allow additional options, add tsdocs

225d258

bitjson force-pushed the typings branch from 13ae987 to 225d258 Compare August 7, 2020 18:46

bitjson commented Aug 7, 2020

View reviewed changes

fix: add missing choice properties and tsdocs

4ca593e

bitjson force-pushed the typings branch from cc22bd4 to 4ca593e Compare August 10, 2020 18:26

jonschlinkert reviewed Sep 6, 2020

View reviewed changes

G-Rath mentioned this pull request Oct 18, 2020

Move types into namespace so that they can be imported #258

Open

smithki mentioned this pull request Dec 22, 2020

Upcoming TypeScript changes to Enquirer listr2/listr2#235

Closed

ProdigySim reviewed Apr 25, 2022

View reviewed changes

sjinks mentioned this pull request Jun 1, 2023

refactor: Convert lib/config to TypeScript Automattic/vip-cli#1392

Merged

abdullah-kasim mentioned this pull request Jun 2, 2023

Add types for the other ways of using enquirer Automattic/vip-cli#1395

Merged

Zikoat mentioned this pull request Sep 21, 2023

[ESM Support] Import named 'prompt' not found in module #439

Open

rebeccahum mentioned this pull request May 9, 2024

Fix promptForBoolean to display the default initial value capitalized Automattic/vip-cli#1829

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update TypeScript types, check types against JavaScript tests/examples #307

Update TypeScript types, check types against JavaScript tests/examples #307

bitjson commented Aug 4, 2020 •

edited

bitjson commented Aug 7, 2020

bitjson Aug 7, 2020

jonschlinkert Sep 6, 2020

bitjson commented Aug 10, 2020

jonschlinkert left a comment •

edited

jonschlinkert Sep 6, 2020

bitjson commented Sep 8, 2020

jonschlinkert commented Sep 10, 2020

linzhiq commented Nov 2, 2020

KamalAman commented Nov 18, 2020

kherock commented Nov 26, 2020

bitjson commented Feb 1, 2021

eleith commented Mar 10, 2021

ericvera commented Apr 27, 2021 •

edited

youbek commented Jan 30, 2022

lenovouser commented Mar 10, 2022

bestickley commented Mar 17, 2022

D3SOX commented Apr 12, 2022 •

edited

ProdigySim Apr 25, 2022 •

edited

ProdigySim commented Apr 25, 2022

rebeccahum commented May 9, 2024 •

edited

Update TypeScript types, check types against JavaScript tests/examples #307

Are you sure you want to change the base?

Update TypeScript types, check types against JavaScript tests/examples #307

Conversation

bitjson commented Aug 4, 2020 • edited

bitjson commented Aug 7, 2020

bitjson Aug 7, 2020

Choose a reason for hiding this comment

jonschlinkert Sep 6, 2020

Choose a reason for hiding this comment

bitjson commented Aug 10, 2020

jonschlinkert left a comment • edited

Choose a reason for hiding this comment

jonschlinkert Sep 6, 2020

Choose a reason for hiding this comment

bitjson commented Sep 8, 2020

jonschlinkert commented Sep 10, 2020

linzhiq commented Nov 2, 2020

KamalAman commented Nov 18, 2020

kherock commented Nov 26, 2020

bitjson commented Feb 1, 2021

eleith commented Mar 10, 2021

ericvera commented Apr 27, 2021 • edited

youbek commented Jan 30, 2022

lenovouser commented Mar 10, 2022

bestickley commented Mar 17, 2022

D3SOX commented Apr 12, 2022 • edited

ProdigySim Apr 25, 2022 • edited

Choose a reason for hiding this comment

ProdigySim commented Apr 25, 2022

rebeccahum commented May 9, 2024 • edited

bitjson commented Aug 4, 2020 •

edited

jonschlinkert left a comment •

edited

ericvera commented Apr 27, 2021 •

edited

D3SOX commented Apr 12, 2022 •

edited

ProdigySim Apr 25, 2022 •

edited

rebeccahum commented May 9, 2024 •

edited