Merge branch 'master' into create-redirect

* master:
  0.17.0
  Prepare 0.17.0
  [version-sort] do not push pre-releases of the latest stable version (#148)
  🐛make compare-versions a dependency (#142)

CHANGELOG.md

@@ -1,6 +1,8 @@
-## Master
+## 0.17.0
 
 * Add data attribute to prevent Swiftype from indexing sidebar content on `PageLayout`. [#146](https://github.com/mapbox/dr-ui/pull/146)
+* Add compare-versions as a dependency to support `helpers/version-sort.js`. [#142](https://github.com/mapbox/dr-ui/pull/142)
+* Fix `version-sort` helper function so it does not push pre-releases of the latest stable version. [#148](https://github.com/mapbox/dr-ui/pull/148)
 
 ## 0.16.2
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/dr-ui",
-  "version": "0.16.2",
+  "version": "0.17.0",
   "description": "Mapbox frontend tools for documentation websites.",
   "main": "index.js",
   "scripts": {
@@ -38,7 +38,6 @@
     "babel-eslint": "^8.2.6",
     "babelify": "^10.0.0",
     "budo": "^11.6.0",
-    "compare-versions": "^3.4.0",
     "cpy": "^7.0.1",
     "cpy-cli": "^2.0.0",
     "del": "^3.0.0",
@@ -70,6 +69,7 @@
     "@elastic/search-ui-site-search-connector": "^0.10.0",
     "@mapbox/mr-ui": "^0.7.0",
     "classnames": "^2.2.6",
+    "compare-versions": "^3.4.0",
     "debounce": "^1.2.0",
     "downshift": "^3.2.7",
     "hastscript": "^5.0.0",

src/helpers/version-sort.js

@@ -42,7 +42,13 @@ export function sortVersions(versions) {
     sortPreReleases
       .sort(sortBy('version'))
       .reverse()
-      .map(v => v.version);
+      .reduce((arr, v) => {
+        // do not push pre releases of lastest stable
+        if (!allLatestVersion.test(v.version)) {
+          arr.push(v.version);
+        }
+        return arr;
+      }, []);
 
   const versionsToDisplay = allVersionsOrdered.filter(version => {
     return !/^(\d|\.)+-(alpha|beta|rc|pre).+/.test(version);

tests/version-sort.test.js

@@ -217,9 +217,7 @@ describe('ios', () => {
   });
 
   test(`newestPreRelease`, () => {
-    expect(sortVersions(allIosVersions).newestPreRelease).toEqual([
-      '5.0.0-beta.1'
-    ]);
+    expect(sortVersions(allIosVersions).newestPreRelease).toEqual([]);
   });
   test(`versionsToDisplay`, () => {
     expect(sortVersions(allIosVersions).versionsToDisplay).toEqual([
@@ -314,4 +312,32 @@ describe('ios', () => {
   test(`newestPreRelease, no pre releases`, () => {
     expect(sortVersions(['4.9.0', '4.8.0']).newestPreRelease).toEqual([]);
   });
+
+  test('dont show pre releases of latest stable', () => {
+    expect(
+      sortVersions([
+        '5.1.0',
+        '5.1.0-beta.1',
+        '5.1.0-alpha.2',
+        '5.1.0-alpha.1',
+        '5.0.0',
+        '4.12.0-beta.1',
+        '4.11.0'
+      ])
+    ).toEqual({
+      allLatestVersion: /^5.1.0-.+/,
+      allVersionsOrdered: [
+        '5.1.0',
+        '5.1.0-beta.1',
+        '5.1.0-alpha.2',
+        '5.1.0-alpha.1',
+        '5.0.0',
+        '4.12.0-beta.1',
+        '4.11.0'
+      ],
+      latestStable: '5.1.0',
+      newestPreRelease: [],
+      versionsToDisplay: ['5.1.0', '5.0.0', '4.11.0']
+    });
+  });
 });