mvw-search-index 2.2.6 → 2.2.11

package/README.md

@@ -4,28 +4,38 @@
 [![NPM version](https://img.shields.io/npm/v/mvw-search-index.svg?style=flat)](https://www.npmjs.com/package/mvw-search-index)
 
 ## About
+
 Small module to generate a [lunr](http://lunrjs.com/) index with result store.
 
-Can e.g. be used to generate a search index for a static website, generated with hugo, jekyll,  gatsby or manually.
+Can e.g. be used to generate a search index for a static website, generated with hugo, jekyll, gatsby or manually.
 
 ## Usage
-First you have to install this package, the create the index that you than use on e.g. a search page.
-Find samples for everything in the following chapters.
+
+First you have to install this package, then create the index that you use on e.g. a search page. Find samples for
+everything in the following chapters.
 
 ### Installation
+
 Use `npm install --save-dev mvw-search-index` to add the dependency to your `package.json`.
 
 ### Index creation
+
 There are multiple possibilities to generate the script. Some are demonstrated in the following sub chapters:
+
 - From CLI
 - From TypeScript
 - From nodejs
 
 #### From CLI
-`mvw-search-index <glob> <destination> [css-selector]`
 
-Foe example:
-`mvw-search-index ./build/**/*.html ./build/index.json`
+```bash
+mvw-search-index <glob> <destination> [css-selector]
+```
+
+For example:
+```bash
+mvw-search-index ./build/**/*.html ./build/index.json
+```
 
 Or from an npm script e.g. for a hugo page (has to be executed after page creation, obviously):
 
@@ -37,17 +47,20 @@ Or from an npm script e.g. for a hugo page (has to be executed after page creati
 }
 ```
 
-#### From TypeSript
-``` ts
+#### From TypeScript
+
+```ts
 import { SearchIndex } from "mvw-search-index";
-// ...
+
 let index = SearchIndex.createFromHtml(files, bodySelector);
 // or: let index = SearchIndex.createFromInfo(info);
 // or: let index = SearchIndex.createFromGlob(glob, bodySelector, cb);
+
 fs.writeFileSync("index.json", JSON.stringify(index));
 ```
 
-### From nodejs
+### From node.js
+
 ```js
 "use strict";
 
@@ -55,124 +68,21 @@ const index = require("mvw-search-index");
 const fs = require("fs")
 
 index.SearchIndex.createFromGlob("./build/**/*.html",
-    "main",
-    (index) => fs.writeFileSync("./static/suche/index.json", JSON.stringify(index)));
+                                 "main",
+                                 (index) => fs.writeFileSync("./static/suche/index.json",
+                                                             JSON.stringify(index)));
 ```
 
-### Sample usage of the created `index.json`
-
-```html
-<!DOCTYPE html>
-
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta content="IE=edge" http-equiv="X-UA-Compatible">
-    <meta content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no" name="viewport">
-    <title>Suche</title>
-    <style>
-      form {
-        text-align: center
-      }
-
-      .mvw-search-field {
-        font-size: 3rem;
-        margin: 15px 0 40px;
-        max-width: 100%
-      }
-
-      .results {
-        padding-left: 0
-      }
-
-      .results li {
-        list-style: none
-      }
-
-      .results a:first-of-type {
-        display: block;
-        font-size: 2.2rem;
-        padding: 15px 0 2px
-      }
-    </style>
-  </head>
-
-  <body itemscope itemtype="http://schema.org/SearchResultsPage">
-    <h1 class="page-header">Suche</h1>
-
-    <div>
-      <form itemprop="potentialAction" itemscope itemtype="http://schema.org/SearchAction">
-        <meta content="search.html?q={query}" itemprop="target">
-        <input class="mvw-search-field" itemprop="query-input" name="query" placeholder="Suche..." type="search">
-      </form>
-
-      <ol class="results"></ol>
-    </div>
-
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.0.1/lunr.min.js"></script>
-    <script>
-      var MVW;
-      (function (MVW) {
-          var Search;
-          (function (Search) {
-              var index;
-              var store;
-              function handleSearch(e) {
-                  var query = $("input.mvw-search-field").val();
-                  var result = index.search(query);
-                  var resultContainer = $(".results");
-                  if (result.length === 0) {
-                      resultContainer.hide();
-                  }
-                  else {
-                      resultContainer.empty();
-                      for (var item in result) {
-                          if (result.hasOwnProperty(item)) {
-                              var ref = result[item].ref;
-                              var i = "<li><a href=\"" + ref + ".html\">" + store[ref].title + "</a><span>" + store[ref].description + "</span></li>";
-                              resultContainer.append(i);
-                          }
-                      }
-                      resultContainer.show();
-                  }
-              }
-              function getParameterByName(name) {
-                  var url = window.location.href;
-                  name = name.replace(/[\[\]]/g, "\\$&");
-                  var regex = new RegExp("[?&]" + name + "(=([^&#]*)|&|#|$)");
-                  var results = regex.exec(url);
-                  if (!results) {
-                      return null;
-                  }
-                  if (!results[2]) {
-                      return "";
-                  }
-                  return decodeURIComponent(results[2].replace(/\+/g, " "));
-              }
-              function initialize() {
-                  $.getJSON("/index.json", function (data) {
-                      index = lunr.Index.load(data.index);
-                      store = data.store;
-                      var query = getParameterByName("query") || getParameterByName("q");
-                      var inputField = $("input.mvw-search-field");
-                      if (query) {
-                          inputField.val(query);
-                      }
-                      inputField.on("keyup", handleSearch);
-                      handleSearch(null);
-                  });
-              }
-              Search.initialize = initialize;
-          })(Search = MVW.Search || (MVW.Search = {}));
-      })(MVW || (MVW = {}));
-      $(function () { return MVW.Search.initialize(); });
-    </script>
-  </body>
-</html>
-```
+### Sample usage of the created index
+
+You can run `npm run serve` from this repository to run the sample site contained in [./demo](./demo).
+
+This contains a very basic static website with a search form on the landing page `index.html`.
 
 ## Releases
+
+- 2.2.10 updates dependencies
+- 2.2.9 gets rid of vinyl and provides a demo application
 - 2.1.4 - 2.1.12: dependency update
 - 2.1.3: added support of glob on API
 - 2.1.1: added CLI

package/js/cli.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var program = require("commander");
+var commander_1 = require("commander");
 var fs = require("fs");
 var index_1 = require("./index");
-program
-    .version("2.1.3")
+commander_1.program
+    .version("2.2.8")
     .arguments("<glob> <dest> [bodySelector]")
     .action(function (glob, dest, bodySelector) {
     index_1.SearchIndex.createFromGlob(glob, bodySelector, function (index) {

package/js/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../ts/cli.ts"],"names":[],"mappings":";;;AAEA,mCAAqC;AACrC,uBAAyB;AAEzB,iCAAsC;AAEtC,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,SAAS,CAAC,8BAA8B,CAAC;KACzC,MAAM,CAAC,UAAC,IAAI,EAAE,IAAI,EAAE,YAAY;IAC/B,mBAAW,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,UAAC,KAAK;QACnD,OAAA,EAAE,CAAC,aAAa,CAAC,IAAI,IAAI,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAA/D,CAA+D,CAChE,CAAC;AACJ,CAAC,CAAC;KACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../ts/cli.ts"],"names":[],"mappings":";;;AAEA,uCAAoC;AACpC,uBAAyB;AAEzB,iCAAsC;AAEtC,mBAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,SAAS,CAAC,8BAA8B,CAAC;KACzC,MAAM,CAAC,UAAC,IAAI,EAAE,IAAI,EAAE,YAAY;IAC/B,mBAAW,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,UAAC,KAAK;QACnD,OAAA,EAAE,CAAC,aAAa,CAAC,IAAI,IAAI,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAA/D,CAA+D,CAChE,CAAC;AACJ,CAAC,CAAC;KACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/js/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="lunr" />
-import * as File from "vinyl";
+/// <reference types="node" />
 export declare interface IResultStore {
     [key: string]: {
         title: string;
@@ -17,12 +17,17 @@ export declare interface ISearchIndexResult {
     index: lunr.Index;
     store: IResultStore;
 }
+declare interface ReadFileWithContents {
+    contents: Buffer;
+    relative: string;
+}
 export declare class SearchIndex {
-    static createFromInfo(files: IFileInformation[]): ISearchIndexResult;
-    static createFromHtml(files: File[], bodySelector?: string): ISearchIndexResult;
-    static createFromGlob(glob: string, bodySelector: string, cb: (index: ISearchIndexResult) => void): void;
     private readonly store;
     private readonly index;
     private constructor();
+    static createFromInfo(files: IFileInformation[]): ISearchIndexResult;
+    static createFromHtml(files: ReadFileWithContents[], bodySelector?: string): ISearchIndexResult;
+    static createFromGlob(glob: string, bodySelector: string, cb: (index: ISearchIndexResult) => void): void;
     private getResult;
 }
+export {};

package/js/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchIndex = void 0;
 var cheerio = require("cheerio");
 var globber = require("glob");
-var vinylFile = require("vinyl-file");
+var fs = require("fs");
 var lunr = require("lunr");
 var SearchIndex = /** @class */ (function () {
     function SearchIndex(files) {
@@ -33,11 +33,9 @@ var SearchIndex = /** @class */ (function () {
             console.info(file.relative);
             var dom = cheerio.load(file.contents.toString());
             return {
-                body: dom(bodySelector || "body").each(function (elem) {
-                    cheerio(elem).append(" ");
-                }).text().replace(/\s\s+/g, " "),
-                description: dom("meta[name='description']").attr("content"),
+                body: dom(bodySelector || "body").text().replace(/\s\s+/g, " "),
                 href: file.relative,
+                description: dom("meta[name='description']").attr("content"),
                 keywords: dom("meta[name='keywords']").attr("content"),
                 title: dom("head title").text(),
             };
@@ -50,8 +48,11 @@ var SearchIndex = /** @class */ (function () {
                 throw err;
             }
             else {
-                var vfiles = files.map(function (file) { return vinylFile.readSync(file); });
-                cb(SearchIndex.createFromHtml(vfiles, bodySelector));
+                var readFiles = files.map(function (file) { return ({
+                    relative: file,
+                    contents: fs.readFileSync(file)
+                }); });
+                cb(SearchIndex.createFromHtml(readFiles, bodySelector));
             }
         });
     };

package/js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AACnC,8BAAgC;AAGhC,IAAM,SAAS,GAAQ,OAAO,CAAC,YAAY,CAAC,CAAC;AAC7C,IAAM,IAAI,GAAQ,OAAO,CAAE,MAAM,CAAC,CAAC;AAsBnC;IAuCE,qBAAoB,KAAyB;QAA7C,iBAiBC;QAhBC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAM,OAAO,GAAiB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC7B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEpB,KAAK,CAAC,OAAO,CAAC,UAAC,IAAsB;YACnC,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gBACtB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC,EAAE,OAAO,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAvDa,0BAAc,GAA5B,UAA6B,KAAyB;QACpD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAEa,0BAAc,GAA5B,UAA6B,KAAa,EAAE,YAA6B;QAA7B,6BAAA,EAAA,qBAA6B;QACvE,IAAM,KAAK,GAAuB,KAAK,CAAC,GAAG,CAAC,UAAC,IAAI;YAC/C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5B,IAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnD,OAAO;gBACH,IAAI,EAAE,GAAG,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI;oBACxC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC9B,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;gBAChC,WAAW,EAAE,GAAG,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC5D,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,QAAQ,EAAE,GAAG,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;gBACtD,KAAK,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE;aAClC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEa,0BAAc,GAA5B,UAA6B,IAAY,EACZ,YAAoB,EACpB,EAAuC;QAClE,OAAO,CAAC,IAAI,EAAE,UAAC,GAAQ,EAAE,KAAe;YACtC,IAAI,GAAG,EAAE;gBACP,MAAM,GAAG,CAAC;aACX;iBAAM;gBACL,IAAM,MAAM,GAAW,KAAK,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAxB,CAAwB,CAAC,CAAC;gBACrE,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;aACtD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAwBO,+BAAS,GAAjB;QACE,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IACH,kBAAC;AAAD,CAAC,AAhED,IAgEC;AAhEY,kCAAW"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AACnC,8BAAgC;AAChC,uBAAyB;AAEzB,IAAM,IAAI,GAAQ,OAAO,CAAC,MAAM,CAAC,CAAC;AA2BlC;IAIE,qBAAoB,KAAyB;QAA7C,iBAiBC;QAhBC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAM,OAAO,GAAiB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC7B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEpB,KAAK,CAAC,OAAO,CAAC,UAAC,IAAsB;YACnC,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gBACtB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC,EAAE,OAAO,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAEa,0BAAc,GAA5B,UAA6B,KAAyB;QACpD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAEa,0BAAc,GAA5B,UAA6B,KAA6B,EAAE,YAA6B;QAA7B,6BAAA,EAAA,qBAA6B;QACvF,IAAM,KAAK,GAAuB,KAAK,CAAC,GAAG,CAAC,UAAC,IAAI;YAC/C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5B,IAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnD,OAAO;gBACL,IAAI,EAAE,GAAG,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;gBAC/D,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,WAAW,EAAE,GAAG,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC5D,QAAQ,EAAE,GAAG,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;gBACtD,KAAK,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE;aAChC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEa,0BAAc,GAA5B,UAA6B,IAAY,EACZ,YAAoB,EACpB,EAAuC;QAClE,OAAO,CAAC,IAAI,EAAE,UAAC,GAAQ,EAAE,KAAe;YACtC,IAAI,GAAG,EAAE;gBACP,MAAM,GAAG,CAAC;aACX;iBAAM;gBACL,IAAM,SAAS,GAA2B,KAAK,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,CAAC;oBAC7D,QAAQ,EAAE,IAAI;oBACd,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;iBAChC,CAAC,EAH4D,CAG5D,CAAC,CAAC;gBACJ,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;aACzD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,+BAAS,GAAjB;QACE,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IACH,kBAAC;AAAD,CAAC,AAjED,IAiEC;AAjEY,kCAAW"}