<commit_before>IRCBOT
======

Yet another IrcBot

Installation
============

```
$ git clone ....

# set environment variables

$ set IRCBOT_NICKNAME "botname"
$ set IRCBOT_SERVER "irc.freenode.net"
$ set IRCBOT_NICKSERV "nickserv-password"

$ set IRCBOT_CHANNELS "#StuttgartJS,#StuttgartJS-Links"

$ set IRCBOT_MEETUP_GROUPNAMES "stuttgartjs,Web-Dev-BBQ-Stuttgart"
$ set IRCBOT_MEETUP_API_KEY "CHANGE_IT"

$ set DEBUG=*    // see https://www.npmjs.org/package/debug
```

Copy config.js to ex. myConfig.js

```
$ node index.js --config myConfig.js
```

Plugins
=======

Activate plugins in your custom config.js

### RSS

retrieve feeds and send new items to the channel(s)

```
-	!rss : print status (ON or OFF)
-	!rss on : activate channel news posting
-	!rss off : deactivate channel news posting
-	!rss lastest : get latest news
-	!rss lastest 5 : get the 5 latest news
-	!rss feeds : list all feeds
```

```
config.plugins.rss: {
    channels: ['#StuttgartJS-Links'],   // only active in this channels
    defaultLimit: 3,                    // limit for rss latest
    maxLimit: 7,                        // limit for rss latest
    checkFeedsTimer: 3,                 // after 3 pings check feeds
    feeds: ['http://echojs.com/rss']    // feed URLs
}
```

### Hello

Output welcome message when user joins the channel

```
config.plugins.hello: {
    salutation: 'Welcome, ',
    message: 'Send "!help" to get help'
}
```

### Meetup

-	!meetup : Output info for next StuttgartJS Meetup

```
config.plugins.meetup: {
    groupname: "stuttgartjs",
    api_key: " set -x IRCBOT_MEETUP_API_KEY 'CHANGE_IT' "
}
```

```
$ set -x IRCBOT_MEETUP_GROUPNAME "stuttgartjs"
$ set -x IRCBOT_MEETUP_API_KEY "CHANGE_IT"
```

### URLs

Save URLs from channel messages

-	!urls : get latest URLs
-	!urls 5 : get the 5 latest URLs

```
config.plugins.urls: {
    // for listing last saved urls
    maxLimit: 42,
    defaultLimit: 3
}
```

### Help

Output help :-)<commit_msg>fix docs for meetup plugin<commit_after>IRCBOT
======

Yet another IrcBot

Installation
============

```
$ git clone ....

# set environment variables

$ set IRCBOT_NICKNAME "botname"
$ set IRCBOT_SERVER "irc.freenode.net"
$ set IRCBOT_NICKSERV "nickserv-password"

$ set IRCBOT_CHANNELS "#StuttgartJS,#StuttgartJS-Links"

$ set IRCBOT_MEETUP_GROUPNAMES "stuttgartjs,Web-Dev-BBQ-Stuttgart"
$ set IRCBOT_MEETUP_API_KEY "CHANGE_IT"

$ set DEBUG=*    // see https://www.npmjs.org/package/debug
```

Copy config.js to ex. myConfig.js

```
$ node index.js --config myConfig.js
```

Plugins
=======

Activate plugins in your custom config.js

### RSS

retrieve feeds and send new items to the channel(s)

```
-	!rss : print status (ON or OFF)
-	!rss on : activate channel news posting
-	!rss off : deactivate channel news posting
-	!rss lastest : get latest news
-	!rss lastest 5 : get the 5 latest news
-	!rss feeds : list all feeds
```

```
config.plugins.rss: {
    channels: ['#StuttgartJS-Links'],   // only active in this channels
    defaultLimit: 3,                    // limit for rss latest
    maxLimit: 7,                        // limit for rss latest
    checkFeedsTimer: 3,                 // after 3 pings check feeds
    feeds: ['http://echojs.com/rss']    // feed URLs
}
```

### Hello

Output welcome message when user joins the channel

```
config.plugins.hello: {
    salutation: 'Welcome, ',
    message: 'Send "!help" to get help'
}
```

### Meetup

-	!meetup : Output info for next StuttgartJS Meetup

```
config.plugins.meetup: {
    groupnames: ["stuttgartjs", "Web-Dev-BBQ-Stuttgart"],
    api_key: " set -x IRCBOT_MEETUP_API_KEY 'CHANGE_IT' "
}
```

```
$ set -x IRCBOT_MEETUP_GROUPNAMES "stuttgartjs,Web-Dev-BBQ-Stuttgart"
$ set -x IRCBOT_MEETUP_API_KEY "CHANGE_IT"
```

### URLs

Save URLs from channel messages

-	!urls : get latest URLs
-	!urls 5 : get the 5 latest URLs

```
config.plugins.urls: {
    // for listing last saved urls
    maxLimit: 42,
    defaultLimit: 3
}
```

### Help

Output help :-)
{'fraction_non_alphanumeric': 0.1375687843921961, 'fraction_numerical': 0.005502751375687844, 'mean_word_length': 3.131198347107438, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6211725', 'n_tokens_mistral': 1519, 'n_tokens_neox': 1407, 'n_words': 399}