Relicense to AGPL-3.0-or-later, rewrite readme, fix things.
This commit is contained in:
parent
3d527ba6cc
commit
8d63c2ae8f
GPG Key ID:
C1C0F29952BCF558
143
LICENSE
143
LICENSE
|
|
@ -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>.
|
||||
|
|
|
|||
49
README.md
49
README.md
|
|
@ -1,50 +1,29 @@
|
|||
# Fangs
|
||||
# Fangs 🧛
|
||||
|
||||
> Inject custom DuckDuckGo Bangs into your browsing experience.
|
||||
> **Inject custom DuckDuckGo Bangs.**
|
||||
|
||||
[](https://addons.mozilla.org/firefox/addon/fangs)
|
||||
[](https://chrome.google.com/webstore/detail/dlllfannplfkhbiidhihagjkbmcolclf)
|
||||
[](https://microsoftedge.microsoft.com/addons/detail/fgfkpbflhnljpfniippaagjjlncobhjd)
|
||||
[](https://chrome.google.com/webstore/detail/fangs/dlllfannplfkhbiidhihagjkbmcolclf)
|
||||
[](https://microsoftedge.microsoft.com/addons/detail/fangs/fgfkpbflhnljpfniippaagjjlncobhjd)
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
|
|
|||
43
package.json
43
package.json
|
|
@ -1,7 +1,4 @@
|
|||
{
|
||||
"name": "fangs",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"repository": "https://github.com/Holllo/fangs",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"start": "vite build -m development --watch",
|
||||
|
|
@ -15,27 +12,28 @@
|
|||
},
|
||||
"dependencies": {
|
||||
"@holllo/gram": "^0.2.1",
|
||||
"htm": "^3.1.0",
|
||||
"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": [
|
||||
|
|
@ -65,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
|
||||
}
|
||||
}
|
||||
|
|
|
|||
3447
pnpm-lock.yaml
3447
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
|
|
@ -1,6 +1,6 @@
|
|||
import browser from 'webextension-polyfill';
|
||||
|
||||
import Bang, {BangParameters} from '../bang/bang.js';
|
||||
import Bang, {type BangParameters} from '../bang/bang.js';
|
||||
|
||||
async function browserActionClicked() {
|
||||
await browser.runtime.openOptionsPage();
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
import {PrivacyLink} from '@holllo/gram';
|
||||
import {html} from 'htm/preact';
|
||||
import {Component} from 'preact';
|
||||
import browser from 'webextension-polyfill';
|
||||
import type browser from 'webextension-polyfill';
|
||||
|
||||
type Props = {
|
||||
manifest: browser.Manifest.ManifestBase;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ 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>;
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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]> = [
|
||||
|
|
|
|||
Loading…
Reference in New Issue