https://github.com/tarlepp/unibot-fakerjs
UniBot plugin to wrap faker.js functionality to bot.
https://github.com/tarlepp/unibot-fakerjs
Last synced: about 1 year ago
JSON representation
UniBot plugin to wrap faker.js functionality to bot.
- Host: GitHub
- URL: https://github.com/tarlepp/unibot-fakerjs
- Owner: tarlepp
- License: mit
- Created: 2015-06-16T18:49:42.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-24T22:25:46.000Z (over 2 years ago)
- Last Synced: 2024-04-09T21:52:34.286Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unibot-fakerjs
UniBot plugin to wrap [faker.js](https://github.com/marak/faker.js) functionality to bot.
## Install
To your UniBot application. Remember to restart your bot after installation.
```npm install git://github.com/tarlepp/unibot-fakerjs --save```
And after that register plugin on IRC channels where you want to use it.
```plugin [#channel] fakerjs```
## Usage
Currently plugin supports following commands.
### !faker [section] [command]
This command will just call specified faker.js generator and outputs results. See http://marak.com/faker.js/ for usage
examples. Usage eg. ```!faker name firstName```.
### !bs
Shortcut for ```!faker company bs``` to get some company bullshit.
### !company
Shortcut for ```!faker company catchPhrase``` to get company catch phrase.
### !hacker
Shortcut for ```!faker hacker phrase``` to get hacker phrase.
## Configuration
None, atm.
## Todo
* List of sections?
* list of commands of specified section?
* Localization?
* Configuration?
* More shortcuts?
## Libraries that plugin uses
* [faker.js](https://github.com/marak/faker.js) - generate massive amounts of fake data in Node.js and the browser
* [lodash](https://lodash.com/) - A JavaScript utility library delivering consistency, modularity, performance