feat: Improved the Native Search Algorithm #1557

ynnelson · 2019-04-24T19:26:30Z

Summary

You can now search tags in addition to H2 and H3 titles as well as the search can now take in multiple words separated by a space.

What kind of change does this PR introduce? (check at least one)

I simply improved the suggestions () method in the SearchBox component to now include tags if they exist in the frontmatter, this is combined with the existing behavior of searching through headers. Also, the other improvement is that you can now do a search based on multiple keywords as opposed to only one previously.

This is a very minor adjustment which I think will satisfy a lot of the issues with the native search and allows the user to make pages show up in the search based on the tags assigned to it.

The only change to the UI was to make the suggestion box search sit 0.5 rem lower on the navbar.

Does this PR introduce a breaking change? (check one)

Yes
No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

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

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

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

* Improved the Native Search Algorithm You can now search tags in addition to H2 and H3 titles as well as the search can now take in multiple words separated by a space. * Took out a console.log * Reflected changes to the SearchBox in the doc

gevera · 2019-05-14T03:25:57Z

This is very helpful. I hope it will get merged soon

Raiondesu · 2019-06-18T10:25:26Z

+1 for this.

ulivz · 2019-06-22T15:13:03Z

Great work, but could you write full tests for it before I decide to approve it?

ynnelson · 2019-07-05T14:22:27Z

Pardon my ignorance but I am not really sure how to write full tests for this... could you point me to another test in the repo, that would be helpful in seeing what I need to write up. Thank you. @ulivz

ynnelson · 2019-09-04T14:13:05Z

If someone could point me to an example on how to write a test for this, I'd happily do it! @ulivz

flozero · 2019-09-05T15:17:49Z

It has been a while since you create the pr !

I will have a look about create tests needed @ynnelson thank's for your work

kefranabg · 2019-09-12T15:27:39Z

@ynnelson What you need to do is setup a vue test environment in the VuePress plugin-search. Let me know if you want some help.

gevera · 2019-11-14T16:05:35Z

Any progress on this feature?

kyle-tightest · 2019-12-03T14:39:48Z

Can someone merge please?

ynnelson · 2019-12-03T14:50:52Z

I resolved the conflict, not sure about how to solve the 1 check that failed.

kyle-tightest · 2019-12-03T15:09:35Z

@ynnelson there seems to be some linting issues on SearchBox.vue: https://circleci.com/gh/vuejs/vuepress/2803?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link

The other check for "Semantic Pull Request" seems to be due to the title.
I think prefixing the pull request with feat: would solve that.

kyle-tightest · 2019-12-05T11:07:09Z

@ynnelson you could also give me write access to your branch and I'll make the required changes.

ynnelson · 2019-12-06T02:43:43Z

@kyle-tightest I added you as a collaborator.

kyle-tightest · 2019-12-06T08:17:03Z

@ynnelson thanks. Can you please change this pull request's title to feat: Improved the Native Search Algorithm? I dont have access to change the title.

ynnelson · 2019-12-06T11:21:35Z

This is ready to be merged i think.

kyle-tightest · 2019-12-06T12:51:06Z

@f3ltron

Royedc4 · 2020-02-27T22:01:05Z

Hey guys this is very relevant, when will this be merged? Cheers!

flozero · 2020-02-27T22:43:21Z

i am gonna ask to them if they can put it for the next release

bencodezen

This is a fantastic update. Thank you for doing this!

sarahdayan · 2020-02-28T14:25:30Z

Hey @ynnelson! As @ulivz said I still think there would be value in testing this. This way, we can fully validate the behavior on our end, and improve the algorithm later on without breaking expectations.

If you extract the logic outside of the component, this should be easy to test. I'm available to help you if you need.

kefranabg · 2020-03-07T11:03:08Z

I just added some tests. One more review and it will be ready to be merged 🎉

sarahdayan

Looks great!

