Giter VIP home page Giter VIP logo

checky's Introduction

checky (0.3.2)

A Steem bot that checks if the users mentioned in a post exist on the blockchain. If they don't, it indicates to authors that they may have made a typo or it suggests them some existing usernames close to the wrong ones.

See this bot in action here: https://steemit.com/@checky/comments

Deploy

Required: Git, NPM, Node.js
While not recommended since @checky already uses this script, here is how you can deploy this bot yourself.

  1. Install
git clone https://github.com/RagePeanut/checky.git
cd checky
npm install
  1. Set a CHECKY_PRIVATE_KEY environment variable
  2. Start the bot
npm start

Configuration

You can change a few things in the config.json file, mainly for testing purposes.

  • log_errors - whether or not you want to log Steem related errors (broadcast, stream and api) to the console (default: false).
  • fail_safe_node - a safe node to use if @fullnodeupdate returns an empty array on its first call (default: https://api.steemit.com).
  • test_environment - whether or not you are running the bot in a test environment, being in a test environment logs to the console instead of broadcasting to the blockchain (default: false).

Commands

The following commands must be typed in reply to one of @checky's posts or comments and not be preceded by any text to work.

  • !case [sensitive-insensitive] - sets the case sensitivity of the mentions checking to sensitive (lowercase only) or insensitive (lowercase and uppercase).
  • !delay minutes - tells the bot to wait X minutes before checking your posts.
  • !help - gives a list of commands and their explanations.
  • !ignore username1 username2 - tells the bot to ignore some usernames mentioned in your posts (useful to avoid the bot mistaking other social network accounts for Steem accounts).
  • !mode [regular-advanced-off] - sets the mentions checking to regular (only posts), advanced (posts and comments) or off (no checking). Alternatively, you can write normal or on instead of regular. You can also write plus instead of advanced.
  • !off - shortcut for !mode off.
  • !on - shortcut for !mode on.
  • !state - gives the state of your account (regular, advanced or off).
  • !switch [regular-advanced-off] - same as !mode.
  • !unignore username1 username2 - tells the bot to unignore some usernames mentioned in your posts.
  • !wait minutes - same as !delay.
  • !where username1 username2 - asks the bot to show where in the post it found typos for the specified mentions. Alternatively, you can write this command with no parameters and it will show you where it found all the mentions with typos in them.

Social networks

Steemit: https://steemit.com/@ragepeanut
Busy: https://busy.org/@ragepeanut
Twitter: https://twitter.com/RagePeanut_
Steam: http://steamcommunity.com/id/ragepeanut/

Follow me on Steemit or Busy to be informed on my new releases and projects.

checky's People

Contributors

ragepeanut avatar

Stargazers

 avatar

Watchers

 avatar  avatar

checky's Issues

Highlight differences

It can be hard to see what the difference is between a wrong mention and its suggested correction. The bot should put transposed, inserted and replaced characters in bold in the suggested correction. In order to show the difference for deletes, it could also put affected characters in bold in the wrong username.

Ignore mentions in image alts

If a mention is found in a text like ![...@mention...](source) or <img src="source" alt="...@mention...">, it shouldn't be checked as it often relates to the name of an uploaded image.

Logo

Hello, I am a logo designer and I'm a utopian contributor. I saw your project and I want to make a logo for it. So, what do you think?

Add a details command

The bot should store in its json_metadata the 40 words surrounding each wrong mention. If a user replies to his comment with something like "!details mention" the bot should reply with something like this :

The mention @mention has been detected in this part of the text :

40 words surrounding @mention in the text

If "mention" is not specified in the command's arguments, the reply will contain all the wrong mentions.

Add checking for popular tags

When no correction is found the bot should check if the wrong mention is actually a popular tag. A lot of users use the @ character instead of a hashtag when talking about tags. If it indeed is a popular tag, send a message where the correction for @mention is #mention.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.