# **{find+}**
[](https://chrome.google.com/webstore/detail/find%2B/fddffkdncgkkdjobemgbpojjeffmmofb)
[](https://addons.mozilla.org/en-US/firefox/addon/brandon1024-find/)
[](https://github.com/brandon1024/find/commits/develop)
**{find+}** is a powerful _find-in-page_ extension for Chrome and Firefox that
allows you to search for content in a web page or document by regular
expression. It is a feature-rich alternative to the native _find-in-page_ tool
built into your browser.
Some notable features:
- match a regular expression against text in a web page
- quickly search for text using the browser omnibox
- find and replace text in a page
- copy occurrences of a regular expression to your clipboard
- store frequently-used patterns
- adjust colours and search settings
## Getting Started
The **{find+}** extension is available through the Chrome Web Store and through
the Firefox Add-ons Store.
Download the extension here: [find+ | Regex Find-in-Page Tool](https://chrome.google.com/webstore/detail/find%2B/fddffkdncgkkdjobemgbpojjeffmmofb).
Download the extension here: [{find+} – Get this Extension for 🦊 Firefox](https://addons.mozilla.org/en-US/firefox/addon/brandon1024-find/).
## Keyboard Shortcuts
In Firefox, you can use CTRL+⇧+F to open the
extension popup.
To open the extension popup in Chrome using a keyboard shortcut, you must first
assign a keyboard shortcut to the extension through the Chrome settings. You can
do this by following these steps:
1. Navigate to the `Extensions` settings page in Chrome, or type
`chrome://extensions/` into the navigation bar.
2. In the top left click on the ☰ menu icon, then click `Keyboard shortcuts`.
3. Locate the shortcut settings for find+. Click the input field located to the
right of the label `Activate the extension`.
4. Press the combination of keys you would like to use, and once complete press
`OK`. We recommend using CTRL+⇧+F, since it
shouldn't conflict with any other browser keyboard shortcut mappings.
When the extension popup is open, there are a number of keyboard shortcuts you
can use. These settings cannot be remapped.
| Windows Shortcut | macOS Shortcut | Action |
| :------------------------------------------------- | :------------------------------------------------- | :--------------------------------------------------------------------- |
| ↵ | ↵ | Advance to the next occurrence of the regular expression in the page |
| ⇧+↵ | ⇧+↵ | Return to the previous occurrence of the regular expression in the page|
| CTRL+⇧+↵ | ^+⇧+↵ | Follow the first highlighted link in the current occurrence focus |
| CTRL+ALT+C | ^+⌥+C | Copy to the clipboard the currently highlighted text on the page. |
| CTRL+ALT+A | ^+⌥+A | Copy to the clipboard the all highlighted text on the page. |
| CTRL+ALT+O | ^+⌥+O | Expand or Collapse Options Pane |
| CTRL+ALT+R | ^+⌥+R | Expand or Collapse Replace Text Pane |
| CTRL+ALT+H | ^+⌥+H | Expand or Collapse Saved Expressions Pane |
| CTRL+↵ or ESC | ^+↵ or ESC | Close the extension popup |
## Omnibox Support
In version 1.4.0, we introduced omnibox support! This allows you to highlight
text on a page without even opening the extension. To use this feature, type
`findplus` in your browser's address bar, press ␣ or ⇥,
and then enter a regular expression. Occurrences of the regular expression will
become highlighted on the page as you type.
Pressing `ENTER` will leave the highlights in the page. To remove the
highlights, simply refresh the page. If you don't want to leave the highlights
in the page, just erase the text entered in the address bar.
## Contributing
We can use your help! Our [CONTRIBUTING](CONTRIBUTING.md) doc should help get
you started.
## Contributors
[
](https://github.com/brandon1024) [
](https://github.com/MichaelWalz) [
](https://github.com/muescha) [
](https://github.com/amit-gshe) [
](https://github.com/ReporterX) [
](https://github.com/pzhlkj6612)
## License
This project is licensed under the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
================================================
FILE: _locales/en/messages.json
================================================
{
"extension_name": {
"message": "find+ | Regex Find-in-Page Tool",
"description": "The extension name in the manifest file."
},
"extension_description": {
"message": "A find-in-page extension with support for regular expressions.",
"description": "Short description of the extension in the manifest file."
},
"search_field_title": {
"message": "Search Field",
"description": "Tooltip text for the search field."
},
"malformed_regex_error_title": {
"message": "Malformed Regex:\nThe regular expression entered is not acceptable, as it is either an invalid regular expression, or not supported according to the Javascript RegExp specification",
"description": "Tooltip text for the invalid regex icon."
},
"clipboard_copy_error_title": {
"message": "Unable to copy to the clipboard due to unexpected error.",
"description": "Tooltip text for the clipboard copy error icon."
},
"iframes_found_warning_title": {
"message": "One or more iframes were encountered in the page. As a result, some occurrences of your search query may not be highlighted in the page.",
"description": "Tooltip text for the iframes encountered warning icon."
},
"clipboard_copy_title": {
"message": "Regex occurrence copied to clipboard.",
"description": "Tooltip text for the clipboard copy successful icon."
},
"installation_information_title": {
"message": "Welcome and thanks for installing our extension! Here are some tips to get you started:\n\tENTER : Advance to the next occurrence of the regular expression in the page\n\tSHIFT-ENTER : Return to the previous occurrence of the regular expression in the page\n\tCTRL-ALT-O : Expand or Collapse Options Pane\n\tCTRL-ALT-R : Expand or Collapse Replace Text Pane\n\tCTRL-ENTER or ESC : Close the extension popup",
"description": "Tooltip text for the install information icon."
},
"update_information_title": {
"message": "We just updated the extension! Now it works better than ever :)\nCheck out our GitHub page for information about this update!",
"description": "Tooltip text for the update information icon."
},
"search_prev_title": {
"message": "Previous",
"description": "Tooltip text for the seek backwards button."
},
"search_next_title": {
"message": "Next",
"description": "Tooltip text for the seek forwards button."
},
"toggle_options_pane_title": {
"message": "Toggle Options Pane",
"description": "Tooltip text for the toggle options pane button."
},
"toggle_saved_expressions_button": {
"message": "Show Saved Expressions",
"description": "Tooltip text for the show saved expressions button."
},
"copy_to_clipboard_button_title": {
"message": "Copy All Occurrences To Clipboard",
"description": "Tooltip text for the copy to clipboard button."
},
"toggle_find_replace_button_title": {
"message": "Find and Replace",
"description": "Tooltip text for the find and replace toggle button."
},
"close_extension_title": {
"message": "Close find+",
"description": "Tooltip text for the close extension button."
},
"replace_field_title": {
"message": "Replace Field",
"description": "Tooltip text for the replace field."
},
"replace_button_title": {
"message": "Replace Next",
"description": "Tooltip text for the replace next button."
},
"replace_all_button_title": {
"message": "Replace All",
"description": "Tooltip text for the replace all button."
},
"search_option_find_by_regex_title": {
"message": "If enabled, text entered in the search field will be treated as a regular expression.\nIf disabled, the text is treated as string literal.",
"description": "Tooltip text for the find by regex option description icon."
},
"search_option_match_case_title": {
"message": "If enabled, the case of characters must match that of the query string.\nIf disabled, the case of characters in the query string are not considered.",
"description": "Tooltip text for the match case option description icon."
},
"search_option_persistent_highlights_title": {
"message": "If enabled, highlights in the web page will remain after the extension closes.\nRemove the highlights by reloading the page or reopening the extension.",
"description": "Tooltip text for the persistent highlights option description icon."
},
"extension_option_persistent_storage_incognito_title": {
"message": "If enabled, searches and options will be persisted in regular and incognito sessions.\nIf disabled, no session information will be saved while incognito.",
"description": "Tooltip text for the persistent storage incognito option description icon."
},
"extension_option_hide_option_pane_toggle_button_title": {
"message": "If enabled, the button used to toggle the option pane will be hidden.\nThe keyboard shortcuts may still be used to display or hide the pane.",
"description": "Tooltip text for the hide option pane toggle button option description icon."
},
"extension_option_hide_saved_expressions_pane_toggle_button_title": {
"message": "If enabled, the button used to toggle the saved expressions pane will be hidden.\nThe keyboard shortcuts may still be used to display or hide the pane.",
"description": "Tooltip text for the hide saved expressions pane toggle button option description icon."
},
"extension_option_hide_copy_to_clipboard_toggle_button_title": {
"message": "If enabled, the button used to copy all occurrences to clipboard will be hidden.\nThe keyboard shortcuts may still be used to copy all occurrences to clipboard.",
"description": "Tooltip text for the copy all occurrences to clipboard button option description icon."
},
"extension_option_hide_find_replace_toggle_button_title": {
"message": "If enabled, the button used to toggle the Find and Replace pane will be hidden.\nThe keyboard shortcuts may still be used to display or hide the pane.",
"description": "Tooltip text for the hide find and replace pane toggle button option description icon."
},
"saved_expression_icon_title": {
"message": "Load this expression",
"description": "Tooltip text for a saved expression entry icon."
},
"delete_saved_expression_icon_title": {
"message": "Delete this expression",
"description": "Tooltip text for a delete saved expression entry icon."
},
"clear_expressions_button_title": {
"message": "Clear All Saved Expressions",
"description": "Tooltip text for the clear saved expressions button."
},
"save_expression_button_title": {
"message": "Save Expression in Search Field",
"description": "Tooltip text for the save expression button."
},
"replace_field_placeholder": {
"message": "Replace with..",
"description": "Placeholder text for the replace field."
},
"replace_button_text": {
"message": "Replace",
"description": "Text displayed inside the replace button."
},
"replace_all_button_text": {
"message": "Replace All",
"description": "Text displayed inside the replace all button."
},
"extension_limitation_internal_restricted_browser_page_text": {
"message": "Oops! It appears you are trying to use the extension in a restricted internal browser page. Browser developers have blocked extensions from executing here to prevent the malicious injection of code. This is a security limitation across all browser extensions.",
"description": "Text displayed in the message pane when the extension is used in an internal restrcited browser page."
},
"extension_limitation_pdf_text": {
"message": "Oops! It appears you are trying to use the extension in a PDF document. Unfortunately, due to the complexity of the PDF viewer our extension is not able to handle searching through a PDF. We recommend using the native tool instead.",
"description": "Text displayed in the message pane when the extension is used in a PDF."
},
"extension_limitation_offline_file_text": {
"message": "Something went wrong internally while trying to search this offline file. Luckily, we might know how to fix this. Navigate to 'chrome://extensions' and locate the checkbox 'Allow access to file URLs' in the 'Details' page of the {find+} extension.",
"description": "Text displayed in the message pane when the extension is used in an offline file without adequate permissions for parsing file contents."
},
"search_options_header_text": {
"message": "Expression Options",
"description": "Header text displayed in the options pane."
},
"extension_options_header_text": {
"message": "Extension Options",
"description": "Header text displayed in the options pane."
},
"saved_expressions_body_header": {
"message": "Saved Expressions",
"description": "Header text displayed in the saved expressions pane."
},
"search_option_find_by_regex_text": {
"message": "Find by Regular Expression",
"description": "Text displayed beside the find by regex option."
},
"search_option_match_case_text": {
"message": "Match Case",
"description": "Text displayed beside the match case option."
},
"search_option_persistent_highlights_text": {
"message": "Persistent Highlights",
"description": "Text displayed beside the persistent highlights option."
},
"extension_option_persistent_storage_incognito_text": {
"message": "Persistent Storage (Incognito)",
"description": "Text displayed beside the persistent storage option."
},
"extension_option_hide_option_pane_toggle_button_text": {
"message": "Hide Option Pane Toggle Button",
"description": "Text displayed beside the hide option pane toggle button option."
},
"extension_option_hide_saved_expressions_pane_toggle_button_text": {
"message": "Hide Saved Expressions Pane Toggle Button",
"description": "Text displayed beside the hide saved expressions pane toggle button option."
},
"extension_option_hide_copy_to_clipboard_toggle_button_text": {
"message": "Hide Copy To Clipboard Button",
"description": "Text displayed beside the hide copy to clipboard toggle button option."
},
"extension_option_hide_find_replace_toggle_button_text": {
"message": "Hide Find and Replace Pane Toggle Button",
"description": "Text displayed beside the hide find and replace toggle button option."
},
"search_option_max_results_text": {
"message": "Max Highlighted Results",
"description": "Text displayed above the max highlighted results option."
},
"search_option_index_highlight_text": {
"message": "Selected Occurrence Highlight Color",
"description": "Text displayed above the index highlight color option."
},
"search_option_all_highlight_text": {
"message": "Highlight Color",
"description": "Text displayed above the all highlight color option."
},
"reset_options_button_text": {
"message": "Reset All Options",
"description": "Text displayed in the reset options button."
},
"no_expressions_found_text": {
"message": "No saved expressions found.",
"description": "Text displayed in the saved expressions pane when no expressions exist."
},
"clear_expressions_button_text":{
"message": "Clear Saved Expressions",
"description": "Text displayed in the saved expressions pane."
},
"save_expression_button_text":{
"message": "Save Expression",
"description": "Text displayed in the saved expressions pane."
},
"contextmenu_show_help_title": {
"message": "Show Help",
"description": "Text displayed inside the show-help button in the context menu."
}
}
================================================
FILE: _locales/zh/messages.json
================================================
{
"extension_name": {
"message": "find+ | 正则页内查找工具",
"description": "The extension name in the manifest file."
},
"extension_description": {
"message": "一个支持正则表达式查找的扩展程序",
"description": "Short description of the extension in the manifest file."
},
"search_field_title": {
"message": "表达式",
"description": "Tooltip text for the search field."
},
"malformed_regex_error_title": {
"message": "表达式错误：\n可能输入了不符合 JavaScript 规范的正则表达式。",
"description": "Tooltip text for the invalid regex icon."
},
"clipboard_copy_error_title": {
"message": "未知错误，无法复制到剪贴板。",
"description": "Tooltip text for the clipboard copy error icon."
},
"iframes_found_warning_title": {
"message": "由于该页面包含 iframe，页面上的某些内容将被忽略从而没有高亮。",
"description": "Tooltip text for the iframes encountered warning icon."
},
"clipboard_copy_title": {
"message": "匹配项已复制到剪贴板。",
"description": "Tooltip text for the clipboard copy successful icon."
},
"installation_information_title": {
"message": "欢迎！感谢您安装我们的扩展程序。这里是一些提示：\n\tENTER：查看页面中的下一个匹配项\n\tSHIFT-ENTER：查看页面中的上一个匹配项\n\tCTRL-ALT-O：显示或隐藏“设置”面板\n\tCTRL-ALT-R：显示或隐藏“查找并替换”面板\n\tCTRL-ENTER 或 ESC：关闭本窗口",
"description": "Tooltip text for the install information icon."
},
"update_information_title": {
"message": "我们刚刚更新了这个扩展程序！现在它更好用了 :)\n请访问我们的 GitHub 页面了解本次更新的详细信息！",
"description": "Tooltip text for the update information icon."
},
"search_prev_title": {
"message": "上一个",
"description": "Tooltip text for the seek backwards button."
},
"search_next_title": {
"message": "下一个",
"description": "Tooltip text for the seek forwards button."
},
"toggle_options_pane_title": {
"message": "设置",
"description": "Tooltip text for the toggle options pane button."
},
"toggle_saved_expressions_button": {
"message": "保存的表达式",
"description": "Tooltip text for the show saved expressions button."
},
"copy_to_clipboard_button_title": {
"message": "复制到剪贴板",
"description": "Tooltip text for the copy to clipboard button."
},
"toggle_find_replace_button_title": {
"message": "查找并替换",
"description": "Tooltip text for the find and replace toggle button."
},
"close_extension_title": {
"message": "关闭 find+",
"description": "Tooltip text for the close extension button."
},
"replace_field_title": {
"message": "替换文本",
"description": "Tooltip text for the replace field."
},
"replace_button_title": {
"message": "替换下一个匹配项",
"description": "Tooltip text for the replace next button."
},
"replace_all_button_title": {
"message": "替换所有匹配项",
"description": "Tooltip text for the replace all button."
},
"search_option_find_by_regex_title": {
"message": "若启用，将“表达式”视为正则表达式；\n若禁用，则视为普通文本。",
"description": "Tooltip text for the find by regex option description icon."
},
"search_option_match_case_title": {
"message": "若启用，“表达式”大小写敏感；\n若禁用，则忽略大小写。",
"description": "Tooltip text for the match case option description icon."
},
"search_option_persistent_highlights_title": {
"message": "若启用，关闭本窗口后仍然显示高亮。\n要移除高亮，刷新页面或重新打开本扩展程序",
"description": "Tooltip text for the persistent highlights option description icon."
},
"extension_option_persistent_storage_incognito_title": {
"message": "若启用，本扩展程序的设置和已保存的表达式将由常规浏览和无痕浏览共享；\n若禁用，在无痕浏览时所作的任何修改均不会保留",
"description": "Tooltip text for the persistent storage incognito option description icon."
},
"extension_option_hide_option_pane_toggle_button_title": {
"message": "若启用，将隐藏顶部的“设置”面板切换按钮。\n仍可使用快捷键显示或隐藏该面板。",
"description": "Tooltip text for the hide option pane toggle button option description icon."
},
"extension_option_hide_saved_expressions_pane_toggle_button_title": {
"message": "若启用，将隐藏顶部的“保存的表达式”面板切换按钮。\n仍可使用快捷键显示或隐藏该面板。",
"description": "Tooltip text for the hide saved expressions pane toggle button option description icon."
},
"extension_option_hide_copy_to_clipboard_toggle_button_title": {
"message": "若启用，将隐藏顶部的“复制到剪贴板”按钮。\n仍可使用快捷键复制所有匹配项到剪贴板。",
"description": "Tooltip text for the copy all occurrences to clipboard button option description icon."
},
"extension_option_hide_find_replace_toggle_button_title": {
"message": "若启用，将隐藏顶部的“查找并替换”面板切换按钮。\n仍可使用快捷键显示或隐藏该面板。",
"description": "Tooltip text for the hide find and replace pane toggle button option description icon."
},
"saved_expression_icon_title": {
"message": "使用该表达式",
"description": "Tooltip text for a saved expression entry icon."
},
"delete_saved_expression_icon_title": {
"message": "删除该表达式",
"description": "Tooltip text for a delete saved expression entry icon."
},
"clear_expressions_button_title": {
"message": "清空已保存的表达式",
"description": "Tooltip text for the clear saved expressions button."
},
"save_expression_button_title": {
"message": "保存当前表达式",
"description": "Tooltip text for the save expression button."
},
"replace_field_placeholder": {
"message": "替换为…",
"description": "Placeholder text for the replace field."
},
"replace_button_text": {
"message": "替换",
"description": "Text displayed inside the replace button."
},
"replace_all_button_text": {
"message": "全部替换",
"description": "Text displayed inside the replace all button."
},
"extension_limitation_internal_restricted_browser_page_text": {
"message": "哎呀！您似乎正在浏览器内部页面或某些受限制的页面中使用本扩展程序。为避免遭受恶意代码的攻击，浏览器开发者对所有的扩展程序都施加了安全限制，因此本扩展程序无法在该页面运行。",
"description": "Text displayed in the message pane when the extension is used in an internal restrcited browser page."
},
"extension_limitation_pdf_text": {
"message": "哎呀！您似乎正在 PDF 文档中使用本扩展程序。由于浏览器的内置阅读器比较复杂，很遗憾，我们无法进行查找，建议改用专门的 PDF 阅读器",
"description": "Text displayed in the message pane when the extension is used in a PDF."
},
"extension_limitation_offline_file_text": {
"message": "在离线文件中查找时出现错误，请按下列步骤操作：访问“chrome://extensions”，进入 find+ 扩展程序的详情页，勾选“允许访问文件网址”复选框。",
"description": "Text displayed in the message pane when the extension is used in an offline file without adequate permissions for parsing file contents."
},
"search_options_header_text": {
"message": "表达式设置",
"description": "Header text displayed in the options pane."
},
"extension_options_header_text": {
"message": "扩展程序设置",
"description": "Header text displayed in the options pane."
},
"saved_expressions_body_header": {
"message": "保存的表达式",
"description": "Header text displayed in the saved expressions pane."
},
"search_option_find_by_regex_text": {
"message": "正则表达式",
"description": "Text displayed beside the find by regex option."
},
"search_option_match_case_text": {
"message": "匹配大小写",
"description": "Text displayed beside the match case option."
},
"search_option_persistent_highlights_text": {
"message": "保持高亮",
"description": "Text displayed beside the persistent highlights option."
},
"extension_option_persistent_storage_incognito_text": {
"message": "存储持久化（无痕浏览）",
"description": "Text displayed beside the persistent storage option."
},
"extension_option_hide_option_pane_toggle_button_text": {
"message": "隐藏“设置”按钮",
"description": "Text displayed beside the hide option pane toggle button option."
},
"extension_option_hide_saved_expressions_pane_toggle_button_text": {
"message": "隐藏“保存的表达式”按钮",
"description": "Text displayed beside the hide saved expressions pane toggle button option."
},
"extension_option_hide_copy_to_clipboard_toggle_button_text": {
"message": "隐藏“复制到剪贴板”按钮",
"description": "Text displayed beside the hide copy to clipboard toggle button option."
},
"extension_option_hide_find_replace_toggle_button_text": {
"message": "隐藏“查找并替换”按钮",
"description": "Text displayed beside the hide find and replace toggle button option."
},
"search_option_max_results_text": {
"message": "最大高亮数量",
"description": "Text displayed above the max highlighted results option."
},
"search_option_index_highlight_text": {
"message": "选中项的高亮颜色",
"description": "Text displayed above the index highlight color option."
},
"search_option_all_highlight_text": {
"message": "高亮颜色",
"description": "Text displayed above the all highlight color option."
},
"reset_options_button_text": {
"message": "重置所有设置",
"description": "Text displayed in the reset options button."
},
"no_expressions_found_text": {
"message": "表达式为空",
"description": "Text displayed in the saved expressions pane when no expressions exist."
},
"clear_expressions_button_text":{
"message": "清空表达式",
"description": "Text displayed in the saved expressions pane."
},
"save_expression_button_text":{
"message": "保存表达式",
"description": "Text displayed in the saved expressions pane."
},
"contextmenu_show_help_title": {
"message": "显示帮助（英语）",
"description": "Text displayed inside the show-help button in the context menu."
}
}
================================================
FILE: app.js
================================================
'use strict';
/**
* Micro-framework specifically built for the find+ browser extension.
*
* This design was inspired from Stoyan Stefanov's nested namespace pattern outlined in
* his book JavaScript Patterns.
* */
const Find = (function () {
const self = {};
self.browserId = (() => {
return typeof browser !== 'undefined' ? 'Firefox' : 'Chrome';
})();
self.browser = (() => {
return typeof chrome === 'undefined' ? browser : chrome;
})();
self.incognito = (() => {
return self.browser.extension.inIncognitoContext;
})();
/**
* Register a new namespace, and initialize it using a callback function.
*
* The callback function is invoked with the new namespace as an argument. This argument
* must be used in the callback to initialize the namespace.
*
* Once the namespace is initialized using the callback function, if the namespace contains
* an init() function, it will be invoked once the DOM is ready. This avoids the need to use
* window.onload or attach window load event listeners manually. As such, the init function may be used
* to safely register all DOM component listeners and start or initialize the application.
*
* Intermediate namespaces are created if necessary. For example, the namespace 'Popup.Storage.'
* would allow you to reference this namespace through Find.Popup.Storage.
*
* @param {string} path - The namespace path.
* @param {registerCallback} callback - A function that initializes the namespace.
* @return the namespace
* */
self.register = function(path, callback) {
let pathKeys = path.split('.');
let parent = self;
for(let keyIndex = 0; keyIndex < pathKeys.length; keyIndex++) {
let key = pathKeys[keyIndex];
if(typeof parent[key] === 'undefined') {
parent[key] = {};
}
parent = parent[key];
}
callback(parent);
if(parent && isFunction(parent.init)) {
if(document.readyState === 'complete') {
parent.init();
} else {
window.addEventListener('load', () => {
parent.init();
}, { once: true });
}
}
return parent;
};
/**
* Retrieve a given namespace using a string path.
*
* @param {string} path - The namespace path.
* @return the namespace.
* */
self.getContext = function(path) {
let pathKeys = path.split('.');
let parent = self;
for(let keyIndex = 0; keyIndex < pathKeys.length; keyIndex++) {
let key = pathKeys[keyIndex];
if(typeof parent[key] === 'undefined') {
return undefined;
}
parent = parent[key];
}
return parent;
};
/**
* Determine if a given object is an invokable function.
*
* @private
* @param {object} obj - The object in question
* @return boolean true if the object is a function, false otherwise
* */
function isFunction(obj) {
return !!(obj && obj.constructor && obj.call && obj.apply);
}
return self;
})();
================================================
FILE: background/background.js
================================================
"use strict";
/**
* Create the Background namespace. The background coordinates activities between the browser
* action popup and the content in the web page. The background keeps track of the state of the
* search, along with other necessary data to seek, replace, and perform other actions efficiently.
* */
Find.register("Background", function(self) {
/**
* Allocated on the namespace to allow the BrowserActionProxy to communicate installation
* details to the browser action popup if the extension was recently installed or updated.
* */
self.installationDetails = null;
self.options = null;
let documentRepresentation = null;
let regexOccurrenceMap = null;
let index = null;
Find.browser.contextMenus.removeAll(() => {
Find.browser.contextMenus.create({
title: Find.browser.i18n.getMessage("contextmenu_show_help_title"),
contexts: [(Find.browserId !== 'Firefox') ? "action" : "browser_action"],
id: 'show-help'
});
Find.browser.contextMenus.onClicked.addListener((info) => {
if(info.menuItemId === 'show-help') {
Find.browser.tabs.create({url: Find.browser.runtime.getURL("docs/index.html")});
}
});
});
/**
* Inject content scripts into pages once installed (not performed automatically in Chrome).
*/
Find.browser.runtime.onInstalled.addListener((installation) => {
self.installationDetails = installation;
if(Find.browserId !== 'Firefox') {
let scripts = Find.browser.runtime.getManifest().content_scripts[0].js;
Find.browser.tabs.query({}, (tabs) => {
for(let tabIndex = 0; tabIndex < tabs.length; tabIndex++) {
let url = tabs[tabIndex].url;
// Without the "tabs" permission, browser's internal webpage (e.g., "chrome://" or "chrome-extension://") has no "url"
if(!url
|| url.match(/^https:\/\/chrome\.google\.com\/webstore\/.*/)
|| url.match(/^https:\/\/chromewebstore\.google\.com\/.*/)
|| url.match(/^https:\/\/microsoftedge\.microsoft\.com\/.*/)) {
continue;
}
Find.Background.ContentProxy.executeScript(tabs[tabIndex], {files: scripts});
}
});
}
if(installation.reason === 'install') {
Find.browser.tabs.create({url: Find.browser.runtime.getURL("docs/index.html")});
}
});
/**
* Initialize the browser action. Fetches the web page to ensure that the content scripts
* have been properly injected. If the content script responds, the selected text is retrieved
* from the page and included in the response to the popup.
*
* If the content script still has state variables, such as the index and regex of the last search,
* this information is used to initialize the extension.
*
* @param {object} message - The message containing the details about the action.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.initializeBrowserAction = function(message, tab, sendResponse) {
let resp = {};
resp.activeTab = tab;
Find.Background.ContentProxy.fetch(tab, (response) => {
resp.isReachable = response && response.success;
if(resp.isReachable) {
resp.selectedText = response.selection;
resp.regex = response.regex;
resp.iframes = response.iframes;
index = response.index || 0;
}
sendResponse({action: 'browser_action_init', response: resp});
});
};
/**
* Initialize the extension by constructing the page document representation.
*
* @param {object} tab - Information about the active tab in the current window.
* @param {function} callback - Optional callback .
* */
self.initializePage = function(tab, callback) {
Find.Background.ContentProxy.buildDocumentRepresentation(tab, (model) => {
documentRepresentation = model;
if (callback) {
callback();
}
});
};
/**
* Remove any highlights and markup from the active tab in the current window. Also resets
* any state variables, such as the current index, document representation and occurrence map.
*
* @param {object} tab - Information about the active tab in the current window.
* @param {boolean} [restoreHighlights] - If undefined or true, remove highlights. If false,
* highlights are not removed, and are persisted in the page.
* */
self.restorePageState = function(tab, restoreHighlights) {
if(restoreHighlights === undefined || restoreHighlights) {
Find.Background.ContentProxy.clearPageHighlights(tab);
}
let uuids = getUUIDsFromModelObject(documentRepresentation);
Find.Background.ContentProxy.restoreWebPage(tab, uuids);
documentRepresentation = null;
regexOccurrenceMap = null;
index = null;
};
/**
* Update the search when the search query or search options change. Builds a new occurrence map from the
* documentRepresentation object, highlight the occurrence in the page, and send the indices
* to the browser action popup through the sendResponse function.
*
* If the background has not been initialized properly (documentRepresentation is null), simply returns.
*
* If the regex is invalid, removes all highlights from the page and sends appropriate response
* to the popup.
*
* @param {object} message - The message containing the details about the search, including the search
* options and search query.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.updateSearch = function(message, tab, sendResponse) {
try {
if(!documentRepresentation) {
self.initializePage(tab, () => {
self.updateSearch(message, tab, sendResponse);
});
return;
}
self.options = message.options;
let regex = message.regex;
//If searching by string, escape all regex metacharacters
if(!self.options.find_by_regex) {
regex = regex.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&');
}
//Ensure non-empty search
if(regex.length === 0) {
sendResponse({action: 'empty_regex'});
Find.Background.ContentProxy.clearPageHighlights(tab);
return;
}
//Build occurrence map, reposition index if necessary
regexOccurrenceMap = buildOccurrenceMap(documentRepresentation, regex, self.options);
if(index > regexOccurrenceMap.length-1) {
if(regexOccurrenceMap.length !== 0) {
index = regexOccurrenceMap.length - 1;
} else {
index = 0;
}
}
if(self.options.max_results !== 0 && index >= self.options.max_results) {
index = self.options.max_results - 1;
}
//Invoke update action
Find.Background.ContentProxy.updatePageHighlights(tab, regex, index, regexOccurrenceMap, self.options);
//If occurrence map empty, viewable index is zero
let viewableIndex = index + 1;
if(regexOccurrenceMap.length === 0) {
viewableIndex = 0;
}
//if occurrence map larger than max results, viewable total is max results
let viewableTotal = regexOccurrenceMap.length;
if(self.options.max_results !== 0 && self.options.max_results <= regexOccurrenceMap.length) {
viewableTotal = self.options.max_results;
}
sendResponse({
action: 'index_update',
index: viewableIndex,
total: viewableTotal
});
} catch(e) {
sendResponse({action: 'invalid_regex', error: e.message});
Find.Background.ContentProxy.clearPageHighlights(tab);
}
};
/**
* Move forward or backward the current search index, and respond to the popup
* the new search index.
*
* @param {object} message - The message containing the details about the search options.
* @param {boolean} seekForward - Specifies whether to seek forward or backward.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.seekSearch = function(message, seekForward, tab, sendResponse) {
self.options= message.options;
let indexCap = self.options.max_results !== 0;
//If reached end, reset index
if(seekForward) {
index = computeSubsequentIndex(index, regexOccurrenceMap, self.options);
} else {
index = computePrecedingIndex(index, regexOccurrenceMap, self.options);
}
//Invoke seek action
Find.Background.ContentProxy.seekHighlight(tab, index, self.options);
let viewableIndex = regexOccurrenceMap.length === 0 ? 0 : index+1;
let viewableTotal = (indexCap && self.options.max_results <= regexOccurrenceMap.length) ?
self.options.max_results : regexOccurrenceMap.length;
sendResponse({
action: 'index_update',
index: viewableIndex,
total: viewableTotal
});
};
/**
* Replace the occurrence of the search query with a given replacement string, and invalidate the search
* state.
*
* @param {object} message - The message containing the details about the action, including the index to
* replace, the replacement string, and the search options.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.replaceNext = function(message, tab, sendResponse) {
Find.Background.ContentProxy.replaceOccurrence(tab, message.index - 1, message.replaceWith, message.options);
//Restore Web Page
Find.Background.ContentProxy.clearPageHighlights(tab);
let uuids = getUUIDsFromModelObject(documentRepresentation);
Find.Background.ContentProxy.restoreWebPage(tab, uuids, () => {
//Rebuild documentRepresentation and invalidate
Find.Background.ContentProxy.buildDocumentRepresentation(tab, (model) => {
documentRepresentation = model;
sendResponse({action: 'invalidate'});
});
});
};
/**
* Replace all occurrences of the search query with a given replacement string, and invalidate the search
* state.
*
* @param {object} message - The message containing the details about the action, the replacement string,
* and the search options.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.replaceAll = function(message, tab, sendResponse) {
Find.Background.ContentProxy.replaceAllOccurrences(tab, message.replaceWith, message.options);
//Restore Web Page
Find.Background.ContentProxy.clearPageHighlights(tab);
let uuids = getUUIDsFromModelObject(documentRepresentation);
Find.Background.ContentProxy.restoreWebPage(tab, uuids, () => {
//Rebuild documentRepresentation and invalidate
Find.Background.ContentProxy.buildDocumentRepresentation(tab, (model) => {
documentRepresentation = model;
sendResponse({action: 'invalidate'});
});
});
};
/**
* Follow the link at the current occurrence index in the page.
*
* @param {object} message - The message containing the details about the action.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.followLinkUnderFocus = function(message, tab, sendResponse) {
Find.Background.ContentProxy.followLinkUnderFocus(tab);
sendResponse({action: 'close'});
};
/**
* Extract from the regex occurrence map the current or all occurrences of the search query
* and respond to the popup. Used to allow the occurrences to be copied to the clipboard.
*
* If the cardinality is 'all', a line feed separated string of occurrences is returned.
* Otherwise, only the current occurrence is returned.
*
* @param {object} message - The message containing the details about the action.
* @param {object} tab - Information about the active tab in the current window.
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
self.extractOccurrences = function(message, tab, sendResponse) {
let cardinality = message.options.cardinality;
let resp;
if(cardinality === 'all') {
let occurrences = [];
for(let occIndex = 0; occIndex < regexOccurrenceMap.length; occIndex++) {
occurrences.push(regexOccurrenceMap.occurrenceIndexMap[occIndex].occurrence);
}
resp = occurrences.join('\n');
} else {
resp = regexOccurrenceMap.occurrenceIndexMap[index].occurrence;
}
sendResponse({action: 'get_occurrence', response: resp});
};
/**
* Construct an occurrence map object from a document representation and regular expression.
* The occurrence map is used to map occurrences of a given regex to nodes in the DOM.
*
* The occurrence map will have the following format:
* {
* occurrenceIndexMap: {
* 1: {
* groupIndex: _index to the parent group of this occurrence_,
* subIndex: _the occurrence subindex of the parent group_,
* occurrence: _the matched text_
* }, ...
* },
* length: _number of occurrences of the regex_,
* groups: _number of occurrence groups_,
* 1: {
* uuids: [...],
* count: _number of matches in this group_,
* preformated: _whether or not the text node in the DOM is preformatted_
* }, ...
* }
*
* @private
* @param {object} documentRepresentation - The representation of the page's DOM
* @param {string} regex - A regular expression
* @param {object} options - Options used to alter the creation of the occurrence map.
* @return {object} occurrence map
* */
function buildOccurrenceMap(documentRepresentation, regex, options) {
let occurrenceMap = {occurrenceIndexMap: {}, length: null, groups: null};
let count = 0;
let groupIndex = 0;
regex = regex.replace(/ /g, '\\s');
regex = (options.match_case) ? new RegExp(regex, 'gm') : new RegExp(regex, 'gmi');
//Loop over all text nodes in documentRepresentation
for(let key in documentRepresentation) {
let textNodes = documentRepresentation[key].group, preformatted = documentRepresentation[key].preformatted;
let textGroup = '';
let uuids = [];
for(let nodeIndex = 0; nodeIndex < textNodes.length; nodeIndex++) {
textGroup += textNodes[nodeIndex].text;
uuids.push(textNodes[nodeIndex].elementUUID);
}
let matches = textGroup.match(regex);
if(!matches) {
continue;
}
count += matches.length;
occurrenceMap[groupIndex] = {
uuids: uuids,
count: matches.length,
preformatted: preformatted
};
for(let matchesIndex = 0; matchesIndex < matches.length; matchesIndex++) {
let occMapIndex = matchesIndex + (count - matches.length);
occurrenceMap.occurrenceIndexMap[occMapIndex] = {groupIndex: groupIndex, subIndex: matchesIndex, occurrence: matches[matchesIndex]};
}
groupIndex++;
//If reached maxIndex, exit
if(options.max_results !== 0 && count >= options.max_results) {
break;
}
}
occurrenceMap.length = count;
occurrenceMap.groups = groupIndex;
return occurrenceMap;
}
/**
* Increment the given index, wrapping back to zero if reached end of occurrence map or index cap.
*
* @private
* @param {number} index - The current index
* @param {object} regexOccurrenceMap - The occurrence map object
* @param {object} options - The search options
* @return {number} the new index
* */
function computeSubsequentIndex(index, regexOccurrenceMap, options) {
//If reached end, reset index
let indexCap = self.options.max_results !== 0;
if(index >= regexOccurrenceMap.length-1 || (indexCap && index >= options.max_results-1)) {
return 0;
}
return index + 1;
}
/**
* Decrement the given index, wrapping back to the end if reached zero.
*
* @private
* @param {number} index - The current index
* @param {object} regexOccurrenceMap - The occurrence map object
* @param {object} options - The search options
* @return {number} the new index
* */
function computePrecedingIndex(index, regexOccurrenceMap, options) {
//If reached start, set index to last occurrence
let indexCap = self.options.max_results !== 0;
if(index <= 0) {
if(indexCap && options.max_results <= regexOccurrenceMap.length) {
return options.max_results - 1;
}
return regexOccurrenceMap.length - 1;
} else {
return index - 1;
}
}
/**
* Extract UUIDs from the document representation object.
*
* @private
* @param {object} documentRepresentation - The document representation object
* @return {array} a list of UUIDs
* */
function getUUIDsFromModelObject(documentRepresentation) {
let uuids = [];
for(let key in documentRepresentation) {
let textNodes = documentRepresentation[key].group;
for(let index = 0; index < textNodes.length; index++) {
uuids.push(textNodes[index].elementUUID);
}
}
return uuids;
}
});
================================================
FILE: background/browser-action-proxy.js
================================================
"use strict";
/**
* Create the Background ContentProxy namespace. Serves as mediator between the background scripts
* and the browser action popup.
* */
Find.register("Background.BrowserActionProxy", function() {
/**
* Initialize the port connection with the browser action popup.
* */
Find.browser.runtime.onConnect.addListener((browserActionPort) => {
if(browserActionPort.name !== 'popup_to_background_port') {
return;
}
if(Find.Background.installationDetails) {
browserActionPort.postMessage({action: 'install', details: Find.Background.installationDetails});
Find.Background.installationDetails = null;
}
let activeTab = null;
Find.browser.tabs.query({active: true, currentWindow: true}, (tabs) => {
activeTab = tabs[0];
// invoke action on message from popup script
browserActionPort.onMessage.addListener((message) => {
actionDispatch(message, activeTab, (resp) => {
browserActionPort.postMessage(resp);
});
});
// handle extension close
browserActionPort.onDisconnect.addListener(() => {
if(!Find.Background.options || !Find.Background.options.persistent_highlights) {
Find.Background.restorePageState(activeTab);
} else {
Find.Background.restorePageState(activeTab, false);
}
activeTab = null;
});
});
});
/**
* Dispatcher for calls for action by the browser action popup.
* Invokes the appropriate function in the Background based on the
* message.action field.
*
* @param {object} message - The message received from the popup
* @param {object} tab - Information about the active tab in the current window
* @param {function} sendResponse - Function used to issue a response back to the popup.
* */
function actionDispatch(message, tab, sendResponse) {
let action = message.action;
switch(action) {
case 'update':
Find.Background.updateSearch(message, tab, sendResponse);
break;
case 'next':
Find.Background.seekSearch(message, true, tab, sendResponse);
break;
case 'previous':
Find.Background.seekSearch(message, false, tab, sendResponse);
break;
case 'replace_next':
Find.Background.replaceNext(message, tab, sendResponse);
break;
case 'replace_all':
Find.Background.replaceAll(message, tab, sendResponse);
break;
case 'follow_link':
Find.Background.followLinkUnderFocus(message, tab, sendResponse);
break;
case 'browser_action_init':
Find.Background.initializeBrowserAction(message, tab, sendResponse);
break;
case 'get_occurrence':
Find.Background.extractOccurrences(message, tab, sendResponse);
break;
}
}
});
================================================
FILE: background/content-proxy.js
================================================
"use strict";
/**
* Create the Background ContentProxy namespace. Serves as mediator between the content
* in the web page and the background scripts.
* */
Find.register("Background.ContentProxy", function(self) {
/**
* Request from a given page a representation of the text nodes in the page's document.
*
* @param {object} tab - The tab to which the request will be made.
* @param {function} callback - The callback function that will utilize the document object model.
* @param {function} [error] - Callback function for handing an error.
* */
self.buildDocumentRepresentation = function(tab, callback, error) {
Find.browser.tabs.sendMessage(tab.id, {action: 'init'}, (response) => {
if(response && response.model) {
callback(response.model);
} else if(error) {
error();
}
});
};
/**
* Restore the page by removing reference markup to next nodes in the page. Highlight marking will not be removed.
*
* @param {object} tab - The tab from which all markup will be removed.
* @param {array} nodeReferences - Array of node reference UUIDs.
* @param {function} [callback] - Callback invoked when the page is restored.
* */
self.restoreWebPage = function(tab, nodeReferences, callback) {
Find.browser.tabs.sendMessage(tab.id, {
action: 'restore',
uuids: nodeReferences
}, callback);
};
/**
* Update the highlights in the page once the search query or options change.
*
* @param {object} tab - The tab that will be updated
* @param {string} regex - The regular expression or query
* @param {number} index - The index of the first occurrence
* @param {object} occurrenceMap - A special object that maps occurrences of the regex to individual text nodes.
* @param {object} options - The search options
* @param {function} [callback] - Callback invoked when the page highlights are updated.
* */
self.updatePageHighlights = function(tab, regex, index, occurrenceMap, options, callback) {
Find.browser.tabs.sendMessage(tab.id, {
action: 'update',
occurrenceMap: occurrenceMap,
index: index,
regex: regex,
options: options
}, callback);
};
/**
* Seek the search forward or backward.
*
* @param {object} tab - The tab that will be updated
* @param {number} index - The index of the occurrence to seek to
* @param {object} options - The search options
* @param {function} [callback] - Callback invoked when complete.
* */
self.seekHighlight = function(tab, index, options, callback) {
Find.browser.tabs.sendMessage(tab.id, {
action: 'seek',
index: index,
options: options
}, callback);
};
/**
* Remove all highlights from the page.
*
* @param {object} tab - The tab from which to remove all highlights
* @param {function} [callback] - Callback invoked when the highlights are removed from the page.
* */
self.clearPageHighlights = function(tab, callback) {
Find.browser.tabs.sendMessage(tab.id, {action: 'highlight_restore'}, callback);
};
/**
* Replace a single occurrence of the regular expression with a given piece of text in the page.
*
* @param {object} tab - The tab that will be updated
* @param {number} index - The specific index of the occurrence that will be replaced
* @param {string} replaceWith - The text that will replace the occurrence of the regex
* @param {object} options - The search options
* @param {function} [callback] - Callback invoked when the occurrence is replaced.
* */
self.replaceOccurrence = function(tab, index, replaceWith, options, callback) {
Find.browser.tabs.sendMessage(tab.id, {
action: 'replace',
index: index,
replaceWith: replaceWith,
options: options
}, callback);
};
/**
* Replace all occurrences of the regular expression with a given piece of text in the page.
*
* @param {object} tab - The tab that will be updated
* @param {string} replaceWith - The text that will replace each occurrence of the regex
* @param {object} options - The search options
* @param {function} [callback] - Callback invoked when the occurrences are replaced.
* */
self.replaceAllOccurrences = function(tab, replaceWith, options, callback) {
Find.browser.tabs.sendMessage(tab.id, {
action: 'replace_all',
replaceWith: replaceWith,
options: options
}, callback);
};
/**
* Follow the link in the page at the current index.
*
* @param {object} tab - The tab with the search
* @param {function} [callback] - Callback invoked once the operation is complete.
* */
self.followLinkUnderFocus = function(tab, callback) {
Find.browser.tabs.sendMessage(tab.id, {action: 'follow_link'}, callback);
};
/**
* Send a fetch message to the given tab to ensure that it responds. A successful response
* indicates that the content scripts were loaded successfully.
*
* @param {object} tab - The tab to fetch.
* @param {function} callback - Callback invoked once the operation is complete.
* */
self.fetch = function(tab, callback) {
Find.browser.tabs.sendMessage(tab.id, {action: 'fetch'}, callback);
};
/**
* Execute a given script in a specific tab.
*
* @param {object} tab - The tab with the search.
* @param {object} details - Details of the script to run. Either the func or the files property must be set, but
* both may not be set at the same time.
* @param {function} [callback] - Callback invoked once the operation is complete.
* */
self.executeScript = function(tab, details, callback) {
Find.browser.scripting.executeScript({target: {tabId: tab.id}, ...details}, callback);
};
});
================================================
FILE: background/omni.js
================================================
"use strict";
/**
* Create the Background Omni namespace. Registers various event listeners which invoke
* the appropriate background functions.
* */
Find.register("Background.Omni", function(self) {
Find.browser.omnibox.onInputStarted.addListener(() => {
Find.browser.tabs.query({active: true, currentWindow: true}, (tabs) => {
Find.Background.initializePage(tabs[0]);
});
});
retrieveOptions((options) => {
Find.browser.omnibox.onInputChanged.addListener((regex) => {
Find.browser.tabs.query({active: true, currentWindow: true}, (tabs) => {
Find.Background.updateSearch({regex: regex, options: options}, tabs[0], (result) => {
let description;
if (!regex) {
description = 'Enter a regular expression';
} else if (result.action === 'index_update') {
description = `${result.total} matches found`;
} else if (result.action === 'invalid_regex') {
description = result.error;
}
Find.browser.omnibox.setDefaultSuggestion({description: description});
});
});
});
});
Find.browser.omnibox.onInputCancelled.addListener(() => {
Find.browser.tabs.query({active: true, currentWindow: true}, (tabs) => {
Find.Background.restorePageState(tabs[0]);
});
});
Find.browser.omnibox.onInputEntered.addListener(() => {
Find.browser.tabs.query({active: true, currentWindow: true}, (tabs) => {
Find.Background.restorePageState(tabs[0], false);
});
});
/**
* Default options. This object and all of it's properties are immutable.
* To use this object, it must be cloned into a mutable object.
*
* To clone this object:
* let mutableOptions = JSON.parse(JSON.stringify(DEFAULT_OPTIONS));
* */
const DEFAULT_OPTIONS = Object.freeze({
find_by_regex: true,
match_case: true,
persistent_highlights: false,
persistent_storage_incognito: false,
hide_options_button: false,
hide_saved_expressions_button: false,
hide_clipboard_button: true,
hide_find_replace_button: true,
max_results: 0,
index_highlight_color: Object.freeze({
hue: 34,
saturation: 0.925,
value: 1,
hexColor: '#ff9813'
}),
all_highlight_color: Object.freeze({
hue: 56,
saturation: 1,
value: 1,
hexColor: '#fff000'
})
});
/**
* Retrieve the search options from the browser local storage, and pass
* to the callback function. The data from the storage is passed as a single
* argument to the callback function.
*
* @param {function} callback - The callback function to handle the data.
* @return {object} The search options, or null if it does not exist or cannot be retrieved.
* */
function retrieveOptions(callback) {
Find.browser.storage.local.get('options', (data) => {
let options = data['options'];
if(!options) {
return callback(JSON.parse(JSON.stringify(DEFAULT_OPTIONS)));
}
callback(options);
});
}
});
================================================
FILE: background/service_worker.js
================================================
"use strict";
importScripts('../app.js');
importScripts('./browser-action-proxy.js');
importScripts('./content-proxy.js');
importScripts('./background.js');
importScripts('./omni.js');
================================================
FILE: build.sh
================================================
#!/usr/bin/env bash
ME=$0
ROOT_DIR=$PWD
BUILD_DIR="$ROOT_DIR/.build"
MANIFEST="$ROOT_DIR/manifest.json"
VERSION=
# Display Usage
function help() {
cat <as block element let elementTagName = element.tagName.toLowerCase(); if (elementTagName === 'br') { return false; } if (window.getComputedStyle(element).display === 'inline') { return true; } return false; } /** * Determine whether a text node value is whitespace only. * * @private * @param {Node} node - The DOM node. * @return {boolean} true if the node value is whitespace only, false otherwise. * */ function isNodeTextValueWhitespaceOnly(node) { return !(/[^\t\n\r ]/.test(node.nodeValue)); } /** * Determine the depth of a given node in the DOM tree. * * @private * @param {Node} node - The DOM node. * @return {number} the depth of the DOM node in the tree. * */ function getNodeTreeDepth(node) { let depth = -1; while (node != null) { depth++; node = node.parentNode; } return depth; } /** * Generate a UUIDv4. * * @private * @return {string} a new UUIDv4. * */ function generateElementUUID() { let generateBlock = (size) => { let block = ''; for (let index = 0; index < size; index++) { block += Math.floor((1 + Math.random()) * 0x10000).toString(16).substring(1); } return block; }; const blockSizes = [2, 1, 1, 1, 3]; let uuid = ''; for (let index = 0; index < blockSizes.length; index++) { uuid += generateBlock(blockSizes[index]) + (index === blockSizes.length - 1 ? '' : '-'); } return uuid; } }); ================================================ FILE: docs/_config.yml ================================================ theme: jekyll-theme-slate ================================================ FILE: docs/help.css ================================================ body { background-color: #292929; } @font-face { font-family: octicons-link; src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAAAZwABAAAAAACFQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEU0lHAAAGaAAAAAgAAAAIAAAAAUdTVUIAAAZcAAAACgAAAAoAAQAAT1MvMgAAAyQAAABJAAAAYFYEU3RjbWFwAAADcAAAAEUAAACAAJThvmN2dCAAAATkAAAABAAAAAQAAAAAZnBnbQAAA7gAAACyAAABCUM+8IhnYXNwAAAGTAAAABAAAAAQABoAI2dseWYAAAFsAAABPAAAAZwcEq9taGVhZAAAAsgAAAA0AAAANgh4a91oaGVhAAADCAAAABoAAAAkCA8DRGhtdHgAAAL8AAAADAAAAAwGAACfbG9jYQAAAsAAAAAIAAAACABiATBtYXhwAAACqAAAABgAAAAgAA8ASm5hbWUAAAToAAABQgAAAlXu73sOcG9zdAAABiwAAAAeAAAAME3QpOBwcmVwAAAEbAAAAHYAAAB/aFGpk3jaTY6xa8JAGMW/O62BDi0tJLYQincXEypYIiGJjSgHniQ6umTsUEyLm5BV6NDBP8Tpts6F0v+k/0an2i+itHDw3v2+9+DBKTzsJNnWJNTgHEy4BgG3EMI9DCEDOGEXzDADU5hBKMIgNPZqoD3SilVaXZCER3/I7AtxEJLtzzuZfI+VVkprxTlXShWKb3TBecG11rwoNlmmn1P2WYcJczl32etSpKnziC7lQyWe1smVPy/Lt7Kc+0vWY/gAgIIEqAN9we0pwKXreiMasxvabDQMM4riO+qxM2ogwDGOZTXxwxDiycQIcoYFBLj5K3EIaSctAq2kTYiw+ymhce7vwM9jSqO8JyVd5RH9gyTt2+J/yUmYlIR0s04n6+7Vm1ozezUeLEaUjhaDSuXHwVRgvLJn1tQ7xiuVv/ocTRF42mNgZGBgYGbwZOBiAAFGJBIMAAizAFoAAABiAGIAznjaY2BkYGAA4in8zwXi+W2+MjCzMIDApSwvXzC97Z4Ig8N/BxYGZgcgl52BCSQKAA3jCV8CAABfAAAAAAQAAEB42mNgZGBg4f3vACQZQABIMjKgAmYAKEgBXgAAeNpjYGY6wTiBgZWBg2kmUxoDA4MPhGZMYzBi1AHygVLYQUCaawqDA4PChxhmh/8ODDEsvAwHgMKMIDnGL0x7gJQCAwMAJd4MFwAAAHjaY2BgYGaA4DAGRgYQkAHyGMF8NgYrIM3JIAGVYYDT+AEjAwuDFpBmA9KMDEwMCh9i/v8H8sH0/4dQc1iAmAkALaUKLgAAAHjaTY9LDsIgEIbtgqHUPpDi3gPoBVyRTmTddOmqTXThEXqrob2gQ1FjwpDvfwCBdmdXC5AVKFu3e5MfNFJ29KTQT48Ob9/lqYwOGZxeUelN2U2R6+cArgtCJpauW7UQBqnFkUsjAY/kOU1cP+DAgvxwn1chZDwUbd6CFimGXwzwF6tPbFIcjEl+vvmM/byA48e6tWrKArm4ZJlCbdsrxksL1AwWn/yBSJKpYbq8AXaaTb8AAHja28jAwOC00ZrBeQNDQOWO//sdBBgYGRiYWYAEELEwMTE4uzo5Zzo5b2BxdnFOcALxNjA6b2ByTswC8jYwg0VlNuoCTWAMqNzMzsoK1rEhNqByEyerg5PMJlYuVueETKcd/89uBpnpvIEVomeHLoMsAAe1Id4AAAAAAAB42oWQT07CQBTGv0JBhagk7HQzKxca2sJCE1hDt4QF+9JOS0nbaaYDCQfwCJ7Au3AHj+LO13FMmm6cl7785vven0kBjHCBhfpYuNa5Ph1c0e2Xu3jEvWG7UdPDLZ4N92nOm+EBXuAbHmIMSRMs+4aUEd4Nd3CHD8NdvOLTsA2GL8M9PODbcL+hD7C1xoaHeLJSEao0FEW14ckxC+TU8TxvsY6X0eLPmRhry2WVioLpkrbp84LLQPGI7c6sOiUzpWIWS5GzlSgUzzLBSikOPFTOXqly7rqx0Z1Q5BAIoZBSFihQYQOOBEdkCOgXTOHA07HAGjGWiIjaPZNW13/+lm6S9FT7rLHFJ6fQbkATOG1j2OFMucKJJsxIVfQORl+9Jyda6Sl1dUYhSCm1dyClfoeDve4qMYdLEbfqHf3O/AdDumsjAAB42mNgYoAAZQYjBmyAGYQZmdhL8zLdDEydARfoAqIAAAABAAMABwAKABMAB///AA8AAQAAAAAAAAAAAAAAAAABAAAAAA==) format('woff'); } kbd { background-color: #fafbfc; border: 1px solid #d1d5da; border-bottom-color: #c6cbd1; border-radius: 3px; box-shadow: inset 0 -1px 0 #c6cbd1; color: #444d56; display: inline-block; font: 11px SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace; line-height: 10px; padding: 3px 5px; vertical-align: middle; } table { overflow: auto; width: 100%; border-collapse: collapse; } table th { font-weight: 600; } table td, table th { border: 1px solid #dfe2e5; padding: 6px 13px; } table tr { background-color: #fff; border-top: 1px solid #c6cbd1; } table tr:nth-child(2n) { background-color: #f6f8fa; } div#body-container { background-color: white; color: black; max-width: 800px; margin: auto; padding: 10px; border-radius: 10px; box-shadow: 3px 3px 10px -3px rgba(0,0,0,0.55); } @media (max-width: 800px) { div#body-container { margin: auto; padding: 10px; border-radius: 10px; box-shadow: 3px 3px 10px -3px rgba(0,0,0,0.55); } } div#body-container h1, h2, h3, h4, h5, h6 { font-weight: lighter; } a#fork-badge { float: right; transform: translate(8px, -8px); } button#options-icon { background: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IiB3aWR0aD0iNjRweCIKCSBoZWlnaHQ9IjY0cHgiIHZpZXdCb3g9IjAgMCA2NCA2NCIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgNjQgNjQiIHhtbDpzcGFjZT0icHJlc2VydmUiPgoJPHBhdGggZmlsbD0iIzFEMUQxQiIgZD0iTTIuNjI5LDU2LjQ5M2w2LjE1Miw2Ljg0NEM5LjE1Niw2My43NTQsOS42OSw2My45OTYsMTAuMjUsNjRjMC4wMDQsMCwwLjAxMiwwLDAuMDE2LDAKCQljMC41NTYsMCwxLjA4NC0wLjIzLDEuNDYzLTAuNjM4bDMxLjk1OC0zNC4zNDVjMC40NjcsMC4wMzIsMS4wNywwLjA2LDEuNzY3LDAuMDZjMy4xOTIsMCw5LjEyOC0wLjU5OSwxMi45OTYtNC42MDQKCQljMi41NTYtMi42NDYsMy43ODQtNi4yNzksMy42NTItMTAuNzk3Yy0wLjAyLTAuNjIyLTAuMzItMS4yLTAuODIxLTEuNTY4Yy0wLjQ5Ny0wLjM2Ni0xLjEzOS0wLjQ4LTEuNzMzLTAuMzFsLTExLjUzOCwzLjMzCgkJbC0xLjA0OS00LjQ0NGwxMS4wNzgtNC4wNzdjMC43Ni0wLjI3OSwxLjI3Ny0wLjk5LDEuMzEzLTEuODAzYzAuMDM1LTAuODEyLTAuNDE5LTEuNTY3LTEuMTUtMS45MTNDNTcuOTUsMi43NzMsNTIuMDExLDAsNDUuODUzLDAKCQljLTYuNjM3LDAtMTEuMTE3LDMuMTY2LTEyLjk0Nyw5LjEyOWMtMC4wNjgsMC4yMTgtMS41NzEsNS4wNDEsMS4wNDUsMTFMMi42NTIsNTMuNzY1QzEuOTM5LDU0LjUyOSwxLjkzLDU1LjcxNSwyLjYyOSw1Ni40OTN6CgkJIE0zNy44MTUsMjEuODcxYzAuNTg3LTAuNjMxLDAuNzA5LTEuNTY0LDAuMzA1LTIuMzI2Yy0yLjY0MS00Ljk3My0xLjQ1MS05LjAxNi0xLjM5NS05LjE5N2MxLjMwNS00LjI1Miw0LjI5MS02LjMxOCw5LjEyNy02LjMxOAoJCWMxLjkwNSwwLDMuODI2LDAuMzI5LDUuNDk5LDAuNzQ3bC03LjQ0MiwyLjczOWMtMC45NTMsMC4zNS0xLjQ5NiwxLjM2My0xLjI2LDIuMzU4bDEuOTQ3LDguMjM5CgkJYzAuMTI3LDAuNTM1LDAuNDY1LDAuOTk2LDAuOTM5LDEuMjczYzAuNDcxLDAuMjc3LDEuMDM3LDAuMzQ5LDEuNTYyLDAuMTk4bDEwLjg1OS0zLjEzNmMtMC4zMDcsMi4xNDQtMS4xMDQsMy44OTMtMi4zODMsNS4yMTcKCQljLTIuODQsMi45NDEtNy41NjEsMy4zODEtMTAuMTIyLDMuMzgxYy0xLjM2MiwwLTIuMjc2LTAuMTIzLTIuMjg0LTAuMTIzYy0wLjY0Ni0wLjA5LTEuMjkzLDAuMTQzLTEuNzM2LDAuNjE5bC0zMS4xNCwzMy40NjYKCQlsLTMuNDU3LTMuODQ1TDM3LjgxNSwyMS44NzF6Ii8+Cjwvc3ZnPgo=) #eaeaea no-repeat center; background-size: 12px 12px; border-width: 0; border-radius: 2px; width: 25px; height: 25px; padding: 0; vertical-align: middle; } button#saved-expressions-icon { background: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IiB3aWR0aD0iNjRweCIgaGVpZ2h0PSI2NHB4IiB2aWV3Qm94PSIwIDAgNjQgNjQiIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDY0IDY0IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KCTxnIGlkPSJleWUiPgoJCTxwYXRoIGZpbGw9IiMxRDFEMUIiIGQ9Ik0xNy4xMTQsMC4wMDZjLTEuMTA0LDAtMiwwLjg5Ni0yLDIuMDAydjU5LjU4NGMwLDAuNzM4LDAuNDA4LDEuNDE4LDEuMDYxLDEuNzY2CgkJCWMwLjY1LDAuMzQ2LDEuNDQzLDAuMzA1LDIuMDU1LTAuMTA1bDEzLjQ0My05LjA0N2wxMy40NTcsOS40MzhjMC4zNDQsMC4yNCwwLjc0NiwwLjM2MywxLjE0OCwwLjM2MwoJCQljMC4zMTYsMCwwLjYzMy0wLjA3NCwwLjkyMi0wLjIyN2MwLjY2NC0wLjM0NCwxLjA3OC0xLjAyNywxLjA3OC0xLjc3M1YyLjAwOGMwLTEuMTA1LTAuODk1LTIuMDAyLTItMi4wMDJIMTcuMTE0eiBNNDQuMjc4LDU4LjE1OAoJCQlsLTExLjQzNC04LjAyYy0wLjM0NC0wLjI0LTAuNzQ2LTAuMzYxLTEuMTQ4LTAuMzYxYy0wLjM5MSwwLTAuNzc3LDAuMTEzLTEuMTE3LDAuMzRsLTExLjQ2NSw3LjcxN1Y0LjAwOGgyNS4xNjRWNTguMTU4eiIvPgoJPC9nPgo8L3N2Zz4K) #eaeaea no-repeat center; background-size: 12px 12px; border-width: 0; border-radius: 2px; width: 25px; height: 25px; padding: 0; vertical-align: middle; } .indent { padding-left: 10px; } pre { background-color: #eee; display: block; padding: 10px; } /* Collapsible Section Styles */ div.collapsible-section { padding-bottom: 5px; } div.collapsible-content div.content-inner { background: white; border: 1px solid #edecee; border-bottom-left-radius: 4px; border-bottom-right-radius: 4px; padding: .5rem 1rem; } input[type='checkbox'] { display: none; } .lbl-toggle { display: block; font-weight: lighter; font-size: 1.5em; padding: 0.5rem; background: #edecee; cursor: pointer; border-radius: 4px; } .lbl-toggle.example { background-color: white; } .lbl-toggle:hover { color: #7C5A0B; } .lbl-toggle::before { content: ' '; display: inline-block; border-top: 4px solid transparent; border-bottom: 4px solid transparent; border-left: 4px solid currentColor; vertical-align: middle; margin-right: .7rem; transform: rotate(90deg) translateX(-3px); } .toggle:checked + .lbl-toggle::before { transform: rotate(0deg) translateY(-3px); } .toggle:checked + .lbl-toggle + .collapsible-content { display: none; } .toggle:checked + .lbl-toggle { border-bottom-right-radius: 0; border-bottom-left-radius: 0; } ================================================ FILE: docs/index.html ================================================
Find+ User Guide
Hi there! Thanks for installing Find+. This is the user guide for the extension, where you will find all the information you need to start using the extension.
If you are having trouble and can't find a solution here, check our GitHub page. There are plenty of additional resources there.
Find+ supports any regular expression supported by JavaScript. If you aren't familiar with JavaScript
regular expressions, this
guide is a good starting point.
The following expression matches any text preceded by a colon ':', following by either
"Put", "Get" or "Delete", followed by the word "Object".
:((Put)|(Get)|(Delete))Object
{
"Version": "2012-10-17",
"Statement": [{
"Effect": "Allow",
"Action": [
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::dev.s3.ktb.ca"
]
},{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::dev.s3.ktb.ca/*"
]
}]
}
The following example matches any quoted date with the format "####-##-##".
"\d{4}-\d{2}-\d{2}"
{
"Version": "2012-10-17",
"Statement": [{
"Effect": "Allow",
"Action": [
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::dev.s3.ktb.ca"
]
},{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3GetObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::dev.s3.ktb.ca/*"
]
}]
}
This example matches any JavaScript variable declaration.
((var)|(let)).*?=.*?;
if (!preformatted.flag && isNodeTextValueWhitespaceOnly(node) && node.nodeValue.length !== 1) {
node = DOMTreeWalker.nextNode();
continue;
} else if (node.nodeValue.length === 1 && node.nodeValue.charCodeAt(0) === 10) {
node = DOMTreeWalker.nextNode();
continue;
}
let identifierUUID = generateElementUUID();
let nodeText = formatTextNodeValue(node, preformatted.flag, elementBoundary);
if (nodeText.length === 0) {
node = DOMTreeWalker.nextNode();
continue;
}
let wrapperElement = document.createElement('span');
wrapperElement.style.cssText = 'all: unset;';
wrapperElement.setAttribute('id', identifierUUID);
In Firefox, you can use CTRL+⇧+F to open the extension popup.
To open the extension popup in Chrome using a keyboard shortcut, you must first assign a keyboard shortcut to the extension through the Chrome settings. You can do this by following these steps:
- Navigate to the `Extensions` settings page in Chrome, or type `chrome://extensions/` into the navigation bar.
- In the top left click on the ☰ menu icon, then click `Keyboard shortcuts`.
- Locate the shortcut settings for find+. Click the input field located to the right of the label `Activate the extension`.
- Press the combination of keys you would like to use, and once complete press `OK`. We recommend using CTRL+⇧+F, since it shouldn't conflict with any other browser keyboard shortcut mappings.
When the extension popup is open, there are a number of keyboard shortcuts you can use. These settings cannot be remapped.
| Windows Shortcut | macOS Shortcut | Action |
|---|---|---|
| ↵ | ↵ | Advance to the next occurrence of the regular expression in the page. |
| ⇧+↵ | ⇧+↵ | Return to the previous occurrence of the regular expression in the page. |
| CTRL+⇧+↵ | ^+⇧+↵ | Follow the first highlighted link in the current occurrence focus. |
| CTRL+ALT+C | ^+⌥+C | Copy to the clipboard the currently highlighted text on the page. |
| CTRL+ALT+A | ^+⌥+A | Copy to the clipboard the all highlighted text on the page. |
| CTRL+ALT+O | ^+⌥+O | Expand or Collapse Options Pane. |
| CTRL+ALT+R | ^+⌥+R | Expand or Collapse Replace Text Pane. |
| CTRL+ALT+H | ^+⌥+H | Expand or Collapse Saved Expressions Pane. |
| CTRL+↵ or ESC | ^+↵ or ESC | Close the extension popup. |
Find+ can be configured through the options pane, which can be accessed by clicking the wrench icon .
Find by Regular Expression
Enabling this option will interpret your search query as a regular expression. If disabled, your search query will be interpreted as a string rather than a regular expression.
Match Case
This option is used to toggle case sensitivity. Enabling this option will make the search case sensitive.
Persistent Highlights
This option can be used to keep the highlights in the page, even after the extension popup closes. If enabled, highlighted occurrences of your search query will remain in the page even if the extension closes.
Persistent Storage (Incognito)
When incognito, you may still wish that your saved expressions and options are persisted. By default, this feature is disabled for security purposes. When enabled, your saved expressions and settings will be persisted and shared between incognito and non-incognito sessions.
Hide Option Pane Toggle Button
This option can be used to hide the button used to toggle the options pane. If enabled, you will need to use the shortcut to toggle the pane.
Hide Saved Expressions Pane Toggle Button
This option can be used to hide the button used to toggle the saved expressions pane. If enabled, you will need to use the shortcut to toggle the pane.
Hide Copy To Clipboard Button
This option can be used to hide the button used to copy occurrences to the clipboard. If enabled, you will need to use the keyboard shortcut to copy occurrences.
Max Highlighted Results
Limit the number of occurrences in the page. When set, only the first few results will be highlighted.
Selected Occurrence Highlight Color
This option is used to configure the color of the selected occurrence highlight; that is, the color of the highlight on the occurrence of the search query you are currently viewing.
Highlight Color
This option is used to configure the color of all other occurrences (all occurrences except the selected occurrence).
You can save frequently used regular expressions using the Saved Expressions pane, which can be accessed by pressing the bookmark icon .
Enter a regular expression in the search field and press 'Save Regex' to save the query to local storage. You can reuse a query by clicking on the expression entry in the saved expressions pane.
The find-and-replace pane is only accessible though the keyboard shortcut found in the Keyboard Shortcuts section of this guide.
The find-and-replace feature is used to replace text within a page. To replace text in a page, open the find-and-replace pane and enter a query in the search field, and enter the text you wish to replace occurrences of that query with in the replace pane field. Pressing 'Replace' will replace the current occurrence, while 'Replace All' will replace all occurrences.
Note that replacing text will modify the text in the page, and will require a refresh of the page to undo.
Find+ supports copying the current, or all, occurrences of your query to your clipboard. You will then be able to paste the occurrences to a text editor for use.
To use this feature, simply perform a search and use one of the keyboard shortcuts for copying occurrences. The exact shortcuts to use are outlined in the 'Keyboard Shortcuts' section.
Example
{
"Version": "2012-10-17",
"Statement": [{
"Effect": "Allow",
"Action": [
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::dev.s3.ktb.ca"
]
},{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::dev.s3.ktb.ca/*"
]
}]
}
Result in Clipboard
:PutObject
:GetObject
:DeleteObject
You can also use the omnibox to highlight occurrences of a query in the page, rather than opening the browser extension popup.
To use this feature, type "findplus" in your browser's address bar, press space, and then enter a regular expression. Occurrences of the regular expression will become highlighted on the page as you type.
Pressing ENTER will leave the highlights in the page. To remove the highlights, simply refresh the page. If you don't want to leave the highlights in the page, just erase the query entered in the address bar.
Reporting Bugs & Contributing
Found a bug? Have a feature request? You can log an issue in our GitHub page, and we will look into it right away.
If you are interested in trying to tackle an issue by yourself, have a read through our README.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|