Improved the Native Search Algorithm (#1)

242a01e

* Improved the Native Search Algorithm You can now search tags in addition to H2 and H3 titles as well as the search can now take in multiple words separated by a space. * Took out a console.log * Reflected changes to the SearchBox in the doc

ynnelson mentioned this pull request Apr 24, 2019

Full-text search #68

Closed

Merge branch 'master' into master

553637a

ulivz force-pushed the master branch from d33fe73 to 3f40b48 Compare June 4, 2019 08:19

flozero self-assigned this Sep 5, 2019

flozero added status: core team assigned Core team member assigned type: enhancement Request to enhance an existing feature version: 1.x Relates to version 1 of VuePress labels Sep 5, 2019

Merge branch 'master' into master

4461d40

Fixed linting issues in SearchBox.vue

cfff621

ynnelson changed the title ~~Improved the Native Search Algorithm~~ feat: Improved the Native Search Algorithm Dec 6, 2019

bencodezen self-requested a review February 28, 2020 01:34

bencodezen approved these changes Feb 28, 2020

View reviewed changes

kefranabg added 5 commits March 7, 2020 11:47

feat: improve code readability

87e3d96

feat: add tests for matchQuery

c2154da

feat: remove unecessary changes

6ff56cc

feat: improve code readability

89900d6

docs: add tags section in the frontmatter doc page

eee983e

kefranabg requested a review from sarahdayan March 7, 2020 11:03

sarahdayan approved these changes Mar 7, 2020

View reviewed changes

kefranabg merged commit e9fde5c into vuejs:master Mar 8, 2020

meteorlxy mentioned this pull request Mar 24, 2020

Change search plugin regular expression to support non-latin characters #2242

Closed

matmaxgeds mentioned this pull request Mar 26, 2020

Search a codelist on the code/name/description fields codeforIATI/codelists#12

Closed

zq99299 mentioned this pull request Apr 1, 2020

自带搜索工具不能搜索到中文内容的md #2243

Closed

1 task

meteorlxy mentioned this pull request Apr 6, 2020

fix($plugin-search): match non-ASCII chars (close #2242) #2283

Merged

10 tasks

snyk-bot mentioned this pull request May 1, 2020

[Snyk] Upgrade vuepress from 1.0.2 to 1.4.0 adamlaska/osmos-cosmos-sdk#5

Open

larionov pushed a commit to larionov/vuepress that referenced this pull request Aug 19, 2020

feat($plugin-search): improve the native search algorithm (vuejs#1557)

04fae73

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Improved the Native Search Algorithm #1557

feat: Improved the Native Search Algorithm #1557

ynnelson commented Apr 24, 2019

gevera commented May 14, 2019

Raiondesu commented Jun 18, 2019

ulivz commented Jun 22, 2019 •

edited

Loading

ynnelson commented Jul 5, 2019

ynnelson commented Sep 4, 2019

flozero commented Sep 5, 2019

kefranabg commented Sep 12, 2019 •

edited

Loading

gevera commented Nov 14, 2019

kyle-tightest commented Dec 3, 2019

ynnelson commented Dec 3, 2019

kyle-tightest commented Dec 3, 2019

kyle-tightest commented Dec 5, 2019

ynnelson commented Dec 6, 2019

kyle-tightest commented Dec 6, 2019

ynnelson commented Dec 6, 2019

kyle-tightest commented Dec 6, 2019

Royedc4 commented Feb 27, 2020

flozero commented Feb 27, 2020 •

edited

Loading

bencodezen left a comment

sarahdayan commented Feb 28, 2020

kefranabg commented Mar 7, 2020

sarahdayan left a comment

feat: Improved the Native Search Algorithm #1557

feat: Improved the Native Search Algorithm #1557

Conversation

ynnelson commented Apr 24, 2019

gevera commented May 14, 2019

Raiondesu commented Jun 18, 2019

ulivz commented Jun 22, 2019 • edited Loading

ynnelson commented Jul 5, 2019

ynnelson commented Sep 4, 2019

flozero commented Sep 5, 2019

kefranabg commented Sep 12, 2019 • edited Loading

gevera commented Nov 14, 2019

kyle-tightest commented Dec 3, 2019

ynnelson commented Dec 3, 2019

kyle-tightest commented Dec 3, 2019

kyle-tightest commented Dec 5, 2019

ynnelson commented Dec 6, 2019

kyle-tightest commented Dec 6, 2019

ynnelson commented Dec 6, 2019

kyle-tightest commented Dec 6, 2019

Royedc4 commented Feb 27, 2020

flozero commented Feb 27, 2020 • edited Loading

bencodezen left a comment

Choose a reason for hiding this comment

sarahdayan commented Feb 28, 2020

kefranabg commented Mar 7, 2020

sarahdayan left a comment

Choose a reason for hiding this comment

ulivz commented Jun 22, 2019 •

edited

Loading

kefranabg commented Sep 12, 2019 •

edited

Loading

flozero commented Feb 27, 2020 •

edited

Loading