fix: the spinner

lib/utils/display.js

@@ -169,6 +169,7 @@ class Display {
 
   // progress
   #progress
+  #silentPrompt
 
   // options
   #command
@@ -347,6 +348,11 @@ class Display {
 
       case input.KEYS.end:
         log.resume()
+        if (this.#silentPrompt) {
+          // Add newline to preserve output
+          output.standard('')
+          this.#silentPrompt = false
+        }
         output.flush()
         this.#progress.resume()
         break
@@ -355,12 +361,29 @@ class Display {
         // The convention when calling input.read is to pass in a single fn that returns
         // the promise to await. resolve and reject are provided by proc-log
         const [res, rej, p] = args
-        return input.start(() => p()
-          .then(res)
-          .catch(rej)
-          // Any call to procLog.input.read will render a prompt to the user, so we always
-          // add a single newline of output to stdout to move the cursor to the next line
-          .finally(() => output.standard('')))
+
+        // Silent inputs like password prompts require special handling
+        // to preserve output when users hit enter (see input.KEYS.end).
+        this.#silentPrompt = meta[META]?.silentPrompt || false
+
+        // Use sequential input management to avoid race condition which causes issues
+        // with spinner and adding newlines
+        process.emit('input', 'start')
+
+        return p()
+          .then((result) => {
+            // User hits enter, process end event and return input
+            process.emit('input', 'end')
+            res(result)
+            return result
+          })
+          .catch((error) => {
+            // User hits ctrl+c, add newline to preserve output
+            output.standard('')
+            this.#silentPrompt = false
+            process.emit('input', 'end')
+            rej(error)
+          })
       }
     }
   })

lib/utils/read-user-info.js

@@ -1,6 +1,6 @@
 const { read: _read } = require('read')
 const userValidate = require('npm-user-validate')
-const { log, input } = require('proc-log')
+const { log, input, META } = require('proc-log')
 
 const otpPrompt = `This command requires a one-time password (OTP) from your authenticator app.
 Enter one below. You can also pass one on the command line by appending --otp=123456.
@@ -11,7 +11,11 @@ const passwordPrompt = 'npm password: '
 const usernamePrompt = 'npm username: '
 const emailPrompt = 'email (this IS public): '
 
-const read = (...args) => input.read(() => _read(...args))
+const read = (...args) => {
+  // Pass silent information through to determine if we need to add a newline after the prompt
+  // Rename parameter to avoid confusion with silent logging in Display
+  return input.read(() => _read(...args), { [META]: { silentPrompt: args[0]?.silent } })
+}
 
 function readOTP (msg = otpPrompt, otp, isRetry) {
   if (isRetry && otp && /^[\d ]+$|^[A-Fa-f0-9]{64,64}$/.test(otp)) {

tap-snapshots/test/lib/commands/init.js.test.cjs

@@ -20,6 +20,5 @@ Press ^C at any time to quit.
 
 exports[`test/lib/commands/init.js TAP workspaces no args -- yes > should print helper info 1`] = `
 
-
 added 1 package in {TIME}
 `

tap-snapshots/test/lib/utils/open-url.js.test.cjs

@@ -25,7 +25,6 @@ https://www.npmjs.com
 exports[`test/lib/utils/open-url.js TAP open url prompt does not error when opener can not find command > Outputs extra Browser unavailable message and url 1`] = `
 npm home:
 https://www.npmjs.com
-
 Browser unavailable. Please open the URL manually:
 https://www.npmjs.com
 `

test/lib/utils/display.js

@@ -197,3 +197,46 @@ t.test('Display.clean', async (t) => {
     clearOutput()
   }
 })
+
+t.test('prompt functionality', async t => {
+  t.test('regular prompt completion works', async t => {
+    const { input } = await mockDisplay(t)
+
+    const result = await input.read(() => Promise.resolve('user-input'))
+
+    t.equal(result, 'user-input', 'should return the input result')
+  })
+
+  t.test('silent prompt completion works', async t => {
+    const { input, META } = await mockDisplay(t)
+
+    const result = await input.read(
+      () => Promise.resolve('secret-password'),
+      { [META]: { silentPrompt: true } }
+    )
+
+    t.equal(result, 'secret-password', 'should return the input result for silent prompts')
+  })
+
+  t.test('metadata is correctly passed through', async t => {
+    const { input, META } = await mockDisplay(t)
+
+    await input.read(
+      () => Promise.resolve('result1'),
+      { [META]: { silentPrompt: false } }
+    )
+    t.pass('should handle silentPrompt: false metadata')
+
+    await input.read(
+      () => Promise.resolve('result2'),
+      { [META]: {} }
+    )
+    t.pass('should handle empty metadata')
+
+    await input.read(
+      () => Promise.resolve('result3'),
+      { [META]: { silentPrompt: true } }
+    )
+    t.pass('should handle silentPrompt: true metadata')
+  })
+})

test/lib/utils/read-user-info.js

@@ -118,3 +118,35 @@ t.test('email - invalid warns and retries', async (t) => {
   t.equal(result, '[email protected]', 'received the email')
   t.equal(logMsg, 'invalid email')
 })
+
+t.test('read-user-info integration works', async (t) => {
+  t.teardown(() => {
+    readResult = null
+    readOpts = null
+  })
+
+  readResult = 'regular-input'
+  const username = await readUserInfo.username('Username: ')
+  t.equal(username, 'regular-input', 'should return username from regular prompt')
+  t.notOk(readOpts.silent, 'username prompt should not set silent')
+
+  readResult = 'secret-password'
+  const password = await readUserInfo.password('Password: ')
+  t.equal(password, 'secret-password', 'should return password from silent prompt')
+  t.match(readOpts, { silent: true }, 'password prompt should set silent: true')
+})
+
+t.test('silent metadata is passed correctly by read-user-info', async (t) => {
+  t.teardown(() => {
+    readResult = null
+    readOpts = null
+  })
+
+  readResult = 'username'
+  await readUserInfo.username('Username: ')
+  t.notOk(readOpts?.silent, 'username prompt should not set silent')
+
+  readResult = 'password'
+  await readUserInfo.password('Password: ')
+  t.equal(readOpts?.silent, true, 'password prompt should set silent: true')
+})