Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Fannon/search-bookmarks-history-and-tabs

Browser extension to search and navigate browser tabs, local bookmarks and history.
https://github.com/Fannon/search-bookmarks-history-and-tabs

bookmark bookmarks browserhistory chrome-extension search tabs-management tagging

Last synced: 12 days ago
JSON representation

Browser extension to search and navigate browser tabs, local bookmarks and history.

Host: GitHub
URL: https://github.com/Fannon/search-bookmarks-history-and-tabs
Owner: Fannon
License: mit
Created: 2021-07-25T07:05:18.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-19T09:32:57.000Z (6 months ago)
Last Synced: 2024-05-20T08:45:06.294Z (6 months ago)
Topics: bookmark, bookmarks, browserhistory, chrome-extension, search, tabs-management, tagging
Language: JavaScript
Homepage:
Size: 11.3 MB
Stars: 165
Watchers: 4
Forks: 8
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Search Bookmarks, History and Browser Tabs

🔎 Browser extension to (fuzzy) search and navigate bookmarks, history and open tabs.

## Installation via Store

- [Chrome Extension](https://chrome.google.com/webstore/detail/tabs-bookmark-and-history/cofpegcepiccpobikjoddpmmocficdjj?hl=en-GB&authuser=0)
- [Firefox Addon](https://addons.mozilla.org/en-US/firefox/addon/search-tabs-bookmarks-history/)
- [Microsoft Edge Addon](https://microsoftedge.microsoft.com/addons/detail/search-tabs-bookmarks-an/ldmbegkendnchhjppahaadhhakgfbfpo)
- [Opera Addon](https://addons.opera.com/en/extensions/details/search-bookmarks-history-and-tabs/)

## Features

**This extension does not collect any data nor does it make any external requests** (see [Privacy](#privacy--data-protection)).

It supports two different search approaches:

- **Exact search** (case-insensitive, but exact matching): Faster, but only exact matching results.
- **Fuzzy search** (approximate matching): Slower, but includes also inexact (fuzzy) matches.

With this extension you can also **tag your bookmarks** including auto completions.
The tags are considered when searching and can be used for navigation.

The extension is very customizable (see [user options](#user-configuration)) and has a dark / light theme that is selected based on your system settings (see [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)). It's also very lightweight (< 150kb JavaScript, including dependencies).

> 💡 Have a look at the [Tips & Tricks](./Tips.md) collection.

> 🗎 For a list of recent changes, see [CHANGELOG.md](./CHANGELOG.md).

## Screenshots & Demo

![Demo Animation](/images/bookmark-and-history-search.gif 'Demo Animation')

## User Documentation

- **Search Strategies**: Switch between precise and fuzzy approach by clicking on the FUZZY or PRECISE button in the search bar (top right).
- **Keyboard Shortcut**: Trigger the extension via keyboard.
- The default is `CTRL` + `Shift` + `.`, but you can customize this (I personally use `Ctrl+J`).
- **Open selected results**: By default, the extension will open the selected result in a new active tab, or switch to an existing tab with the target url.
- Hold `Shift` or `Alt` to open the result in the current tab
- Hold `Ctrl` to open the result without closing the popup.
- Right-click to copy URL to clipboard
- **Search Modes**: In case you want to be more selective -> use a search mode:
- Start your query with `#`: only **bookmarks with the tag** will be returned (exact "starts with" search)
- Supports AND search, e.g. search for `#github #pr` to only get results which have both tags
- Start your query with `~`: only **bookmarks within the folder** will be returned (exact "starts with" search)
- Supports AND search, e.g. search for `~Sites ~Blogs` to only get results which have both tags
- Start your query with `b ` (including space): only **bookmarks** will be searched.
- Start your query with `h ` (including space): only **history** and **open tabs** will be searched.
- Start your query with `t ` (including space): only **open tabs** will be searched.
- Start your query with `s ` (including space): only **search engines** will be proposed.
- Custom Aliases:
- The option `customSearchEngines` allows you to define your own search mode aliases
- Default: Start your query with `g ` (including space): Do a Google search.
- Default: Start your query with `d ` (including space): Do a dict.cc search.
- **Emacs / Vim Navigation**:
- `Ctrl+N` and `Ctrl+J` to navigate search results up
- `Ctrl+P` and `Ctrl+K` to navigate search results down
- **Special Browser Pages**: You can add special browser pages to your bookmarks, like `chrome://downloads`.
- **Custom Scores**: Add custom bonus scores by putting ` +` to your bookmark title (before tags)
- Examples: `Bookmark Title +20` or `Another Bookmark +10 #tag1 #tag2`
- This extension works best if you avoid:
- using `#` in bookmark titles that do not indicate a tag.
- using `~` in bookmark folder names.

## User Configuration

The extension is highly customizable.
Finding and setting options is a bit technical, though.

The user options are written in [YAML](https://en.wikipedia.org/wiki/YAML) or [JSON](https://en.wikipedia.org/wiki/JSON) notation.

For now, there is no nice options overview, so you have to find them in the [popup/js/model/options.js](popup/js/model/options.js) file in the `defaultOptions` object.
From there you can see the available options, their names, default values and descriptions.

When defining your custom config, you only need to define the options that you want to overwrite from the defaults.

> ⚠ The options are not validated properly. Please make sure to use them correctly.

> If something breaks, consider resetting your options.

An exemplary user config can look like the following example:

```yaml
searchStrategy: fuzzy
displayVisitCounter: true
historyMaxItems: 2048 # Increase max number of browser history items to load
```

If you have **troubles with performance**, here are a few options that might help. Feel free to pick & choose and tune the values to your situation. In particular `historyMaxItems` and how many bookmarks you have will impact init and search performance.

Here is a suggestion for low-performance machines:

```yaml
searchStrategy: precise # Precise search is faster than fuzzy search.
searchMinMatchCharLength: 2 # Start searching only when at least 2 characters are entered
displaySearchMatchHighlight: false, # Not highlighting search matches improves render performance.
searchMaxResults: 20 # Number of search results can be further limited
historyMaxItems: 512 # Number of browser history items can be further reduced
```

Or a more advanced example:

```yaml
searchStrategy: precise
historyDaysAgo: 14
historyMaxItems: 2048
historyIgnoreList:
- extension://
- http://localhost
- http://127.0.0.1
colorStripeWidth: 4 # Customize width of search result color stripe
scoreTabBaseScore: 70 # customize base score for open tabs
searchEngineChoices:
- name: Google
urlPrefix: https://google.com/search?q=
customSearchEngines:
- alias: ['g', 'google']
name: Google
urlPrefix: https://www.google.com/search?q=$s
blank: https://www.google.com
- alias: d
name: dict.cc
urlPrefix: https://www.dict.cc/?s=$s
- alias: [gh, github]
name: GitHub
urlPrefix: https://github.com/search?q=$s
blank: https://github.com
- alias: npm
name: NPM
urlPrefix: https://www.npmjs.com/search?q=$s
blank: https://www.npmjs.com
debug: true # Print information about loading time / statistics in dev console
```

In case of making multilingual searching (CJK) correctly, you may need to tweak [uFuzzy](https://github.com/leeoniya/uFuzzy) options via option `ufuzzyOptions`, for example:

```yaml
# make CJK chars work for fuzzy search
uFuzzyOptions:
interSplit: (p{Unified_Ideograph=yes})+
```

## Scoring System

The scoring systems works roughly the following:

- Depending on the type of result (bookmark, tab, history) a different base score is taken (e.g. `scoreBookmarkBaseScore`).
- Depending on in which result field (title, url, tag, folder) the match was found, the search match gets weighted by multiplication. (e.g. `scoreTitleWeight`).
- This base score is now merged / multiplied with the search library score. A less good match will usually reduce the score and a perfect / highest ranked match will keep it at .
- Depending on certain conditions some bonus score points are added on top. For example, `exactStartsWithBonus` will add score if either the title or the url start exactly with the search term, including spaces.

For a description of the scoring options and what they do, please see [popup/js/model/options.js](popup/js/model/options.js).

## Privacy / Data Protection

This extension is built to respect your privacy:

- It does not have permissions for outside communication, so none of your data is shared or exposed externally.
- The extension does not even store any information except your user settings.
Every time the extension popup is closed, it "forgets" everything and starts from a blank slate next time you open it.
- There is no background job / processing. If the popup is not explicitly opened by the user, the extension is not executed.
- The extension only requests the following permissions for the given reasons:
- **bookmarks**: Necessary to read and edit the bookmarks. Can be disabled via [user configuration](#user-configuration).
- **history**: Necessary to read the browsing history. Can be disabled or limited via [user configuration](#user-configuration).
- **tabs**: Necessary to find open tabs and to use tabs for navigation. Can be disabled via [user configuration](#user-configuration).
- **storage**: Necessary to store and retrieve the [user configuration](#user-configuration).
If the browser has setting synchronization enabled, the extension settings will be synced (in this case you already trust your browser to sync everything else anyway).
If browser sync is disabled, the user configuration is only stored locally.
- The extension is open source, so feel free to convince yourself :)

## Local Development

### Install and Build

Prerequisite: [Node.js](https://nodejs.org/en/)

```sh
# install dependencies
npm install

# build extension
npm run build
```

The source code for the extension can be found in [popup/](popup/) (HTML, CSS, JS and libs).

The built extensions can be found

- [dist/chrome/](dist/chrome/) for Google Chrome and Microsoft Edge
- [dist/firefox/](dist/firefox/) for Firefox
- [dist/opera/](dist/firefox/) for Opera

### Developer Installation

- Check out this extension via git
- Run `npm install` and `npm run build` (via bash / git bash)
- **For Chrome / Edge**:
- Navigate to extensions page (`chrome://extensions/` on Chrome and `edge://extensions/` on Edge).
- Enable "Developer mode"
- Choose "Load unpacked" and open the root folder of this repository
- **For Firefox**:
- First [install and build](#install-and-build) this project.
- Load the built extension in `dist/firefox` as a temporary addon in `about:debugging`.

### Developer Workflow

- Typical developer actions
- `npm run build` for a complete build
- `npm run start` to start the extension locally in a browser (with mock data)
- `npm run test` to run end to end tests
- for more, see `npm run`

## Credits

This extension makes use of the following helpful open-source projects (thanks!):

- https://github.com/leeoniya/uFuzzy for the fuzzy search algorithm
- https://github.com/yairEO/tagify for the tag autocomplete widget
- https://markjs.io/ for highlighting search matches
- https://www.npmjs.com/package/js-yaml for the user options parsing
- https://github.com/tabler/tabler-icons for icons
- https://www.joshwcomeau.com/css/custom-css-reset/

## Feedback and Ideas

> Please create a [GitHub issue](https://github.com/Fannon/search-tabs-bookmarks-and-history/issues) to give your feedback.
> All ideas, suggestions or bug reports are welcome.