feat($plugin-search): searchable paths with test RegExp (#1032)

vuejs · Dec 12, 2018 · d6bddf1 · d6bddf1
1 parent 1ac172c
commit d6bddf1
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 4 deletions.
diff --git a/packages/@vuepress/plugin-search/SearchBox.vue b/packages/@vuepress/plugin-search/SearchBox.vue
@@ -36,7 +36,7 @@
 </template>
 
 <script>
-/* global SEARCH_MAX_SUGGESTIONS */
+/* global SEARCH_MAX_SUGGESTIONS, SEARCH_PATHS */
 export default {
   data () {
     return {
@@ -76,6 +76,12 @@ export default {
         if (this.getPageLocalePath(p) !== localePath) {
           continue
         }
+
+        // filter out results that do not match searchable paths
+        if (!this.isSearchable(p)) {
+          continue
+        }
+
         if (matches(p)) {
           res.push(p)
         } else if (p.headers) {
@@ -112,6 +118,19 @@ export default {
       return '/'
     },
 
+    isSearchable (page) {
+      let searchPaths = SEARCH_PATHS
+
+      // all paths searchables
+      if (searchPaths === null) { return true }
+
+      searchPaths = Array.isArray(searchPaths) ? searchPaths : new Array(searchPaths)
+
+      return searchPaths.filter(path => {
+        return page.path.match(path)
+      }).length > 0
+    },
+
     onUp () {
       if (this.showSuggestions) {
         if (this.focusIndex > 0) {

diff --git a/packages/@vuepress/plugin-search/index.js b/packages/@vuepress/plugin-search/index.js
@@ -6,6 +6,7 @@ module.exports = (options) => ({
       path.resolve(__dirname, 'SearchBox.vue')
   },
   define: {
-    SEARCH_MAX_SUGGESTIONS: options.searchMaxSuggestions || 5
+    SEARCH_MAX_SUGGESTIONS: options.searchMaxSuggestions || 5,
+    SEARCH_PATHS: options.test || null
   }
 })
diff --git a/packages/@vuepress/theme-blog/index.js b/packages/@vuepress/theme-blog/index.js
@@ -4,7 +4,8 @@ module.exports = {
     '@vuepress/pagination',
     '@vuepress/medium-zoom',
     ['@vuepress/search', {
-      searchMaxSuggestions: 10
+      searchMaxSuggestions: 10,
+      test: null
     }]
   ]
 }
diff --git a/packages/docs/docs/plugin/official/plugin-search.md b/packages/docs/docs/plugin/official/plugin-search.md
@@ -27,7 +27,7 @@ Note that this plugin has been included in **default theme**, the search box you
 module.exports = {
   plugins: [
     ['@vuepress/search', {
-      searchMaxSuggestions: 10
+      searchMaxSuggestions: 10      
     }]
   ]
 }
@@ -65,6 +65,36 @@ export default {
 
 Set the maximum number of results for search.
 
+### test
+
+- Type: `RegExp` | `Array<RegExp>`
+- Default: `null`
+
+Set up searchable paths with regular expressions. If no test expression is provided it will search on all paths. Considering you have this structure:
+
+```bash
+docs/
+├── .vuepress/            
+│    └── ...
+│
+├── master/               
+│    └── ...
+│
+├── 1.0/               
+│    └── ...
+│
+└── 2.0/               
+     └── ...                       
+```
+
+You can set up searchable paths with `test` as:
+
+- RegExp: `'/1\.0/'`
+- Array of RegExp: `['/1\.0/', '/2\.0/']`
+
+
+Otherwise,  the default search will return duplicates, once you can have similar content between folders `/master/`, `/1.0/` and `/2.0/`.
+
 ## Tips
 
 ### Tweak the default colors.