Adapted the website search for better matching #6477
Conversation
* Formatting
|
r? @llogiq (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
| @@ -89,7 +89,7 @@ <h1>ALL the Clippy Lints</h1> | |||
| </div> | |||
|
|
|||
| <article class="panel panel-default" id="{{lint.id}}" | |||
| ng-repeat="lint in data | filter:byLevels | filter:byGroups | filter:search | orderBy:'id' track by lint.id" on-finish-render="ngRepeatFinished"> | |||
There was a problem hiding this comment.
I removed the on-finish-render="ngRepeatFinished" as it was restarting the query even though nothing has changed. Changing one of the settings causes the query to be reevaluated automatically.
|
@bors r+ (@llogiq, bors is a bit hard headed and won't listen to you in review comments 🙂)
I think that's a good idea, maybe we could do that in a follow-up PR? Thanks a lot for working on this! |
|
📌 Commit 2814ee4 has been approved by |
|
(oops should have |
|
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
|
Sure, I'm working on another website issue and limiting the search is an easy change. No problem @ebroto. I'm currently really enjoy being a part of this, also thanks to all the work you and the team are doing! |
Website issue tracker link and better search performance This PR implements some improvements to the website: 1. Added a "Search on Github" link to the "Known problems" section (Closes #5386)  <details> <summary>Another mock up I created with the GitHub logo</summary>  </details> 2. Only starting the search after three letters and improving the search performance in general. (Followup #6477) ### Testing These changes can be tested locally by: 1. Clone this branch 2. Download the current lint index from the [gh-pages branch](https://github.com/rust-lang/rust-clippy/blob/gh-pages/master/lints.json) 3. Put it next to the `util/gh-pages/index.html` and open the html file. Make sure that it can load the lint data. (Browsers can be a bit iffy when opening a local html page and loading data) ### Sources for search performance: 1. [A stackoverflow about angular filter performance](https://stackoverflow.com/questions/26876514/optimize-angular-filter-performance) * I selected a search debounce of 50ms that's fast enough to catch fast deletion and typing but responsive enough to not bother the user 2. [A stackoverflow about string comparison speeds](https://stackoverflow.com/questions/5296268/fastest-way-to-check-a-string-contain-another-substring-in-javascript) 3. [JS benchmarks for string search performance (`indexOf` seams to be the best)](https://jsben.ch/9cwLJ) Note: The performance is still a bit poor when going from a specific lint to no search filter. I suspect that angular is recreating all lint items when the filter is cleared causing a major lag spike. The filter functions is at least optimized for little to no search. --- changelog: Added a "Search on GitHub" link to the website
missing-errors-docandmissing errors docare now valid aliases for lint namesdoc sectionfinds two lints in our selectionThis was suggested/discussed on Zulip
Testing
These changes can be tested locally by:
util/gh-pages/index.htmland open the html file. Make sure that it can load the lint data. (Browsers can be a bit iffy when opening a loacl html page and loading data)Note
I found that searching only a few characters (< 3) seams slow and deleting one even more as almost every lint description contains them. This also happens in our current lint list. We could change the search to only be triggered if the search field contains more than 3 letters to slightly improve performance.
changelog: Adapted the website search for better matching