Skip to content

Commit 4df12b5

Browse files
authored
🔀 Merge pull request #546 from FrostCo/popup_message
Popup message
2 parents e1adbad + 11dca04 commit 4df12b5

16 files changed

+223
-104
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,32 @@ assignees: ''
1010
_Instructions: This template is written in Markdown. Click the "Preview" tab to see what it will look like when submitted. Fill in the applicable sections (you can erase the examples if you'd like)._
1111

1212
#### :bug: Description
13+
1314
A clear and concise description of what the bug is.
1415

1516
#### :twisted_rightwards_arrows: Steps To Reproduce
17+
1618
1. Go to '...'
1719
2. Click on '....'
1820
3. Scroll down to '....'
1921
4. See error
2022

2123
#### :heavy_check_mark: Expected behavior
24+
2225
A clear and concise description of what you expected to happen.
2326

2427
#### :camera: Screenshots
28+
2529
If applicable, add screenshots to help explain your problem.
2630

2731
#### :computer: Details
28-
- **Device:** [e.g. MacBook Pro, Google Pixel]
29-
- **OS:** [e.g. MacOS 10.14, Windows 10]
30-
- **Browser:** [e.g. Chrome, Firefox]
31-
- **Browser Version:** [e.g. 50]
32-
- **Affected site(s):** [e.g. www.google.com]
32+
33+
- **Device:** [e.g. MacBook Pro, Google Pixel]
34+
- **OS:** [e.g. MacOS 10.14, Windows 10]
35+
- **Browser:** [e.g. Chrome, Firefox]
36+
- **Browser Version:** [e.g. 50]
37+
- **Affected site(s):** [e.g. www.google.com]
3338

3439
#### :pencil: Additional context
40+
3541
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ assignees: ''
1010
_Instructions: This template is written in Markdown. Click the "Preview" tab to see what it will look like when submitted. Fill in the applicable sections (you can erase the examples if you'd like)._
1111

1212
#### :loudspeaker: The Shortcoming
13+
1314
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1415

1516
#### :microscope: Describe the solution you'd like
17+
1618
A clear and concise description of what you want to happen.
1719

1820
#### :triangular_ruler: Describe alternatives you've considered
21+
1922
A clear and concise description of any alternative solutions or features you've considered.
2023

2124
#### :pencil: Additional context
25+
2226
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/muting_request.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,19 @@ assignees: ''
1010
_Instructions: This template is written in Markdown. Click the "Preview" tab to see what it will look like when submitted. Fill in the applicable sections (you can erase the examples if you'd like). For more information, please see [this page](https://github.com/FrostCo/AdvancedProfanityFilter/wiki/New-Audio-Muting-Site)._
1111

1212
#### :movie_camera: The Site
13+
1314
_Example: www.youtube.com_
1415

1516
#### :speech_balloon: Subtitle Element/Node
17+
1618
_Example:_
19+
1720
```html
1821
<div class="subtitle-container">
1922
<p class="subtitle-text">Subtitle text</p>
2023
</div>
2124
```
2225

2326
#### :pencil: Additional notes
24-
_Add any other context or screenshots about the request here._
27+
28+
_Add any other context or screenshots about the request here._

.github/pull_request_template.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
## ✨ New Features & Updates
1+
## ✨ New Features & Updates
2+
23
- [hash] description
34

45
## 🐛 Bugs Fixed
6+
57
- [hash] description
68

79
## 🔧 Development
8-
- [hash] description
10+
11+
- [hash] description

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All contributors and community members should always be polite, courteous, and h
99
## Ways to contribute
1010

1111
We want to make contributing to this project as easy and transparent as possible, whether it's:
12+
1213
- Reporting an issue
1314
- Discussing the current state of the code
1415
- Submitting a fix
@@ -25,11 +26,11 @@ If you have any substantial changes that you would like to make, please [open an
2526
2. Install Node.js
2627
3. Install needed dev dependencies: `npm install`
2728
4. Create a new branch: `git checkout -b my-branch-name`
28-
6. Run tests and make sure they are all passing: `npm run test`
29-
5. Make your changes, add tests (if applicable)
30-
6. Run tests again to make sure they still pass
31-
7. Push to your fork and [submit a pull request](https://github.com/FrostCo/AdvancedProfanityFilter/compare)
32-
8. Wait for your pull request to be reviewed, and be willing to answer questions or make adjustments as needed so that it can get merged
29+
5. Run tests and make sure they are all passing: `npm run test`
30+
6. Make your changes, add tests (if applicable)
31+
7. Run tests again to make sure they still pass
32+
8. Push to your fork and [submit a pull request](https://github.com/FrostCo/AdvancedProfanityFilter/compare)
33+
9. Wait for your pull request to be reviewed, and be willing to answer questions or make adjustments as needed so that it can get merged
3334

3435
Tips for a good review process:
3536

PRIVACY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
This is the privacy policy for Advanced Profanity Filter. There are ***no external connections*** made by the Filter. There are ***no analytics*** collected by the Filter. The Filter is **open source**, so feel free to look it over if you'd like. The Filter only modifies the pages that you visit to *filter* profanity (or words/phrases that you configure). Your **privacy** is very important to me, and I will do *everything I can* to preserve it. Below is a list of the ***permissions*** used by the Filter, along with *explanations* of how they are used.
44

55
## URL Permissions (pages the Filter can run on)
6+
67
- `<all_urls>`: Because this Filter was designed to filter profanity text found on any webpage, it requires permission to run on all pages. This is the highest level of permission an Extension/Add-on can usually request, so care should be taken before granting it. *As stated above*, the Filter does **not** connect to an external service, and **no** analytics/metrics are gathered. This level of permission is required for the Filter to be able to run on all the web pages that you visit (in the options you can control which pages it actually runs on). It can "change" all data on the websites you visit so that it can modify the page to filter profanity/undesired text.
78

89
## Required Permissions
10+
911
- `contextMenus`: Provide shortcuts to common tasks
1012
- Add new words to Filter (current selection)
1113
- Toggle (enable/disable) the Filter for the current domain
@@ -20,4 +22,5 @@ This is the privacy policy for Advanced Profanity Filter. There are ***no extern
2022
- Ability to reload a tab after adjusting Filter options (enable/disable/adding a new word or phrase)
2123

2224
## Optional Permissions
25+
2326
- `file://*/*`: Allow the Filter to run on files stored on the local system.

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Advanced Profanity Filter
2+
23
[<img src="https://flat.badgen.net/chrome-web-store/users/piajkpdbaniagacofgklljacgjhefjeh?color=blue" alt="Chrome Web Store" width="71" height="20">](https://chrome.google.com/webstore/detail/advanced-profanity-filter/piajkpdbaniagacofgklljacgjhefjeh)
34
[<img src="https://flat.badgen.net/chrome-web-store/stars/piajkpdbaniagacofgklljacgjhefjeh?color=blue" width="102" height="20">](https://chrome.google.com/webstore/detail/advanced-profanity-filter/piajkpdbaniagacofgklljacgjhefjeh)
45
[<img src="https://flat.badgen.net/badge/icon/discord?icon=discord&label" alt="Discord" width="68" height="20">](https://discord.com/invite/MpE5Z3f)
@@ -13,6 +14,7 @@ A browser extension to filter profanity from webpages.
1314
For an overview of features and options, please head to the [wiki](https://github.com/FrostCo/AdvancedProfanityFilter/wiki).
1415

1516
## Installation
17+
1618
| Browser | Download |
1719
|---------|----------|
1820
| Chrome | [Chrome Web Store](https://chrome.google.com/webstore/detail/advanced-profanity-filter/piajkpdbaniagacofgklljacgjhefjeh) |
@@ -25,34 +27,38 @@ For an overview of features and options, please head to the [wiki](https://githu
2527
| TV Cast | [Instructions](https://github.com/FrostCo/AdvancedProfanityFilter/wiki/Audio#watch-on-tv) - [Discussion](https://github.com/FrostCo/AdvancedProfanityFilter/issues/206) |
2628

2729
## Features
30+
2831
* Filter modes
29-
* Censor - Hide offending words
30-
* Substitute - Replace offensive words
31-
* Remove - Remove offensive words
32+
* Censor - Hide offending words
33+
* Substitute - Replace offensive words
34+
* Remove - Remove offensive words
3235
* Customizable word and substitution lists
3336
* Works everywhere, including popular pages such as:
34-
* Facebook
35-
* Pinterest
36-
* Reddit
37-
* Twitter
37+
* Facebook
38+
* Pinterest
39+
* Reddit
40+
* Twitter
3841
* [Audio muting](https://github.com/FrostCo/AdvancedProfanityFilter/wiki/Audio) for videos on supported sites:
39-
* Amazon Video
40-
* Hulu
41-
* Netflix
42-
* Plex
43-
* Vudu
44-
* YouTube
45-
* And more! see [all supported sites here](https://apf.frostco.dev/status)
46-
* You can even add your own! ([advanced](https://github.com/FrostCo/AdvancedProfanityFilter/wiki/Custom-Audio-Muting-Site))
42+
* Amazon Video
43+
* Hulu
44+
* Netflix
45+
* Plex
46+
* Vudu
47+
* YouTube
48+
* And more! see [all supported sites here](https://apf.frostco.dev/status)
49+
* You can even add your own! ([advanced](https://github.com/FrostCo/AdvancedProfanityFilter/wiki/Custom-Audio-Muting-Site))
4750

4851
For a detailed overview of the features and settings, please see the [Getting Started page](https://github.com/FrostCo/AdvancedProfanityFilter/wiki).
4952

5053
## Issues, Suggestions or Feedback?
54+
5155
* Found a bug? Please open an [issue](https://github.com/FrostCo/AdvancedProfanityFilter/issues/new).
5256
* Have a great idea to improve the project? Want to share some feedback? Head over [here](https://goo.gl/forms/LTqFpJ0mCTsrgGgf2).
5357

5458
## Beta Testing
59+
5560
If you would like to help with development, but don't have experience coding, its very helpful to have users test a release candidate before actually publishing it to everyone. If you are interested in testing new versions see [this page](https://github.com/FrostCo/AdvancedProfanityFilter/wiki/Beta-Testing) for more information.
5661

5762
## Development
63+
5864
See [development.md](development.md) for development documentation.

development.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Development
2+
23
## Quick Start
4+
35
After downloading/cloning the repository, run the following commands to get started:
46

57
```sh
@@ -14,6 +16,7 @@ npm run build
1416
Once the extension has been built, you can load the unpacked extension (found in `dist/`) in your browser.
1517

1618
### Commonly Used Scripts
19+
1720
| Target | Manifest | Stage | Script | Description |
1821
|---------|---------:|---------|-----------------------------|-----------------------------------|
1922
| chrome | 3 | build | `npm run build:chrome:mv3` | Dev build for Chrome Manifest V3 |
@@ -22,22 +25,26 @@ Once the extension has been built, you can load the unpacked extension (found in
2225
| | | release | `npm run release:all` | Official relase for all targets |
2326

2427
## Build Targets
28+
2529
| Target | Manifest | Browsers |
2630
|------------|---------:|--------------------|
2731
| chrome | 2, 3* | Chrome, Edge, etc. |
2832
| edgeLegacy | 2 | Legacy Edge |
29-
| firefox | 2, 3 | Firefox |
33+
| firefox | 2*, 3 | Firefox |
3034

31-
_* = default target_
35+
\* = _default target_
3236

3337
## Build Stages
38+
3439
| Stage | Output | Description |
3540
|---------|---------------------------------------|---------------------------------------------------|
3641
| build | `dist/` | Build/compile the extension for local development |
3742
| release | `release/target-manifest-version.zip` | Create an official release for a target browser |
3843

3944
## State Files
45+
4046
The state files hold the details about the current build. These files are managed by `bin/prebuild.mjs`.
47+
4148
- `.build.json`
4249
- Active build state file that is referenced when building/packaging/releasing
4350
- Gets replaced by the dev or release build files outlined below
@@ -49,16 +56,20 @@ The state files hold the details about the current build. These files are manage
4956
- Overwrites `.build.json` when `--release` **is** passed to `bin/prebuild.mjs`
5057

5158
### Details Contained In State Files
59+
5260
- `config`: Overrides for the target
5361
- `manifestVersion`: Manifest version from `src/static/manifest.json`
5462
- `target`: Target browser
5563
- `version`: Build version from `package.json`
5664

5765
## Scripts
66+
5867
For all scripts, please see `package.json`.
5968

6069
## Build Chains
70+
6171
### Build (Load Last Target From File)
72+
6273
- `npm run build`
6374
- npm run prebuild
6475
- npm run clean:build
@@ -72,6 +83,7 @@ For all scripts, please see `package.json`.
7283
- node bin/postbuild.mjs
7384

7485
### Build Chrome Manifest V2
86+
7587
- `npm run build:chrome:mv2`
7688
- npm run build --target=chrome-mv2
7789
- npm run prebuild
@@ -86,6 +98,7 @@ For all scripts, please see `package.json`.
8698
- node bin/postbuild.mjs
8799

88100
### Release Chrome Manifest V3
101+
89102
- `npm run release:chrome:mv3`
90103
- npm run release:build --target=chrome-mv3
91104
- npm run prerelease:build
@@ -101,6 +114,7 @@ For all scripts, please see `package.json`.
101114
- node bin/packageExtension.mjs
102115

103116
### Test Addon (Firefox Manifest V2)
117+
104118
- `npm run test:addon`
105119
- npm run release:build --target=firefox-mv2
106120
- npm run prerelease:build

0 commit comments

Comments
 (0)