mathieu/os-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rustdoc-search: case-sensitive only when capitals are used

Browse source 
This is the "smartcase" behavior, described by vim and dtolnay.

(cherry picked from commit 32500aa8e0)
This commit is contained in:
Michael Howell 2024-11-14 11:08:06 -07:00 • committed by Josh Stone
parent 80f109a80a
commit 71ed455958
4 changed files with 55 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/librustdoc/html/static/js/search.js
View file

@ -2098,6 +2098,7 @@ class DocSearch {
const sortResults = async(results, isType, preferredCrate) => {
const userQuery = parsedQuery.userQuery;
const casedUserQuery = parsedQuery.original;
const isMixedCase = casedUserQuery !== userQuery;
const result_list = [];
for (const result of results.values()) {
result.item = this.searchIndex[result.id];
@ -2109,10 +2110,12 @@ class DocSearch {
let a, b;
// sort by exact case-sensitive match
a = (aaa.item.name !== casedUserQuery);
b = (bbb.item.name !== casedUserQuery);
if (a !== b) {
return a - b;
if (isMixedCase) {
a = (aaa.item.name !== casedUserQuery);
b = (bbb.item.name !== casedUserQuery);
if (a !== b) {
return a - b;
}
}
// sort by exact match with regard to the last word (mismatch goes later)

24
tests/rustdoc-js-std/write.js Normal file
View file

@ -0,0 +1,24 @@
const EXPECTED = [
{
'query': 'write',
'others': [
{ 'path': 'std::fmt', 'name': 'write' },
{ 'path': 'std::fs', 'name': 'write' },
{ 'path': 'std::ptr', 'name': 'write' },
{ 'path': 'std::fmt', 'name': 'Write' },
{ 'path': 'std::io', 'name': 'Write' },
{ 'path': 'std::hash::Hasher', 'name': 'write' },
],
},
{
'query': 'Write',
'others': [
{ 'path': 'std::fmt', 'name': 'Write' },
{ 'path': 'std::io', 'name': 'Write' },
{ 'path': 'std::fmt', 'name': 'write' },
{ 'path': 'std::fs', 'name': 'write' },
{ 'path': 'std::ptr', 'name': 'write' },
{ 'path': 'std::hash::Hasher', 'name': 'write' },
],
},
];

17
tests/rustdoc-js/case.js Normal file
View file

@ -0,0 +1,17 @@
const EXPECTED = [
{
'query': 'Foo',
'others': [
{ 'path': 'case', 'name': 'Foo', 'desc': 'Docs for Foo' },
{ 'path': 'case', 'name': 'foo', 'desc': 'Docs for foo' },
],
},
{
'query': 'foo',
'others': [
// https://github.com/rust-lang/rust/issues/133017
{ 'path': 'case', 'name': 'Foo', 'desc': 'Docs for Foo' },
{ 'path': 'case', 'name': 'foo', 'desc': 'Docs for foo' },
],
},
];

7
tests/rustdoc-js/case.rs Normal file
View file

@ -0,0 +1,7 @@
#![allow(nonstandard_style)]
/// Docs for Foo
pub struct Foo;
/// Docs for foo
pub struct foo;