docsearch.js - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

CONTRIBUTING.md

@@ -15,4 +15,7 @@ Hi (future) collaborator!
 - [Development workflow](#development-workflow)
+  - [Local example](#local-example)
+  - [Documentation website](#documentation-website)
 - [Adding/Updating a package](#addingupdating-a-package)
 - [Removing a package](#removing-a-package)
+- [In case of shrinkwrap madness](#in-case-of-shrinkwrap-madness)
 - [Commit message guidelines](#commit-message-guidelines)
@@ -27,3 +30,2 @@ - [Revert](#revert)
 - [When are issues closed?](#when-are-issues-closed)
-- [Milestones](#milestones)
 - [Releasing](#releasing)
@@ -30,0 +32,0 @@ - [Beta releases](#beta-releases)

dist/npm/src/lib/DocSearch.js

@@ -33,2 +33,6 @@ 'use strict';
 
+var _versionJs = require('./version.js');
+
+var _versionJs2 = _interopRequireDefault(_versionJs);
+
 var _npmZepto = require('npm-zepto');
@@ -70,2 +74,3 @@
     this.client = (0, _algoliasearch2['default'])('BH4D9OD16A', this.apiKey);
+    this.client.addAlgoliaAgent('docsearch.js ' + _versionJs2['default']);
     this.autocomplete = (0, _autocompleteJs2['default'])(this.input, autocompleteOptions, [{
@@ -122,4 +127,2 @@ source: this.getSource(),
     value: function formatHits(receivedHits) {
-      var _this2 = this;
-
       var hits = receivedHits.map(function (hit) {
@@ -142,6 +145,6 @@ hit._highlightResult = _utilsJs2['default'].mergeKeyWithParent(hit._highlightResult, 'hierarchy');
         var url = hit.anchor ? hit.url + '#' + hit.anchor : hit.url;
-        var category = _this2.getHighlightedValue(hit, 'lvl0');
-        var subcategory = _this2.getHighlightedValue(hit, 'lvl1') || category;
-        var displayTitle = _utilsJs2['default'].compact([_this2.getHighlightedValue(hit, 'lvl2') || subcategory, _this2.getHighlightedValue(hit, 'lvl3'), _this2.getHighlightedValue(hit, 'lvl4'), _this2.getHighlightedValue(hit, 'lvl5'), _this2.getHighlightedValue(hit, 'lvl6')]).join(' › ');
-        var text = _this2.getSnippettedValue(hit, 'content');
+        var category = _utilsJs2['default'].getHighlightedValue(hit, 'lvl0');
+        var subcategory = _utilsJs2['default'].getHighlightedValue(hit, 'lvl1') || category;
+        var displayTitle = _utilsJs2['default'].compact([_utilsJs2['default'].getHighlightedValue(hit, 'lvl2') || subcategory, _utilsJs2['default'].getHighlightedValue(hit, 'lvl3'), _utilsJs2['default'].getHighlightedValue(hit, 'lvl4'), _utilsJs2['default'].getHighlightedValue(hit, 'lvl5'), _utilsJs2['default'].getHighlightedValue(hit, 'lvl6')]).join(' › ');
+        var text = _utilsJs2['default'].getSnippetedValue(hit, 'content');
 
@@ -160,23 +163,2 @@ return {
   }, {
-    key: 'getHighlightedValue',
-    value: function getHighlightedValue(object, key) {
-      var highlight = object._highlightResult[key];
-      return highlight ? highlight.value : object[key];
-    }
-  }, {
-    key: 'getSnippettedValue',
-    value: function getSnippettedValue(object, key) {
-      if (!object._snippetResult || !object._snippetResult[key].value) {
-        return object[key];
-      }
-      var snippet = object._snippetResult[key].value;
-      if (snippet[0] !== snippet[0].toUpperCase()) {
-        snippet = '…' + snippet;
-      }
-      if (['.', '!', '?'].indexOf(snippet[snippet.length - 1]) === -1) {
-        snippet = snippet + '…';
-      }
-      return snippet;
-    }
-  }, {
     key: 'getSuggestionTemplate',
@@ -183,0 +165,0 @@ value: function getSuggestionTemplate() {

dist/npm/src/lib/main.js

@@ -17,5 +17,10 @@ 'use strict';
 
+var _versionJs = require('./version.js');
+
+var _versionJs2 = _interopRequireDefault(_versionJs);
+
 var docSearch = (0, _toFactory2['default'])(_DocSearch2['default']);
+docSearch.version = _versionJs2['default'];
 
 exports['default'] = docSearch;
 module.exports = exports['default'];

dist/npm/src/lib/utils.js

@@ -183,2 +183,60 @@ 'use strict';
     return results;
+  },
+  /*
+   * Returns the highlighted value of the specified key in the specified object.
+   * If no highlighted value is available, will return the key value directly
+   * eg.
+   * getHighlightedValue({
+   *    _highlightResult: {
+   *      text: {
+   *        value: '<mark>foo</mark>'
+   *      }
+   *    },
+   *    text: 'foo'
+   * }, 'text');
+   * =>
+   * '<mark>foo</mark>'
+   * @param {object} object Hit object returned by the Algolia API
+   * @param {string} property Object key to look for
+   * @return {string}
+   **/
+  getHighlightedValue: function getHighlightedValue(object, property) {
+    if (!object._highlightResult || !object._highlightResult[property] || !object._highlightResult[property].value) {
+      return object[property];
+    }
+    return object._highlightResult[property].value;
+  },
+  /*
+   * Returns the snippeted value of the specified key in the specified object.
+   * If no highlighted value is available, will return the key value directly.
+   * Will add starting and ending ellipsis (…) if we detect that a sentence is
+   * incomplete
+   * eg.
+   * getSnippetedValue({
+   *    _snippetResult: {
+   *      text: {
+   *        value: '<mark>This is an unfinished sentence</mark>'
+   *      }
+   *    },
+   *    text: 'This is an unfinished sentence'
+   * }, 'text');
+   * =>
+   * '<mark>This is an unefinished sentenced</mark>…'
+   * @param {object} object Hit object returned by the Algolia API
+   * @param {string} property Object key to look for
+   * @return {string}
+   **/
+  getSnippetedValue: function getSnippetedValue(object, property) {
+    if (!object._snippetResult || !object._snippetResult[property] || !object._snippetResult[property].value) {
+      return object[property];
+    }
+    var snippet = object._snippetResult[property].value;
+
+    if (snippet[0] !== snippet[0].toUpperCase()) {
+      snippet = '…' + snippet;
+    }
+    if (['.', '!', '?'].indexOf(snippet[snippet.length - 1]) === -1) {
+      snippet = snippet + '…';
+    }
+    return snippet;
   }
@@ -185,0 +243,0 @@

package.json

 {
   "name": "docsearch.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Add an autocomplete dropdown to your documentation",
@@ -44,2 +44,3 @@ "main": "dist/npm/index.js",
     "mversion": "^1.10.1",
+    "nd": "^1.2.0",
     "node-sass": "^3.4.2",
@@ -50,2 +51,3 @@ "npm-shrinkwrap": "^200.4.0",
     "pretty-bytes": "^2.0.1",
+    "semver": "^5.1.0",
     "uglifyjs": "^2.4.10",
@@ -52,0 +54,0 @@ "webpack": "^1.12.2",

README.md

@@ -0,1 +1,17 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [docsearch](#docsearch)
+- [Usage](#usage)
+- [Examples](#examples)
+- [How do I get an `apiKey` and `indexName`?](#how-do-i-get-an-apikey-and-indexname)
+- [How does it work?](#how-does-it-work)
+- [Development workflow](#development-workflow)
+  - [Local example](#local-example)
+  - [Documentation website](#documentation-website)
+  - [MacOS](#macos)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # docsearch
@@ -2,0 +18,0 @@

src/lib/version.js

@@ -1,1 +0,1 @@
-export default '0.0.1';
+export default '0.0.2';

No alert changes

Improved metrics

Number of package files

220

0.92%

Number of lines in readme file

96

20%

Number of medium supply chain risk alerts

4

-20%

Worsened metrics

Total package byte prevSize

3036509

-3.4%

Dev dependency count

30

7.14%

Lines of code

15747

-7.71%

No dependency changes