https://github.com/jacoblincool/suggestion-bot

It will give you some suggestions on how to improve your text style. Based on Pure Cat framework.
https://github.com/jacoblincool/suggestion-bot

discord

Last synced: 21 days ago
JSON representation

It will give you some suggestions on how to improve your text style. Based on Pure Cat framework.

• Host: GitHub
• URL: https://github.com/jacoblincool/suggestion-bot
• Owner: JacobLinCool
• License: mit
• Created: 2022-10-04T18:00:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T17:28:41.000Z (about 1 year ago)
• Last Synced: 2024-04-23T14:05:32.531Z (10 months ago)
• Topics: discord
• Language: TypeScript
• Homepage: https://discord.com/oauth2/authorize?client_id=1026910413067137054&permissions=274877910016&scope=bot
• Size: 132 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Text Style Bot (Linter)

It will give you some suggestions on how to improve your text style. _Based on Pure Cat framework._

> [![invite the bot](invite-this-bot.svg)](https://discord.com/oauth2/authorize?client_id=1026910413067137054&permissions=274877910016&scope=bot)

![https://i.imgur.com/K8Ec91k.png](https://i.imgur.com/K8Ec91k.png)

## Features

- [x] Insert a space between Chinese and English characters.

- [x] Make proper nouns case correct. (e.g. `macos` -> `macOS`)

- [x] Change Simplified Chinese to Traditional Chinese.

- [x] Custom suggestion rules. (Up to 100 rules per channel)

- [x] Support i18n commands. (English, Traditional Chinese)

## Module and Commands

- `!linter lang help`: I18n Module Controller

- `!linter help`: Suggestion Module Controller

## Setup

1. `.env` file

2. `docker compose up -d`

## Screenshots

![https://i.imgur.com/ZUu0CPl.png](https://i.imgur.com/ZUu0CPl.png)

![https://i.imgur.com/srVjaaf.png](https://i.imgur.com/srVjaaf.png)

![https://i.imgur.com/88J8uM1.png](https://i.imgur.com/88J8uM1.png)

## Credits

This bot will not be possible without the following projects:

- [`pangu`](https://github.com/vinta/pangu.js)

- [`opencc`](https://github.com/BYVoid/OpenCC)

- [`case-police`](https://github.com/antfu/case-police)

- [`discord.js`](https://github.com/discordjs/discord.js)