Include prerelease versions when deprecating

PR-URL: #2366 Credit: @tiegz Close: #2366 Reviewed-by: @isaacs EDIT(@isaacs): updated to make _all_ deprecation ranges include prereleases. If `foo@*` would be expected to deprecate `[email protected]`, then presumably `[email protected]` has the same expectation.
npm · Dec 18, 2020 · 44d4331 · 44d4331
1 parent a9b8bf2
commit 44d4331
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/docs/content/commands/npm-deprecate.md b/docs/content/commands/npm-deprecate.md
@@ -7,7 +7,7 @@ description: Deprecate a version of a package
 ### Synopsis
 
 ```bash
-npm deprecate <pkg>[@<version>] <message>
+npm deprecate <pkg>[@<version range>] <message>
 ```
 
 ### Description
@@ -22,8 +22,17 @@ versions, so you can do something like this:
 npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
 ```
 
-Note that you must be the package owner to deprecate something.  See the
-`owner` and `adduser` help topics.
+SemVer ranges passed to this command are interpreted such that they *do*
+include prerelease versions.  For example:
+
+```bash
+npm deprecate [email protected] "1.x is no longer supported"
+```
+
+In this case, a version `[email protected]` will also be deprecated.
+
+You must be the package owner to deprecate something.  See the `owner` and
+`adduser` help topics.
 
 To un-deprecate a package, specify an empty string (`""`) for the `message` 
 argument. Note that you must use double quotes with no space between them to 

diff --git a/lib/deprecate.js b/lib/deprecate.js
@@ -58,7 +58,7 @@ const deprecate = async ([pkg, msg]) => {
   })
 
   Object.keys(packument.versions)
-    .filter(v => semver.satisfies(v, spec))
+    .filter(v => semver.satisfies(v, spec, { includePrerelease: true }))
     .forEach(v => {
       packument.versions[v].deprecated = msg
     })

diff --git a/test/lib/deprecate.js b/test/lib/deprecate.js
@@ -13,6 +13,7 @@ npmFetch.json = async (uri, opts) => {
     versions: {
       '1.0.0': {},
       '1.0.1': {},
+      '1.0.1-pre': {},
     },
   }
 }
@@ -126,6 +127,9 @@ test('deprecates all versions when no range is specified', t => {
         '1.0.1': {
           deprecated: 'this version is deprecated',
         },
+        '1.0.1-pre': {
+          deprecated: 'this version is deprecated',
+        },
       },
     })