Compare commits

...

38 Commits
0.1.2 ... main

Author SHA1 Message Date
Bauke ccb0968b18
Version 0.3.1! 2022-12-09 17:48:28 +01:00
Bauke 2727eb51b7
Idiot. 🤦 2022-12-09 17:47:55 +01:00
Bauke 2e579f350d
Version 0.3.0! 2022-12-09 17:32:56 +01:00
Bauke 6274e51752
Replace local storage usage with sync storage. 2022-12-05 14:50:33 +01:00
Bauke ed29853516
Transfer local storage to sync storage on new installs. 2022-12-05 14:47:42 +01:00
Bauke fe06822b24
Add a check for google.com for bangs. 2022-12-05 14:39:22 +01:00
Bauke 6630eff27f
Version 0.2.0! 2022-10-13 11:57:49 +02:00
Bauke e0583b4f77
Remove test usage item. 2022-10-13 11:41:44 +02:00
Bauke 46b3db5538
Revert "Add a test link for bangs."
This reverts commit 6ba718de35.
2022-10-13 11:38:18 +02:00
Bauke ee70b18781
Add a Using Bangs section. 2022-10-07 18:38:42 +02:00
Bauke 6ba718de35
Add a test link for bangs. 2022-10-07 18:38:28 +02:00
Bauke 6936cb2969
Re-add donate link. 2022-10-03 18:50:52 +02:00
Bauke 4a46f327ab
Rename gram to preact-components. 2022-10-03 18:19:27 +02:00
Bauke bc8a9b0efe
Update footer links. 2022-09-30 12:24:33 +02:00
Bauke 8d63c2ae8f
Relicense to AGPL-3.0-or-later, rewrite readme, fix things. 2022-09-28 19:56:43 +02:00
Bauke 3d527ba6cc
Fix screenshot in readme. 2022-03-24 09:14:16 +01:00
Bauke ebdab9d5c7
Version 0.1.5. 2022-03-24 09:08:36 +01:00
Bauke edbf5524b2
Add badges for Chrome and Microsoft stores. 2022-03-24 09:08:18 +01:00
Bauke 4373048194
Remove tabs permission, since for some reason tabs.update doesn't require it. 2022-03-24 09:01:58 +01:00
Bauke 35f8906b52
Add icons back to manifest. 2022-03-23 15:55:01 +01:00
Bauke 679782a26f
Version 0.1.4. 2022-03-23 14:15:47 +01:00
Bauke 903f6ebbf2
Rename screenshots folder to images. 2022-03-23 14:07:54 +01:00
Bauke 4a24828c32
Make the background script Chromium compatible. 2022-03-23 14:07:08 +01:00
Bauke 16b017013a
Add VITE_BROWSER to import.meta.env types. 2022-03-23 14:04:33 +01:00
Bauke 08c3f467cf
Replace manifest file with createManifest function. 2022-03-23 14:02:08 +01:00
Bauke 7b63504323
Add build support for Chromium. 2022-03-23 13:48:20 +01:00
Bauke eb6407ef7e
Version 0.1.3. 2022-03-18 00:12:09 +01:00
Bauke 4660c42868
Make the Save button show feedback on save. 2022-03-18 00:09:09 +01:00
Bauke f9e9f3aa5d
Update @holllo/gram again. 2022-03-18 00:07:54 +01:00
Bauke bbfee36f5b
Remove unnecessary debug log. 2022-03-17 22:51:44 +01:00
Bauke f9ebb80db7
Update PrivacyLinks to use new attributes. 2022-03-17 19:55:54 +01:00
Bauke 75cbdcfb75
Update @holllo/gram. 2022-03-17 19:52:16 +01:00
Bauke 48bb588145
Change header and input border color to secondary foreground. 2022-03-17 19:45:35 +01:00
Bauke 3082221c4d
Make the Remove button require confirmation. 2022-03-16 22:07:37 +01:00
Bauke 66c3f7e444
Disable Vite's minification. 2022-03-16 21:57:49 +01:00
Bauke bfb0b33ba3
Replace Link with new @holllo/gram PrivacyLink. 2022-03-16 21:55:54 +01:00
Bauke 9237d3f7a0
Remove $schema from extension manifest. 2022-03-16 21:49:59 +01:00
Bauke 8b76be1c0f
Sort Bangs by identifier. 2022-03-15 18:59:46 +01:00
23 changed files with 2588 additions and 1364 deletions

