SedRegex¶
Purpose¶
History replacer using sed-style expressions.
Usage¶
Enable SedRegex on the desired channels:
config channel #yourchannel plugins.sedregex.enable True
After enabling SedRegex, typing a regex in the form
s/text/replacement/
will make the bot announce replacements.
20:24 <jlu5> helli world
20:24 <jlu5> s/i/o/
20:24 <Limnoria> jlu5 meant to say: hello world
You can also do othernick: s/text/replacement/
to only replace
messages from a certain user. Supybot ignores are respected by the plugin,
and messages from ignored users will only be considered if their nick is
explicitly given.
Regex flags¶
The following regex flags (i.e. the g
in s/abc/def/g
, etc.) are
supported:
i
: case insensitive replacementg
: replace all occurences of the original texts
: (custom flag specific to this plugin) replace only messages from the caller
Configuration¶
- supybot.plugins.SedRegex.boldReplacementText
This config variable defaults to “True”, is network-specific, and is channel-specific.
Should the replacement text be bolded?
- supybot.plugins.SedRegex.displayErrors
This config variable defaults to “True”, is network-specific, and is channel-specific.
Should errors be displayed?
- supybot.plugins.SedRegex.enable
This config variable defaults to “False”, is network-specific, and is channel-specific.
Should Perl/sed-style regex replacing work in this channel?
- supybot.plugins.SedRegex.format
This config variable defaults to “$nick meant to say: $replacement”, is network-specific, and is channel-specific.
Sets the format string for a message edited by the original author. Required fields: $nick (nick of the author), $replacement (edited message)
- supybot.plugins.SedRegex.format.other
This config variable defaults to “$otherNick thinks $nick meant to say: $replacement”, is network-specific, and is channel-specific.
Sets the format string for a message edited by another author. Required fields: $nick (nick of the original author), $otherNick (nick of the editor), $replacement (edited message)
- supybot.plugins.SedRegex.ignoreRegex
This config variable defaults to “True”, is network-specific, and is channel-specific.
Should Perl/sed regex replacing ignore messages which look like valid regex?
- supybot.plugins.SedRegex.processTimeout
This config variable defaults to “0.5”, is not network-specific, and is not channel-specific.
Sets the timeout when processing a single regexp. The default should be adequate unless you have a busy or low-powered system that cannot process regexps quickly enough. However, you will not want to set this value too high as that would make your bot vulnerable to ReDoS attacks.
- supybot.plugins.SedRegex.public
This config variable defaults to “True”, is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.