Torisetsuに海外の方から2starもらえたので前から欲しかったなーと思っていた機能を実装しました。
リポジトリはこちら。 github.com
自作テンプレート機能
どんな機能かというと、今までは決まったREADME.mdの形にしか更新できませんでした。
Overview ## Description ## Demo ## VS. ## Requirement ## Usage ## Install ## Contribution ## License [MIT](https://github.com/tcnksm/tool/blob/master/LICENCE) ## Author [](https://github.com/)
ただこれだとイチイチ要らないところとかを削らないといけないし、モノによっては全然違うREADME.mdが使いたいってのがありました。
なので、特定の場所に自作テンプレートを置くことでこれらを解決しようとやってみました。
使い方
使いたい自作テンプレートを ~/.torisetsu/
の下に置いてもらい、torisetsuコマンド実行時にその名前を指定するって感じで使います。
試しに、 ~/.torisetsu/sample.md
ってのを作って使ってみます。
sample.md
概要 ## 説明 ## デモ ## 類似技術との相違点 ## 必要なライブラリ等 ## 使い方 ## インストール ## コントリビューション
で、以下の形で実行します。
$ torisetsu -t sample
するとREADME.mdにsample.mdの内容が書き込まれます。
LicenseとかAuthorとかも書き込めるようにするにはこんな感じにします。
sample.md
概要 ## 説明 ## デモ ## 類似技術との相違点 ## 必要なライブラリ等 ## 使い方 ## インストール ## コントリビューション ## ライセンス torisetsu.license ## 作者 torisetsu.author
で、実行すると
$ torisetsu -t sample -a syossan27 -l mit
README.md
概要 ## 説明 ## デモ ## 類似技術との相違点 ## 必要なライブラリ等 ## 使い方 ## インストール ## コントリビューション ## ライセンス [MIT](https://github.com/tcnksm/tool/blob/master/LICENCE) ## 作者 [syossan27](https://github.com/syossan27)
こんな感じで吐き出されます。
あと、テンプレート指定するのダルいしデフォルトで吐かれるテンプレートを指定したいってための機能も実装しました。
default.md
というテンプレートを先ほどの場所に置いてもらえると、 -t
で指定しなくてもそのテンプレートが使用されるようになります。
という感じの機能を実装してみました。 「もっとこんな感じの機能欲しい!」とか「実装クソだな!ペッ!」とか「バグってんじゃねーか!これ!」みたいなのがありましたら、 お気軽にISSUEやPull Requestを投げちゃってくださいー。