@vuepress-seach / Searchable paths

[robsontenorio]

Summary

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update
• Refactor
• Docs
• Build-related changes
• Other, please describe:

Does this PR introduce a breaking change?

• Yes
• No

The PR fulfills these requirements:

You have tested in the following browsers: (Providing a detailed version will be better.)

• Chrome (latest)
• Firefox (latest)
• Safari
• Edge
• IE

If adding a new feature, the PR's description includes:

• A convincing reason for adding this feature
• Related documents have been updated
• Related tests have been updated

Other information

searchPaths

• Type: array
• Default: []
  Set the array of searchable paths. Default value (a empty array) will search on all paths. Considering you have this structure:

docs/
├── .vuepress/            
│    └── ...
│
├── 1.0/               
│    └── ...
│
└── 2.0/               
    └── ...                       

You can restrict the searching setting with searchPaths as ['/1.0/']. Otherwise, the default search will return duplications, once you can have similar content between folders /1.0/ and /2.0/.

[matrunchyk]

Please, please, it's very important!

[chrissm79]

This would be 💯

[ulivz]

Thanks for the contribution, but I think that it's best to implement this API as string | RegExp | Array<RegExp> instead of only indexOf check.

[ulivz]

Code here can be simplified as:

isSearchable (page) {
  const searchPaths = SEARCH_PATHS
  // all paths searchables
  if (searchPaths.length === 0) { return true }

  return searchPaths.filter(path => {
    return page.path.indexOf(path) !== -1
  }).length > 0
},

[ulivz]

So I recommend to name this API as test:

• RegExp:

module.exports = {
  plugins: [
    ['@vuepress/search', {
      test: /1\.0/
    }]
  ]
}

• Array<RegExp>:

module.exports = {
  plugins: [
    ['@vuepress/search', {
      test: [ /1\.0/, /2\.0/ ]
    }]
  ]
}

• Function (This can be done in another PR)

module.exports = {
  plugins: [
    ['@vuepress/search', {
      test: (currentPage, pages) => { }
    }]
  ]
}

[robsontenorio]

@ulivz Done!