Fix lint issues; bump version

Author: Leonid Buneev

.eslintrc.js

@@ -2,6 +2,27 @@ module.exports = {
   root: true,
   extends: ['plugin:tyrecheck/recommended'],
   rules: {
+    'md/remark': [
+      'error',
+      {
+        plugins: [
+          'preset-lint-markdown-style-guide',
+          'frontmatter',
+          // Disable rules handled by Prettier
+          ['lint-maximum-line-length', false],
+          ['lint-emphasis-marker', false],
+          ['lint-list-item-indent', false],
+          ['lint-list-item-spacing', false],
+          ['lint-ordered-list-marker-value', false],
+          ['lint-no-consecutive-blank-lines', false],
+          ['lint-table-cell-padding', false],
+          ['lint-link-title-style', false],
+          ['lint-no-shortcut-reference-link', false],
+          ['lint-no-shortcut-reference-link', false],
+          ['lint-no-duplicate-headings', false],
+        ],
+      },
+    ],
     'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
     'no-console': [process.env.NODE_ENV === 'production' ? 'error' : 'off', { allow: ['warn', 'error'] }],
   },

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## 2.2.0 (2021-04-04)
+
+### Added
+
+- Ability to pass-through flexSearch configuration (@echojoshchen in #44)
+
+### Changed
+
+- Fixed #41 - HTML parsing by updating dependency on html-to-text (@echojoshchen in #42)
+- updated dependencies
+
 ## 2.1.0 (2020-10-22)
 
 ### Added

README.md

@@ -116,17 +116,15 @@ async function onGoToSuggestion(index: number, suggestion: Suggestion, queryStri
 
 ### Additional configuration
 
-You can set additional configuration options in the config file. For `tokenize`, `split`, and
-`encode`, see the [flexsearch documentation][flexsearch-options] for more details.
+You can set additional configuration options in the config file. For `tokenize`, `split`, and `encode`, see the
+[flexsearch documentation][flexsearch-options] for more details.
 
-* `tokenize`: The indexing mode (tokenizer). Choose one of the built-ins or pass a custom tokenizer
-  function.
-* `split`: The rule to split words when using non-custom tokenizer (built-ins e.g. "forward"). Use a
-  string/char or use a regular expression (default: `/\W+/`).
-* `encode`: The encoding type. Choose one of the built-ins or pass a custom encoding function.
+- `tokenize`: The indexing mode (tokenizer). Choose one of the built-ins or pass a custom tokenizer function.
+- `split`: The rule to split words when using non-custom tokenizer (built-ins e.g. "forward"). Use a string/char or use
+  a regular expression (default: `/\W+/`).
+- `encode`: The encoding type. Choose one of the built-ins or pass a custom encoding function.
 
-The built-in `searchMaxSuggestions` will be used if set in the
-[theme config][search-max-suggestions].
+The built-in `searchMaxSuggestions` will be used if set in the [theme config][search-max-suggestions].
 
 For example:
 
@@ -144,9 +142,10 @@ module.exports = {
   ],
   themeConfig: {
     searchMaxSuggestions: 10,
-  }
+  },
 }
 ```
 
-[flexsearch-options]: [https://github.com/nextapps-de/flexsearch#initialize-index]
-[search-max-suggestions]: https://vuepress.vuejs.org/theme/default-theme-config.html#built-in-search
+[flexsearch-options][https://github.com/nextapps-de/flexsearch#initialize-index]
+
+[search-max-suggestions][https://vuepress.vuejs.org/theme/default-theme-config.html#built-in-search]

components/SearchBox.vue

@@ -90,7 +90,7 @@ export default {
   },
   /* global OPTIONS */
   mounted() {
-    const options = OPTIONS || {};
+    const options = OPTIONS || {}
     flexsearchSvc.buildIndex(this.$site.pages, options)
     this.placeholder = this.$site.themeConfig.searchPlaceholder || ''
     document.addEventListener('keydown', this.onHotkey)

index.js

@@ -99,7 +99,7 @@ function getCustomTitles(globalCtx) {
     }
     return result
   } catch (e) {
-    console.log('[fulltext-search] Error while getting sidebar paths:', e)
+    console.error('[fulltext-search] Error while getting sidebar paths:', e)
     return {}
   }
 }
@@ -110,7 +110,7 @@ function normalizePath(rawPath) {
     const parsedPath = path.parse(rawPath)
     return path.join(parsedPath.dir, parsedPath.name)
   } catch (e) {
-    console.log(`[fulltext-search] Error while normalizing path ${rawPath}:`, e)
+    console.error(`[fulltext-search] Error while normalizing path ${rawPath}:`, e)
     return null
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vuepress-plugin-fulltext-search",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Adds full-text search capabilities to your vuepress site with a help of flexsearch library.",
   "main": "index.js",
   "repository": "https://github.com/leo-buneev/vuepress-plugin-fulltext-search.git",