kabirgh / spoiler-blocker Goto Github PK

License: Apache License 2.0

JavaScript 98.78% HTML 1.22%

spoiler-blocker's Introduction

Spoiler Blocker

An open-source browser extension that removes Facebook and Twitter posts that contain user-defined 'spoiler' words. For example, a post containing the words 'GoT' and 'Daenerys' may be a spoiler for Game of Thrones. If any of these words are defined as 'spoiler' words, the post will be hidden.
You can also find and submit lists at the companion website.
See this YouTube video for a demonstration.

Installation

Chrome:
To install from source, download the latest release and follow the instructions here. When prompted to select the extension directory, choose the /dist folder.
Firefox:
Follow the instrutions here, choosing a file in /dist when prompted.

In the pipeline

Facebook post/tweet only hidden if tag (eg. 'westworld') is surrounded by spaces (eg. ' westworld ')

Acknowledgements

This project makes use of

spoiler-blocker's People

Contributors

Stargazers

Watchers

spoiler-blocker's Issues

Update README to reflect removal of dist/ folder

Point the user to latest release, instead of cloning the repo

Add list button - click to close

Should we make it so that if the Add button is clicked a second time, the AddCard closes?

Allow downloading of lists from companion website using list ID

Creating a test suite

I'd like to get a continuous integration/deployment process running so that we can merge pull requests without manually verifying that theyre working. Looking for feedback on how to do this.
Resources I've been looking at:

Overlay covers lines separating posts in Twitter

It looks like this:

Far as I can tell this is not showing up on Facebook, where posts are separated by a wider line.

Possible fix is to reduce the percentage height of the overlay, but this may cause it to shorten too much on FB. Alternatively, the height of the overlay could differ for FB and Twitter...

Add tick after successful title edit

Add a 2 second tick when the title of a spoiler list is successfully changes.

Using the same implementation as the tags field doesn't work - the constructor for SpoilerCardContainer is called again, which resets the shouldShowTitleTick variable to false. This doesn't happen for the tags.

Creating a list with a space at the end of its title adds two lists

To reproduce:

Create list with title (remove the < >)
Click Create

Two lists with the title testing are added.

Case-insensitive Titles

I noticed the list titles are case-insensitive, in the sense that if I create a list with the title asf, I cannot create another with title ASF.
Thinking about whether we should treat them in this way, though it does seem unlikely anyway that the user would want to create two lists with the same name but different cases.

Ads blocked by the AdBlock extension are also targeted by the program

For example, in the image below, AdBlock removed an ad between the 2 posts, but an overlay was placed on top of it:

Create an options page

Edit default preferences like

case sensitivity,
hide/overlay,
number of lists to show before displaying 'see more'

Drag and Drop lists

Should we sort lists alphabetically by title?

Also, should we move inactive lists to the bottom of the panel?

Escape Key clear for Toast

The Toast contains these properties:

this.toaster = Toaster.create({
  className: "top-toaster",
  autoFocus: false,
  canEscapeKeyClear: true,
  position: Position.TOP
});

I think the canEscapeKeyClear doesn't gain anything from being true since pressing Esc closes the entire panel.