Exclude deprecated packages by default. Add --deprecated to include. F…

…ixes #624.
raineorshine · Sep 10, 2020 · 3ba1523 · 3ba1523
1 parent a2b2917
commit 3ba1523
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,14 @@
 # Changelog
 This file documents all **major version** releases. For other releases, you'll have to read the [commit history](https://github.com/raineorshine/npm-check-updates/).
 
+## [9.0.0] - 2020-09-10
+
+### Breaking
+
+- Versions marked as `deprecated` in npm are now ignored by default. If the latest version is deprecated, the next highest non-deprecated version will be suggested. Use `--deprecated` to include deprecated versions (old behavior).
+
+https://github.com/raineorshine/npm-check-updates/compare/v8.1.1...v9.0.0
+
 ## [8.0.0] - 2020-08-29
 
 ### Breaking

diff --git a/README.md b/README.md
@@ -89,6 +89,7 @@ $ ncu "/^(?!gulp-).*$/" # windows
 --dep <dep>                  Check one or more sections of dependencies only:
                              prod, dev, peer, optional, bundle
                              (comma-delimited).
+--deprecated                 Include deprecated packages.
 --doctor                     Iteratively installs upgrades and runs tests to
                              identify breaking upgrades. Run "ncu --doctor"
                              for detailed help. Add "-u" to execute.

diff --git a/lib/constants.js b/lib/constants.js
@@ -22,6 +22,10 @@ const cliOptions = [
     name: '--dep <dep>',
     description: 'Check one or more sections of dependencies only: prod, dev, peer, optional, bundle (comma-delimited).'
   },
+  {
+    name: '--deprecated',
+    description: 'Include deprecated packages.'
+  },
   {
     name: '--doctor',
     description: 'Iteratively installs upgrades and runs tests to identify breaking upgrades. Run "ncu --doctor" for detailed help. Add "-u" to execute.',

diff --git a/lib/npm-check-updates.d.ts b/lib/npm-check-updates.d.ts
@@ -17,6 +17,9 @@ declare namespace ncu {
     /** Check one or more sections of dependencies only: prod, dev, peer, optional, bundle (comma-delimited). */
     dep?: string;
 
+    /** Include deprecated packages. */
+    deprecated?: boolean;
+
     /** Iteratively installs upgrades and runs tests to identify breaking upgrades. Run "ncu --doctor" for detailed help. Add "-u" to execute. */
     doctor?: boolean;
 

diff --git a/lib/package-managers/npm.js b/lib/package-managers/npm.js
@@ -165,9 +165,10 @@ function satisfiesNodeEngine(versionResult, nodeEngine) {
   return versionNodeEngine && semver.satisfies(minVersion, versionNodeEngine)
 }
 
-/** Returns a composite predicate that filters out prerelease, and node engine incompatibilies from version objects returns by pacote.packument. */
+/** Returns a composite predicate that filters out deprecated, prerelease, and node engine incompatibilies from version objects returns by pacote.packument. */
 function filterPredicate(options) {
   return _.overEvery([
+    options.deprecated ? null : o => !o.deprecated,
     options.pre ? null : o => !versionUtil.isPre(o.version),
     options.enginesNode ? o => satisfiesNodeEngine(o, options.enginesNode) : null,
   ])
@@ -267,12 +268,14 @@ module.exports = {
 
     const latest = await viewOne(packageName, 'dist-tags.latest', currentVersion, { timeout: options.timeout })
 
+    // latest should not be deprecated
     // if latest exists and latest is not a prerelease version, return it
     // if latest exists and latest is a prerelease version and --pre is specified, return it
     // if latest exists and latest not satisfies min version of engines.node
     if (latest && filterPredicate(options)(latest)) return latest.version
 
     // if latest is a prerelease version and --pre is not specified
+    // or latest is deprecated
     // find the next valid version
     const versions = await viewOne(packageName, 'versions', currentVersion)
     const validVersions = _.filter(versions, filterPredicate(options))

diff --git a/test/package-managers/npm/index.js b/test/package-managers/npm/index.js
@@ -22,6 +22,16 @@ describe('npm', function () {
     parseInt(version, 10).should.be.above(1)
   })
 
+  it('deprecated excluded by default', async () => {
+    const latest = await packageManagers.npm.latest('ncu-test-deprecated', null, { cwd: __dirname })
+    latest.should.equal('1.0.0')
+  })
+
+  it('deprecated included with option', async () => {
+    const latest = await packageManagers.npm.latest('ncu-test-deprecated', null, { deprecated: true, cwd: __dirname })
+    latest.should.equal('2.0.0')
+  })
+
   it('greatest', async () => {
     const version = await packageManagers.npm.greatest('ncu-test-greatest-not-newest', null, { pre: true, cwd: __dirname })
     version.should.equal('2.0.0-beta')