メインコンテンツまでスキップ

PlantUMLの正規表現を使ってみた

· 約2分
hoh
hoh

PlantUMLで正規表現が使えるのでサンプルを作ってみました

ブランチ命名規約

記述例​

PlantUML diagram

コードがこちら

@startregex
^((feature|bugfix|hotfix)\/\p{issue_id}-\p{summary}-\p{date(yyyymmdd)}|revert\/\p{commit_hash})$
@endregex

他のPlantUML用途例​

MindMap機能を使って組織図を書いたりできます

PlantUML diagram
@startmindmap
* PM: Sagat
** Frontend PL: Ryu
*** aa
*** bb
** Backend PL: Ken 
*** cc
*** dd
@endmindmap

Excel設計書との比較​

設計書としてExcelのシェイプ使ったりするのをよく見かけるけど...

  • シェイプ内の文字が検索できない (VBAを使えばできますが面倒なことには変わらない)
  • Excelファイルを開かないと見れない
  • バージョン管理に向いていない

SharePointを使ったバージョン管理もありますが、ファイルのコピーや移動で簡単に履歴が失われることがあり、管理するにはちょっと弱い。

だから、PlantUMLやMermaidを利用して設計をテキストベースで管理することを推奨します。
ぜひ導入を検討してみてください。

おまけ​

英語表示したときにサイドバーのタイトルが日本語のままなのはDocusaurusが原因。

以下が原因

https://github.com/facebook/docusaurus/issues/8996

回避策もあるけど、面倒なので解決してくれるのを待ちます。