Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fazendaaa/i-m-a-spoiler-bot
A friendly Telegram bot to hide spoilers sent.
https://github.com/fazendaaa/i-m-a-spoiler-bot
boku-no-hero-academia bot spoilers telegraf telegram typescript
Last synced: about 8 hours ago
JSON representation
A friendly Telegram bot to hide spoilers sent.
- Host: GitHub
- URL: https://github.com/fazendaaa/i-m-a-spoiler-bot
- Owner: Fazendaaa
- License: mit
- Created: 2018-07-28T07:52:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T15:15:24.000Z (about 1 month ago)
- Last Synced: 2024-12-04T16:26:28.951Z (about 1 month ago)
- Topics: boku-no-hero-academia, bot, spoilers, telegraf, telegram, typescript
- Language: TypeScript
- Homepage: https://fazendaaa.github.io/I-m-a-Spoiler-Bot/
- Size: 150 MB
- Stars: 24
- Watchers: 3
- Forks: 7
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# I'm a Spoiler Bot
[](https://saythanks.io/to/Fazendaaa)
[](./README.md)
[](./documentation/readme/README_PT.md)
[](https://travis-ci.org/Fazendaaa/I-m-a-Spoiler-Bot)
[](https://codecov.io/gh/Fazendaaa/I-m-a-Spoiler-Bot)
[](https://www.codacy.com/app/Fazendaaa/I-m-a-Spoiler-Bot?utm_source=github.com&utm_medium=referral&utm_content=Fazendaaa/I-m-a-Spoiler-Bot&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/Fazendaaa/I-m-a-Spoiler-Bot/master/package.json)
[](https://snyk.io/test/github/fazendaaa/podsearch_bot?targetFile=package.json)
[](https://codeclimate.com/github/Fazendaaa/I-m-a-Spoiler-Bot/maintainability)
> A friendly Telegram bot to hide spoilers sent.
## About
Me and my friends were used to use a bot to send spoilers in the main group of anime discussions, but this bot doesn't works anymore. That's why I've decided to write my own version of this bot so we can continue to send each other messages without disturbing the others group members that haven't read manga chapter or watched the anime episode yet.
You can see how many spoilers have been sent so far here:
**note**: all of the spoilers are just stored for one week period!
### Disclaimer
By default all the commands are in English, but you can see if the same command is available in your language:
* [English](./others/locales/en.yaml)
* [Portuguese](./others/locales/pt.yaml)
* [Dutch](./others/locales/nl.yaml)
* [Spanish](./others/locales/es.yaml)
* [Turkish](./others/locales/tr.yaml)
* [Italian](./others/locales/it.yaml)
* [German](./others/locales/de.yaml)
* [French](./others/locales/fr.yaml)
* [Russian](./others/locales/ru.yaml)
* [Chinese](./others/locales/zh.yaml)
* [Japanese](./others/locales/jp.yaml)
# How to use it
First of all, talk to [@ispoilerbot](http://t.me/ispoilerbot).
**note**: urls are automatically shortened.
## Sending Spoilers
Basically there are two kinds of spoiler, those of _light_ weight, that won't ask the user to confirm to see it, and those of **heavy** weight, that will will ask permission to be displayed.
The inline mode works in any chat conversation:
```
@ispoilerbot spoiler to be sent here as text
```
Example:
```
@ispoilerbot L dies!
```
And you can also send a spoiler name it about what it is:
```
@ispoilerbot spoiler to be sent here as text "spoiler name"
```
Example:
```
@ispoilerbot L dies! "Death Note"
```
The heavy spoilers with:
And those lewd spoilers with -- I've added this option in a kind of future proofing if Apple changes it's [policies](https://www.businessinsider.com/apples-porn-policy-2013-1) again.
## Help
If you have any other questions about it just use it the help command:
```
/help
```
# How does it work?
You can build yourself a bot similar to this one, I've wrote a tutorial about it in my [Podesearch Bot](https://github.com/Fazendaaa/podsearch_bot) just follow the procedures listed in [BUILDING.md](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/building/BUILDING.md).
# Deployment
This bot is up and running at [Heroku](http://heroku.com/) through the Github integration, that means that each new push to the ```master``` branch means that is the code serving the bot. You can see more about how does it run at the server by looking at the [Procfile](https://github.com/Fazendaaa/I-m-a-Spoiler-Bot/blob/master/Procfile). You can also deploy yourself this bot into Heroku through:
[](https://heroku.com/deploy?template=https://github.com/Fazendaaa/I-m-a-Spoiler-Bot)
## Testing
Since there's a [Travis CI](http://travis-ci.org/) integration and [Codecov](https://codecov.io/). All of the tests were written with [Jest](https://facebook.github.io/jest/).
To run all tests just:
```bash
npm test
```
All of the [schedule](./src/lib/schedule) implementations are not tested since they only works as a "timer" to do some actions other actions previously implemented. And those in [stats](./src/lib/stats) also, since because those are files stats for the badge of spoilers sent.
If you ran into some errors related to package dependencies and want to know how to handle it, read the [Security](#security) info.
# Security
I've added a integration with [Snyk](https://snyk.io/) to ensure that all of my dependencies have no bugs or errors reported without fixing it first before Continuos integration (CI) to ensure the Continuos Development (CD).
## Errors/Bugs in Dependencies
When Snyk report some errors or bugs that can be fixed, just follow the CLI command to fix them before running -- more info at their [docs](https://github.com/snyk/snyk#cli).
# Build with
* [dotenv](https://github.com/motdotla/dotenv)
* [emoji-regex](https://github.com/mathiasbynens/emoji-regex)
* [mongoose](http://mongoosejs.com/)
* [node schedule](https://github.com/node-schedule/node-schedule)
* [telegraf](http://telegraf.js.org/#/)
* [telegraf-i18n](https://github.com/telegraf/telegraf-i18n)
* [telegraf-session-local](https://github.com/RealSpeaker/telegraf-session-local)
* [tiny-shortener](https://github.com/Fazendaaa/tiny-shortener)
# Code
Plain and simple [Typescript](http://typescriptlang.org/) and the [Microsoft linter standards](https://github.com/Microsoft/tslint-microsoft-contrib) for it.
# Artwork
I've made all the artwork for it, [Boku No Hero](http://bokunoheroacademia.wikia.com/wiki/My_Hero_Academia_Wiki) was my inspiration.
You can see more in the [img](./others/img) folder.
# Contributing
Please, I'm not a native/fluent english speaker, so whether you see a variable name wrote the wrong way or even some comment where I've wrote something with the wrong "past perfect way of life" or something like that, please let me know it. Not always is just about the code, but rather making it more clear to other people to learn from it.
So, whether is code or not you can help me out making this code more accessible by reading the [CONTRIBUTING.md](./documentation/contributing/CONTRIBUTING.md).
# Versioning
I would love to say that [SemVer](https://semver.org/) or anything like that is used but, in my personal experience, this kind of approach doesn't work very well with me, the guy who could be committing in this project for two weeks in a roll and leave it for almost one year with no simple ```npm update```. So, no versioning system is used.
# TODO
Since I will be keeping this README up to date with any major change and I don't use any versioning system to log all the fixed bugs or previous projects updates, you can still have a taste of what comes next and what is being under analysis right in the [Projects](https://github.com/Fazendaaa/I-m-a-Spoiler-Bot/projects/) tab.
# Authors
* Only [me](https://github.com/Fazendaaa) for now.
Consider buy me a coffee:
[](https://www.buymeacoffee.com/Fazenda)
Or even becoming a patron:
[](https://www.patreon.com/Fazenda/overview)
# License
Like many Open-Source Software (OSS) the MIT license is used, more about it in [LICENSE](./LICENSE).