Ruboty | Ruboty Handler Plugin 作成時に公開するための Markdown 形式の技術エントリ テンプレートジェネレータ ruboty-articlegen を作成した #ruboty
概要
Ruboty Handler Plugin 作成時に公開するための Markdown 形式の技術エントリ テンプレートジェネレータ ruboty-articlegen を作成した
前提
出力フォーマットは Qiita Markdown を前提にしています。
用途
Ruboty の Handler Plugin を作成した場合、周りに周知する意味で
Qiitaなどの技術エントリやブログのエントリを作成する方は多いと思います。
Ruboty の Plugin などは人によっては何度も作成するため、
記事の作成行為の中に WET (write every thing) な作業があるはずです。
そういった作業を DRY にするために、このジェネレータを利用します。
設定
内部DSL ( Rubotyarticlegen ) によって設定を行います。
| key | value | example |
|---|---|---|
| user_name user name | tbpgr | |
| gem_name | gem 名 | ume |
| title | タイトル文字列 | チャットを空メッセージ or 任意のメッセージで埋める ruboty-ume を作成しました |
| purpose | 用途 | ruboty google_image で妙な画像を引き当ててしまった。 そんなときに限って、偉い人が近づいてくる。 急いでチャット画面から画像を追い出すんだ。 内緒のメッセージのやりとり。 そんなときに限って、内緒のやりとりがばれるとまずい相手が近づいてくる。 急いでチャット画面から画像を追い出すんだ。 そんな時に空行を大量に追加してメッセージを画面外に追い出します。 |
| env/name | 環境変数 | DEFAULT_UME_TEXT |
| env/description | 環境変数の説明 | default ume text |
| dependencies/name | 依存先名称 | Ume API |
| dependencies/description | 依存先説明 | Ume API の説明やURL |
| commands/command name | Ruboty::Handler.on の name に設定する内容 ※件数分 | ume |
| commands/command pattern | Ruboty::Handler.on の pattern に設定する内容 ※件数分 | /ume (?.*?)\z/ |
| commands/command description | Ruboty::Handler.on の description に設定する内容 ※件数分 | output empty message N lines ( times) |
| commands/command example | 実行例 | ※コンソールでの実行例 |
設定例
# encoding: utf-8
user_name "tbpgr"
gem_name "ume"
title "チャットを空メッセージ or 任意のメッセージで埋める ruboty-ume を作成しました"
purpose <<-PURPOSE
ruboty google_image で妙な画像を引き当ててしまった。
そんなときに限って、偉い人が近づいてくる。
急いでチャット画面から画像を追い出すんだ。
内緒のメッセージのやりとり。
そんなときに限って、内緒のやりとりがばれるとまずい相手が近づいてくる。
急いでチャット画面から画像を追い出すんだ。
そんな時に空行を大量に追加してメッセージを画面外に追い出します。
PURPOSE
env do |e|
e.name "ENV1"
e.description "ENV1 desc"
end
env do |e|
e.name "ENV2"
e.description "ENV2 desc"
end
dependency do |d|
d.name "dependency1"
d.description "dependency1 description"
end
dependency do |d|
d.name "dependency2"
d.description "dependency2 description"
end
command do |c|
c.name "ume"
c.pattern "/ume (?<count>.*?)\z/"
c.description "output empty message N lines (<count> times)"
c.example <<-EXAMPLE
>ruboty command1
>result1
EXAMPLE
end
command do |c|
c.name "umec"
c.pattern "/umec (?<text>.+?) (?<count>.*?)\z/"
c.description "output <text> message N lines (<count> times)"
c.example <<-EXAMPLE
>ruboty command2
>result2
EXAMPLE
end
出力例
参照
ruboty-articlegen GitHub
ruboty-articlegen RubyGems
Ruboty関連記事
Ruboty | Ruboty Handler Plugin 作成時の README テンプレートジェネレータ ruboty-megen を作成した #ruboty