rust-search-extension/extension/main.js

263 lines
No EOL
9.7 KiB
JavaScript

const c = new Compat();
const crateSearcher = new CrateSearch(mapping, crateIndex);
const attributeSearcher = new AttributeSearch(attributesIndex);
const bookSearcher = new BookSearch(booksIndex);
const lintSearcher = new LintSearch(lintsIndex);
const stdSearcher = new StdSearch(searchIndex);
let nightlySearcher = new NightlySearch(NightlyDocManager.getNightlyDocs());
const crateDocSearchManager = new CrateDocSearchManager();
const commandManager = new CommandManager(
new HelpCommand(),
new SimpleCommand('book', 'Show all Rust official books.', commandsIndex['book']),
new SimpleCommand('yet', 'Show all Are We Yet websites.', commandsIndex['yet']),
new SimpleCommand('tool', 'Show some most useful Rust tools.', commandsIndex['tool']),
new SimpleCommand('mirror', 'Show all Rust mirror websites.', commandsIndex['mirror']),
new StableCommand(),
new LabelCommand(labelsIndex),
new HistoryCommand(),
);
const defaultSuggestion = `Search std ${c.match("docs")}, external ${c.match("docs")} (~,@), ${c.match("crates")} (!), ${c.match("attributes")} (#), ${c.match("books")} (%), clippy ${c.match("lints")} (>), and ${c.match("error codes")}, etc in your address bar instantly!`;
const omnibox = new Omnibox(defaultSuggestion, c.omniboxPageSize());
let formatDoc = (index, doc) => {
let description = doc.displayPath + c.match(doc.name);
if (doc.desc) {
description += ` - ${c.dim(c.escape(doc.desc))}`;
}
return {content: doc.href, description};
};
omnibox.bootstrap({
onSearch: (query) => {
return stdSearcher.search(query);
},
onFormat: formatDoc,
onAppend: (query) => {
return [{
content: stdSearcher.getSearchUrl(query),
description: `Search Rust docs ${c.match(query)} on ${settings.isOfflineMode ? "offline mode" : stdSearcher.rootPath}`,
}];
},
beforeNavigate: (query, content) => {
if (content && /^@\w+$/i.test(content.trim())) {
// Case: @crate, redirect to that crate's docs.rs page
return `https://docs.rs/${content.replace("@", "")}`;
} else if (content && /^https?.*\/~\/\*\/.*/ig.test(content)) {
// Sanitize docs url which from all crates doc search mode. (Prefix with "~")
// Here is the url instance: https://docs.rs/~/*/reqwest/fn.get.html
let [_, __, crateName] = new URL(content).pathname.slice(1).split("/");
let crateVersion = CrateDocSearchManager.getCrates()[crateName].version;
return content.replace("/~/", `/${crateName}/`).replace("/*/", `/${crateVersion}/`);
} else {
return content;
}
},
afterNavigated: (query, result) => {
HistoryCommand.record(query, result);
}
});
omnibox.addPrefixQueryEvent("/", {
onSearch: (query) => {
query = query.replace("/", "").trim();
return nightlySearcher.search(query);
},
onFormat: (index, doc) => {
let {content, description} = formatDoc(index, doc);
return {content, description: '[Nightly] ' + description};
},
onAppend: (query) => {
return [{
content: nightlySearcher.getSearchUrl(query),
description: `Search nightly Rust docs ${c.match(query.replace("/", ""))} on ${nightlySearcher.rootPath}`,
}];
},
});
omnibox.addPrefixQueryEvent("~", {
onSearch: (query) => {
return crateDocSearchManager.searchAll(query);
},
onFormat: formatDoc,
});
omnibox.addPrefixQueryEvent("@", {
onSearch: (query) => {
return crateDocSearchManager.search(query);
},
onFormat: (index, item) => {
if (item.hasOwnProperty("content")) {
// 1. Crate list header.
// 2. Crate result footer
return item;
} else if (item.hasOwnProperty("href")) {
return formatDoc(index, item);
} else {
// Crate name list.
let content = `@${item.name}`;
return {
content,
description: `${c.match(content)} v${item.version} - ${c.dim(item.doc)}`,
}
}
},
});
const REDIRECT_URL = chrome.runtime.getURL("redirect.html");
omnibox.addPrefixQueryEvent("!", {
defaultSearch: true,
searchPriority: 1,
onSearch: (query) => {
return crateSearcher.search(query);
},
onFormat: (index, crate, query) => {
let content;
let description;
if (query.startsWith("!!!")) {
content = `${REDIRECT_URL}?crate=${crate.id}`;
description = `${c.capitalize("repository")}: ${c.match(crate.id)} v${crate.version} - ${c.dim(c.escape(crate.description))}`;
} else if (query.startsWith("!!")) {
content = `https://docs.rs/${crate.id}`;
description = `${c.capitalize("docs.rs")}: ${c.match(crate.id)} v${crate.version} - ${c.dim(c.escape(crate.description))}`
} else {
let registry = settings.crateRegistry;
content = `https://${registry}/crates/${crate.id}`;
description = `${c.capitalize(registry)}: ${c.match(crate.id)} v${crate.version} - ${c.dim(c.escape(crate.description))}`
}
return {
content,
description
};
},
onAppend: (query) => {
let keyword = query.replace(/[!\s]/g, "");
let encode = encodeURIComponent(keyword);
let content;
let description;
if (query.startsWith("!!!")) {
content = "https://github.com/search?q=" + encode;
description = "Search Rust crates for " + c.match(keyword) + " on https://github.com";
} else if (query.startsWith("!!")) {
content = "https://docs.rs/releases/search?query=" + encode;
description = "Search Rust crates for " + c.match(keyword) + " on https://docs.rs";
} else {
let registry = settings.crateRegistry;
content = `https://${registry}/search?q=` + encode;
description = "Search Rust crates for " + c.match(keyword) + ` on https://${registry}`;
}
return [{
content,
description
}, {
content: "remind",
description: `Remind: ${c.dim("We only indexed the top 20K crates. Sorry for the inconvenience if your desired crate not show.")}`,
}];
}
});
omnibox.addPrefixQueryEvent("#", {
defaultSearch: true,
searchPriority: 2,
deduplicate: true,
onSearch: (query) => {
return attributeSearcher.search(query);
},
onFormat: (index, attribute) => {
return {
content: attribute.href,
description: `Attribute: ${c.match("#[" + attribute.name + "]")} ${c.dim(attribute.description)}`,
}
}
});
omnibox.addRegexQueryEvent(/`?e\d{2,4}`?$/i, {
onSearch: (query) => {
query = query.replace("`", "");
let baseIndex = parseInt(query.slice(1).padEnd(4, '0'));
let result = [];
for (let index = 0; index < 10; index++) {
let errorIndex = 'E' + String(baseIndex++).padStart(4, "0").toUpperCase();
result.push(errorIndex);
}
return result.map(errorCode => {
return {
content: "https://doc.rust-lang.org/error-index.html#" + errorCode,
description: `Search Rust error index for ${c.match(errorCode)} on https://doc.rust-lang.org/error-index.html`,
};
});
},
});
omnibox.addPrefixQueryEvent("%", {
onSearch: (query) => {
return bookSearcher.search(query);
},
onFormat: (index, page) => {
let parentTitles = page.parentTitles || [];
return {
content: page.url,
description: `${[...parentTitles.map(t => c.escape(t)), c.match(c.escape(page.title))].join(" > ")} - ${c.dim(page.name)}`
}
}
});
const LINT_URL = "https://rust-lang.github.io/rust-clippy/master/";
omnibox.addPrefixQueryEvent(">", {
onSearch: (query) => {
return lintSearcher.search(query);
},
onFormat: (index, lint) => {
return {
content: `${LINT_URL}#${lint.name}`,
description: `Clippy lint: [${lint.level}] ${c.match(lint.name)} - ${c.dim(c.escape(lint.description))}`,
}
},
});
omnibox.addPrefixQueryEvent(":", {
onSearch: (query) => {
return commandManager.execute(query);
},
});
omnibox.addNoCacheQueries("/", "!", "@", ":");
let fileNewIssue = "title=Have you found a bug? Did you feel something was missing?&body=Whatever it was, we'd love to hear from you.";
chrome.runtime.setUninstallURL(
`https://github.com/huhu/rust-search-extension/issues/new?${encodeURI(fileNewIssue)}`
);
chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
switch (message.action) {
// Nightly:* action is exclusive to nightly docs event
case "nightly:add" : {
NightlyDocManager.setNightlyDocs(message.searchIndex);
// New nightlySearcher instance after docs updated
nightlySearcher = new NightlySearch(message.searchIndex);
sendResponse(true);
break;
}
case "check": {
let crates = CrateDocSearchManager.getCrates();
sendResponse(crates[message.crateName]);
break;
}
case "add": {
CrateDocSearchManager.addCrate(message.crateName, message.crateVersion, message.searchIndex);
crateDocSearchManager.initAllCrateSearcher();
sendResponse(true);
break;
}
case "remove": {
CrateDocSearchManager.removeCrate(message.crateName);
crateDocSearchManager.initAllCrateSearcher();
sendResponse(true);
break;
}
}
return true;
});
window.crateSearcher = crateSearcher;