143
LICENSE
View File

@ -1,5 +1,5 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
@ -7,17 +7,15 @@
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
@ -72,7 +60,7 @@ modification follow.
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

View File

@ -1,48 +1,29 @@
# Fangs
# Fangs 🧛
> Inject custom DuckDuckGo Bangs into your browsing experience.
> **Inject custom DuckDuckGo Bangs.**
[![Fangs on AMO](https://img.shields.io/amo/v/fangs)](https://addons.mozilla.org/firefox/addon/fangs)
[![Get Fangs for Firefox](./images/mozilla-addons.png)](https://addons.mozilla.org/firefox/addon/fangs)
[![Get Fangs for Chrome](./images/chrome-web-store.png)](https://chrome.google.com/webstore/detail/fangs/dlllfannplfkhbiidhihagjkbmcolclf)
[![Get Fangs for Edge](./images/microsoft.png)](https://microsoftedge.microsoft.com/addons/detail/fangs/fgfkpbflhnljpfniippaagjjlncobhjd)
![Fangs 0.1.0](./screenshots/fangs-version-0-1-0.png)
![Latest Fangs screenshot](./images/fangs-version-0-2-0.png)
## Installation
You can install Fangs through [Mozilla Addons], [installing from a file] (see [the Releases page] for a prebuilt version) or building [from source](#development).
You can install Fangs through the stores linked above, [manually from a file] (see [the Releases page] for ZIP files) or [from source](#development).
[installing from a file]: https://support.mozilla.org/en-US/kb/find-and-install-add-ons-add-features-to-firefox#w_how-do-i-find-and-install-add-ons
[Mozilla Addons]: https://addons.mozilla.org/firefox/addon/fangs/
[the Releases page]: https://github.com/Holllo/fangs/releases
[manually from a file]: https://support.mozilla.org/en-US/kb/find-and-install-add-ons-add-features-to-firefox#w_how-do-i-find-and-install-add-ons
[the Releases page]: https://git.bauke.xyz/Holllo/fangs/releases
## Development
To build Fangs you will need [git], [NodeJS] and [pnpm]. Then from a terminal, run the following commands.
To build Fangs you will need [git](https://git-scm.com), [NodeJS](https://nodejs.org) and [pnpm](https://pnpm.io).
[git]: https://git-scm.com
[NodeJS]: https://nodejs.org
[pnpm]: https://pnpm.io
```sh
# Step 1. Download the repository with Git.
git clone https://github.com/Holllo/fangs
cd fangs
# Step 2. Install the dependencies.
pnpm install
# Step 3. Start an auto-reloading browser instance for development.
pnpm start
# Step 4. Lint the code and run tests.
pnpm test
# Step 5. Build the WebExtension for production.
# See the web-ext-artifacts directory for output.
pnpm build
```
* Install the dependencies with `pnpm install`.
* Start a separate browser with `pnpm start`.
* Build the WebExtension for production with `pnpm build`.
* Test the code with `pnpm test`.
## License
Fangs is open-sourced with the [GPL-3.0-or-later] license.
[GPL-3.0-or-later]: https://github.com/Holllo/fangs/blob/main/LICENSE
Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Holllo/fangs/src/branch/main/LICENSE) for more information.

BIN
images/chrome-web-store.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

View File

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

BIN
images/microsoft.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

BIN
images/mozilla-addons.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

View File

@ -1,37 +1,39 @@
{
"name": "fangs",
"license": "GPL-3.0-or-later",
"repository": "https://github.com/Holllo/fangs",
"private": true,
"scripts": {
"start": "vite build -m development --watch",
"start:chromium": "VITE_BROWSER=chromium pnpm start",
"clean": "trash build web-ext-artifacts",
"build": "pnpm clean && vite build && web-ext build --source-dir build && pnpm zip-source",
"build": "pnpm clean && pnpm build:chromium && pnpm build:firefox && pnpm zip-source",
"build:chromium": "VITE_BROWSER=chromium vite build && web-ext build -n fangs-chromium-{version}.zip -s build/chromium",
"build:firefox": "VITE_BROWSER=firefox vite build && web-ext build -n fangs-firefox-{version}.zip -s build/firefox",
"zip-source": "git archive --format zip --output web-ext-artifacts/fangs-source.zip HEAD",
"test": "xo && stylelint 'source/**/*.scss' && tsc && c8 ava"
},
"dependencies": {
"htm": "^3.1.0",
"@holllo/preact-components": "^0.2.3",
"htm": "^3.1.1",
"modern-normalize": "^1.1.0",
"preact": "^10.6.6",
"webextension-polyfill": "^0.8.0"
"preact": "^10.11.0",
"webextension-polyfill": "^0.10.0"
},
"devDependencies": {
"@preact/preset-vite": "^2.1.7",
"@types/webextension-polyfill": "^0.8.2",
"ava": "^4.1.0",
"c8": "^7.11.0",
"postcss": "^8.4.8",
"sass": "^1.49.9",
"stylelint": "^14.5.3",
"stylelint-config-standard-scss": "^3.0.0",
"@preact/preset-vite": "^2.4.0",
"@types/babel__core": "^7.1.19",
"@types/webextension-polyfill": "^0.9.1",
"ava": "^4.3.3",
"c8": "^7.12.0",
"postcss": "^8.4.16",
"sass": "^1.55.0",
"stylelint": "^14.12.1",
"stylelint-config-standard-scss": "^5.0.0",
"trash-cli": "^5.0.0",
"ts-node": "^10.7.0",
"typescript": "^4.6.2",
"vite": "^2.8.6",
"vite-plugin-web-extension": "^1.1.3",
"web-ext": "^6.7.0",
"xo": "^0.48.0"
"ts-node": "^10.9.1",
"typescript": "^4.8.3",
"vite": "^3.1.3",
"vite-plugin-web-extension": "^1.4.4",
"web-ext": "^7.2.0",
"xo": "^0.52.3"
},
"ava": {
"extensions": [
@ -61,12 +63,17 @@
{
"files": "tests/**/*.test.ts",
"rules": {
"@typescript-eslint/triple-slash-reference": "off",
"import/extensions": "off",
"no-await-in-loop": "off"
}
}
],
"prettier": true,
"rules": {
"@typescript-eslint/consistent-type-definitions": "off",
"n/file-extension-in-import": "off"
},
"space": true
}
}

File diff suppressed because it is too large Load Diff

View File

@ -1,20 +1,37 @@
import browser from 'webextension-polyfill';
import Bang, {BangParameters} from '../bang/bang.js';
import Bang, {type BangParameters} from '../bang/bang.js';
browser.browserAction.onClicked.addListener(async () => {
async function browserActionClicked() {
await browser.runtime.openOptionsPage();
});
}
if (import.meta.env.VITE_BROWSER === 'chromium') {
browser.action.onClicked.addListener(browserActionClicked);
} else {
browser.browserAction.onClicked.addListener(browserActionClicked);
}
browser.runtime.onInstalled.addListener(async () => {
if (import.meta.env.DEV) {
await browser.runtime.openOptionsPage();
}
const {dataVersion} = await browser.storage.sync.get({
dataVersion: '0',
});
if (dataVersion === '0') {
const local = await browser.storage.local.get();
local.dataVersion = '1';
await browser.storage.sync.set(local);
}
});
browser.webNavigation.onBeforeNavigate.addListener(async (details) => {
const detailsUrl = new URL(details.url);
if (detailsUrl.host !== 'duckduckgo.com') {
const supportedHosts = ['duckduckgo.com', 'google.com', 'www.google.com'];
if (!supportedHosts.includes(detailsUrl.host)) {
return;
}
@ -28,7 +45,7 @@ browser.webNavigation.onBeforeNavigate.addListener(async (details) => {
return;
}
const data = await browser.storage.local.get(id);
const data = await browser.storage.sync.get(id);
if (data[id] === undefined) {
return;
}

View File

@ -59,10 +59,7 @@ export default class Bang {
return true;
}
public destination: string;
public parameters: BangParameters;
constructor(destination: string, parameters: BangParameters) {
constructor(public destination: string, public parameters: BangParameters) {
this.destination = destination;
this.parameters = parameters;
}

View File

@ -1,38 +0,0 @@
{
"$schema": "http://json.schemastore.org/webextension",
"manifest_version": 2,
"name": "Fangs",
"description": "Inject custom DuckDuckGo Bangs into your browsing experience.",
"version": "0.1.2",
"permissions": [
"storage",
"tabs",
"webNavigation"
],
"content_security_policy": "script-src 'self'; object-src 'self'; style-src 'unsafe-inline'",
"web_accessible_resources": [
"assets/**"
],
"icons": {
"128": "assets/fangs-128.png"
},
"browser_action": {
"default_icon": {
"128": "assets/fangs-128.png"
}
},
"options_ui": {
"page": "options/index.html",
"open_in_tab": true
},
"background": {
"scripts": [
"background-scripts/initialize.ts"
]
},
"applications": {
"gecko": {
"id": "{cbb8b06b-9d6f-42f2-9d8d-7581f411653c}"
}
}
}

51
source/manifest.ts Normal file
View File

@ -0,0 +1,51 @@
/* eslint-disable @typescript-eslint/naming-convention */
export default function createManifest(
target: string,
): Record<string, unknown> {
const manifest: Record<string, unknown> = {
name: 'Fangs',
description:
'Inject custom DuckDuckGo Bangs into your browsing experience.',
version: '0.3.1',
permissions: ['storage', 'webNavigation'],
options_ui: {
page: 'options/index.html',
open_in_tab: true,
},
};
const icons = {
128: 'assets/fangs-128.png',
};
manifest.icons = icons;
const browserAction = {
default_icon: icons,
};
const backgroundScript = 'background-scripts/initialize.ts';
if (target === 'chromium') {
manifest.manifest_version = 3;
manifest.action = browserAction;
manifest.background = {
service_worker: backgroundScript,
type: 'module',
};
} else {
manifest.manifest_version = 2;
manifest.browser_action = browserAction;
manifest.background = {
scripts: [backgroundScript],
};
manifest.applications = {
gecko: {
id: '{cbb8b06b-9d6f-42f2-9d8d-7581f411653c}',
},
};
}
return manifest;
}

View File

@ -1,20 +0,0 @@
import {html} from 'htm/preact';
import {Component} from 'preact';
type Props = {
cssClass: string;
text: string;
url: string;
};
export class Link extends Component<Props> {
render() {
const {cssClass, text, url} = this.props;
return html`
<a class=${cssClass} href=${url} target="_blank" rel="noopener">
${text}
</a>
`;
}
}

View File

@ -1,8 +1,7 @@
import {PrivacyLink} from '@holllo/preact-components';
import {html} from 'htm/preact';
import {Component} from 'preact';
import browser from 'webextension-polyfill';
import {Link} from './link.js';
import type browser from 'webextension-polyfill';
type Props = {
manifest: browser.Manifest.ManifestBase;
@ -13,15 +12,18 @@ export class PageFooter extends Component<Props> {
const {manifest} = this.props;
const version = manifest.version;
const donateAttributes = {
href: 'https://liberapay.com/Holllo',
};
const donateLink = html`
<${Link} text="Donate" url="https://github.com/sponsors/Bauke" />
<${PrivacyLink} attributes="${donateAttributes}">Donate<//>
`;
const versionLinkAttributes = {
href: `https://git.bauke.xyz/Holllo/fangs/releases/tag/${version}`,
};
const versionLink = html`
<${Link}
text="v${version}"
url="https://github.com/Holllo/fangs/releases/tag/${version}"
/>
<${PrivacyLink} attributes=${versionLinkAttributes}>v${version}<//>
`;
return html`

View File

@ -1,8 +1,9 @@
import {ConfirmButton, FeedbackButton} from '@holllo/preact-components';
import {html} from 'htm/preact';
import {Component} from 'preact';
import browser from 'webextension-polyfill';
import Bang, {BangParameters} from '../../bang/bang.js';
import Bang, {type BangParameters} from '../../bang/bang.js';
type Props = Record<string, unknown>;
@ -33,11 +34,12 @@ export class PageMain extends Component<Props, State> {
}
async componentDidMount() {
const localStorage = await browser.storage.local.get();
const storage = await browser.storage.sync.get();
const bangs = Object.entries(localStorage)
const bangs = Object.entries(storage)
.filter(([key, _bang]) => key.startsWith('!'))
.map(([_key, bang]) => bang as BangParameters);
.map(([_key, bang]) => bang as BangParameters)
.sort((a, b) => a.id.localeCompare(b.id));
this.setState({bangs: this.state.bangs.concat(bangs)});
}
@ -65,7 +67,7 @@ export class PageMain extends Component<Props, State> {
return;
}
await browser.storage.local.remove(id);
await browser.storage.sync.remove(id);
const bangs = this.state.bangs;
const existingIndex = bangs.findIndex((bang) => bang.id === id);
@ -86,7 +88,7 @@ export class PageMain extends Component<Props, State> {
if (Bang.validate(bang)) {
const update: Record<string, BangParameters> = {};
update[bang.id] = bang;
await browser.storage.local.set(update);
await browser.storage.sync.set(update);
}
} catch (error: unknown) {
if (error instanceof Error) {
@ -97,7 +99,8 @@ export class PageMain extends Component<Props, State> {
throw error;
}
return;
// Return false to make the FeedbackButton not show feedback.
return false;
}
const bangs = this.state.bangs;
@ -195,10 +198,21 @@ export class PageMain extends Component<Props, State> {
${editorInputs}
<div class="button-group">
<button class="button" onClick=${this.saveBang}>Save</button>
<button class="button destructive" onClick=${this.removeBang}>
Remove
</button>
<${FeedbackButton}
attributes=${{class: 'button'}}
click=${this.saveBang}
feedbackText="Saved"
text="Save"
timeout=${5 * 1000}
/>
<${ConfirmButton}
class="button destructive"
click=${this.removeBang}
confirmClass="confirm"
confirmText="Confirm Removal"
text="Remove ${this.state.editorBang.id}"
timeout=${5 * 1000}
/>
</div>
${validateError}
</div>
@ -252,6 +266,15 @@ export class PageMain extends Component<Props, State> {
button.
</li>
</ul>
<p>Using Bangs:</p>
<ul>
<li>On the DuckDuckGo website, use your custom Bangs directly.</li>
<li>
With DuckDuckGo set as your browser's default search engine, use
your custom Bangs in the address bar.
</li>
</ul>
</details>
</main>
`;

View File

@ -7,8 +7,6 @@ import {PageHeader} from './components/page-header.js';
import {PageMain} from './components/page-main.js';
window.addEventListener('DOMContentLoaded', () => {
console.debug('Options page opened!');
const manifest = browser.runtime.getManifest();
render(html`<${OptionsPage} manifest=${manifest} />`, document.body);

View File

@ -3,7 +3,7 @@
.page-header {
@include mixins.responsive-container;
border: 1px solid var(--df-1);
border: 1px solid var(--df-2);
margin-bottom: 16px;
h1 {
@ -12,7 +12,7 @@
}
img {
background-color: var(--df-1);
background-color: var(--df-2);
display: inline-block;
height: 4.5rem;
margin-right: 1rem;

View File

@ -16,7 +16,7 @@
.input-group {
background-color: var(--db-2);
border: 1px solid var(--df-1);
border: 1px solid var(--df-2);
padding: 8px;
label,

3
source/types.d.ts vendored
View File

@ -1,4 +1,4 @@
import {html} from 'htm/preact';
import type {html} from 'htm/preact';
declare global {
// See Vite documentation for `import.meta.env` usage.
@ -13,6 +13,7 @@ declare global {
readonly DEV: boolean;
readonly MODE: string;
readonly PROD: boolean;
readonly VITE_BROWSER: 'chromium' | 'firefox';
}
type HtmComponent = ReturnType<typeof html>;

View File

@ -1,6 +1,8 @@
/// <reference path="../source/types.d.ts" />
import test from 'ava';
import Bang, {BangParameters} from '../source/bang/bang';
import Bang, {type BangParameters} from '../source/bang/bang';
test('Bang.parseId', (t) => {
const samples: Array<[string, string | undefined]> = [

View File

@ -1,5 +1,6 @@
import fs from 'node:fs';
import path from 'node:path';
import process from 'node:process';
import url from 'node:url';
import {defineConfig} from 'vite';
@ -8,17 +9,37 @@ import {defineConfig} from 'vite';
import preactPreset from '@preact/preset-vite';
import webExtension from 'vite-plugin-web-extension';
const currentDir = path.dirname(url.fileURLToPath(import.meta.url));
import createManifest from './source/manifest.js';
const buildDir = path.join(currentDir, 'build');
const targetBrowser = process.env.VITE_BROWSER ?? 'firefox';
process.env.VITE_BROWSER = targetBrowser;
const currentDir = path.dirname(url.fileURLToPath(import.meta.url));
const buildDir = path.join(currentDir, 'build', targetBrowser);
const sourceDir = path.join(currentDir, 'source');
// Create the Firefox profile if it doesn't already exist.
fs.mkdirSync(path.join(currentDir, 'firefox'), {recursive: true});
// Create the browser profile if it doesn't already exist.
fs.mkdirSync(path.join(currentDir, targetBrowser), {recursive: true});
const webExtConfig: Record<string, unknown> = {
browserConsole: true,
chromiumProfile: 'chromium/',
firefoxProfile: 'firefox/',
keepProfileChanges: true,
};
if (targetBrowser === 'chromium') {
webExtConfig.startUrl = 'chrome://extensions/';
webExtConfig.target = 'chromium';
} else {
webExtConfig.startUrl = 'about:debugging#/runtime/this-firefox';
webExtConfig.target = 'firefox-desktop';
}
export default defineConfig({
build: {
outDir: buildDir,
minify: false,
sourcemap: 'inline',
},
plugins: [
@ -27,15 +48,9 @@ export default defineConfig({
// https://github.com/aklinker1/vite-plugin-web-extension
webExtension({
assets: 'assets',
browser: 'firefox',
manifest: path.join(sourceDir, 'manifest.json'),
webExtConfig: {
browserConsole: true,
firefoxProfile: 'firefox/',
keepProfileChanges: true,
startUrl: 'about:debugging#/runtime/this-firefox',
target: 'firefox-desktop',
},
browser: targetBrowser,
manifest: () => createManifest(targetBrowser),
webExtConfig,
}),
],
root: sourceDir,