Deprecate default stdin. Mitigates #136.

1113f5f

Author: raineorshine

README.md

@@ -205,6 +205,7 @@ ncu "/^(?!react-).*$/" # windows
 --retry <n>                  Number of times to retry failed requests for
                              package info. (default: 3)
 -s, --silent                 Don't output anything (--loglevel silent).
+--stdin                      Read package.json from stdin.
 -t, --target <value>         Target version or function that returns version
                              to upgrade to: latest, newest, greatest, minor,
                              patch. Run "ncu --help --target" for details.

src/cli-options.ts

@@ -344,6 +344,11 @@ As a comparison: without using the --peer option, ncu will suggest the latest ve
     description: "Don't output anything (--loglevel silent).",
     type: 'boolean',
   },
+  {
+    long: 'stdin',
+    description: 'Read package.json from stdin.',
+    type: 'string',
+  },
   {
     long: 'target',
     short: 't',

src/lib/findPackage.ts

@@ -66,6 +66,9 @@ async function findPackage(options: Options) {
     pkgFile = options.packageFile
     pkgData = getPackageDataFromFile(pkgFile, pkgFileName)
   } else if (!process.stdin.isTTY) {
+    if (!options.stdin) {
+      print(options, chalk.yellow('Default stdin handling is deprecated. Please add the --stdin option.'), 'warn')
+    }
     print(options, 'Waiting for package data on stdin', 'verbose')
 
     // warn the user after a while if still waiting for stdin

src/types/RunOptions.ts

@@ -114,6 +114,9 @@ export interface RunOptions {
   /** Don't output anything (--loglevel silent). */
   silent?: boolean
 
+  /** Read package.json from stdin. */
+  stdin?: string
+
   /** Target version or function that returns version to upgrade to: latest, newest, greatest, minor, patch. Run "ncu --help --target" for details. (default: "latest") */
   target?: 'latest' | 'newest' | 'greatest' | 'minor' | 'patch' | TargetFunction
 

test/bin.test.ts

@@ -24,21 +24,21 @@ describe('bin', function () {
   }
 
   it('accept stdin', () => {
-    return spawn('node', [bin], '{ "dependencies": { "express": "1" } }').then((output: string) => {
+    return spawn('node', [bin, '--stdin'], '{ "dependencies": { "express": "1" } }').then((output: string) => {
       output.trim().should.startWith('express')
     })
   })
 
   it('reject out-of-date stdin with errorLevel 2', () => {
     return spawn(
       'node',
-      [bin, '--errorLevel', '2'],
+      [bin, '--stdin', '--errorLevel', '2'],
       '{ "dependencies": { "express": "1" } }',
     ).should.eventually.be.rejectedWith('Dependencies not up-to-date')
   })
 
   it('fall back to package.json search when receiving empty content on stdin', async () => {
-    const stdout = await spawn('node', [bin])
+    const stdout = await spawn('node', [bin, '--stdin'])
     stdout
       .toString()
       .trim()
@@ -141,7 +141,7 @@ describe('bin', function () {
     const tempFile = getTempFile()
     fs.writeFileSync(tempFile, '{ "dependencies": { "express": "1" } }', 'utf-8')
     try {
-      await spawn('node', [bin, '-u', '--packageFile', tempFile], '{ "dependencies": {}}')
+      await spawn('node', [bin, '-u', '--stdin', '--packageFile', tempFile], '{ "dependencies": {}}')
       const upgradedPkg = JSON.parse(fs.readFileSync(tempFile, 'utf-8'))
       upgradedPkg.should.have.property('dependencies')
       upgradedPkg.dependencies.should.have.property('express')
@@ -373,7 +373,7 @@ describe('bin', function () {
       const dependencies = {
         'ncu-test-v2': 'https://github.com/raineorshine/ncu-test-v2.git#v1.0.0',
       }
-      const output = await spawn('node', [bin], JSON.stringify({ dependencies }))
+      const output = await spawn('node', [bin, '--stdin'], JSON.stringify({ dependencies }))
       stripAnsi(output)
         .trim()
         .should.equal('ncu-test-v2  https://github.com/raineorshine/ncu-test-v2.git#v1.0.0  →  v2.0.0')
@@ -383,7 +383,7 @@ describe('bin', function () {
       const dependencies = {
         request: 'npm:ncu-test-v2@1.0.0',
       }
-      const output = await spawn('node', [bin], JSON.stringify({ dependencies }))
+      const output = await spawn('node', [bin, '--stdin'], JSON.stringify({ dependencies }))
       stripAnsi(output).trim().should.equal('request  npm:ncu-test-v2@1.0.0  →  2.0.0')
     })
   })