fix: Use canonical 'before' config name

BREAKING CHANGE: 'enjoyBy' is no longer an acceptable alias.

Author: isaacs

README.md

@@ -34,11 +34,12 @@ fetch('https://registry.npmjs.org/npm-pick-manifest').then(res => {
 
 ### Contributing
 
-The npm-pick-manifest team enthusiastically welcomes contributions and project participation!
-There's a bunch of things you can do if you want to contribute! The [Contributor
-Guide](CONTRIBUTING.md) has all the information you need for everything from
-reporting bugs to contributing entire new features. Please don't hesitate to
-jump in if you'd like to, or even ask us questions if something isn't clear.
+The npm-pick-manifest team enthusiastically welcomes contributions and
+project participation!  There's a bunch of things you can do if you want to
+contribute! The [Contributor Guide](CONTRIBUTING.md) has all the
+information you need for everything from reporting bugs to contributing
+entire new features. Please don't hesitate to jump in if you'd like to, or
+even ask us questions if something isn't clear.
 
 ### API
 
@@ -70,15 +71,17 @@ The algorithm will follow npm's algorithm for semver resolution, and only `tag`,
 
 The function will throw `ETARGET` if there was no matching manifest, and
 `ENOVERSIONS` if the packument object has no valid versions in `versions`.
+If the only matching manifest is included in a `policyRestrictions` section
+of the packument, then an `E403` is raised.
 
 If `opts.defaultTag` is provided, it will be used instead of `latest`. That is,
 if that tag matches the selector, it will be used, even if a higher available
 version matches the range.
 
-If `opts.enjoyBy` is provided, it should be something that can be passed to `new
-Date(x)`, such as a `Date` object or a timestamp string. It will be used to
-filter the selected versions such that only versions less than or equal to
-`enjoyBy` are considered.
+If `opts.before` is provided, it should be something that can be passed to
+`new Date(x)`, such as a `Date` object or a timestamp string. It will be
+used to filter the selected versions such that only versions less than or
+equal to `before` are considered.
 
 If `opts.includeDeprecated` passed in as true, deprecated versions will be
 selected. By default, deprecated versions other than `defaultTag` are ignored.

index.js

@@ -7,11 +7,11 @@ module.exports = pickManifest
 function pickManifest (packument, wanted, opts = {}) {
   const {
     defaultTag = 'latest',
-    enjoyBy = null,
+    before = null,
     includeDeprecated = false
   } = opts
 
-  const time = enjoyBy && packument.time && +(new Date(enjoyBy))
+  const time = before && packument.time && +(new Date(before))
   const spec = npa.resolve(packument.name, wanted)
   const type = spec.type
   if (type === 'version' || type === 'range') {
@@ -106,9 +106,9 @@ function pickManifest (packument, wanted, opts = {}) {
     // Check if target is forbidden
     const isForbidden = target && policyRestrictions && policyRestrictions.versions[target]
     const pckg = `${packument.name}@${wanted}${
-      enjoyBy
+      before
         ? ` with an Enjoy By date of ${
-          new Date(enjoyBy).toLocaleString()
+          new Date(before).toLocaleString()
         }. Maybe try a different date?`
         : ''
     }`

test/index.js

@@ -336,7 +336,7 @@ test('accepts opts.includeDeprecated option to disable skipping', t => {
   t.done()
 })
 
-test('accepts opts.enjoyBy option to do date-based cutoffs', t => {
+test('accepts opts.before option to do date-based cutoffs', t => {
   const metadata = {
     'dist-tags': {
       latest: '3.0.0'
@@ -358,28 +358,28 @@ test('accepts opts.enjoyBy option to do date-based cutoffs', t => {
   }
 
   let manifest = pickManifest(metadata, '*', {
-    enjoyBy: '2018-01-02'
+    before: '2018-01-02'
   })
   t.equal(manifest.version, '2.0.0', 'filtered out 3.0.0 because of dates')
 
   manifest = pickManifest(metadata, 'latest', {
-    enjoyBy: '2018-01-02'
+    before: '2018-01-02'
   })
   t.equal(manifest.version, '2.0.0', 'tag specs pick highest before dist-tag but within the range in question')
 
   manifest = pickManifest(metadata, '3.0.0', {
-    enjoyBy: '2018-01-02'
+    before: '2018-01-02'
   })
   t.equal(manifest.version, '3.0.0', 'requesting specific version overrides')
 
   manifest = pickManifest(metadata, '^2', {
-    enjoyBy: '2018-01-02'
+    before: '2018-01-02'
   })
   t.equal(manifest.version, '2.0.0', 'non-tag ranges filtered')
 
   t.throws(() => {
     pickManifest(metadata, '^3', {
-      enjoyBy: '2018-01-02'
+      before: '2018-01-02'
     })
   }, /Enjoy By/, 'range for out-of-range spec fails even if defaultTag avail')
   t.done()