▽Copy/Cut/Paste/Hatena ●04/18 21:49 2021-11-30 せめてﾘﾎﾟｼﾞﾄﾘの各ﾃﾞｨﾚｸﾄﾘの概要説明だけでも欲しい思ったので dirmap というﾂｰﾙを作ってみた Go 既存の開発に参加するときや､0->1の開発をしているとき､いつも｢せめてﾘﾎﾟｼﾞﾄﾘの各ﾃﾞｨﾚｸﾄﾘの概要説明だけでも欲しい｣と思っていました｡ 既存のﾌﾟﾛｼﾞｪｸﾄに参加するときは｢ﾌﾟﾛｼﾞｪｸﾄの理解をする側｣､0->1のﾌﾟﾛｼﾞｪｸﾄで開発をしているときは｢説明をする側の立場｣で､です｡ Ruby on Railsのような基本のﾃﾞｨﾚｸﾄﾘﾚｲｱｳﾄ決まっていてもそのﾌﾟﾛｼﾞｪｸﾄの独自性がでてきますし､Goのようにｽﾀﾝﾀﾞｰﾄﾞなﾚｲｱｳﾄがないのであればなおさら初見ではわかりません｡ ｢じゃあREADME.mdにでも書いておけばいい｣というのはその通りです｡ ただ､概要説明であっても一度書いたら終わりではなく､更新は必要になります｡特に0->1のﾌﾟﾛｼﾞｪｸﾄの初期ではﾃﾞｨﾚｸﾄﾘﾚｲｱｳﾄすら途中で変わるということはままあります｡ （ここらへんは｢継続的ﾄﾞｷｭﾒﾝﾃｰｼｮﾝ｣として私の興味のある分野です｡私のSpeaker Deckのﾄﾞｷｭﾒﾝﾄ系の発表は大体が継続的ﾄﾞｷｭﾒﾝﾃｰｼｮﾝにつながっています） そこで､できるだけ簡単に各ﾃﾞｨﾚｸﾄﾘの概要説明を実現するために dirmap というﾂｰﾙを作ってみました｡ GitHub - k1LoW/dirmap: dirmap is a tool for generating a directory map. :file_folder: dirmap is a tool for generating a directory map. - GitHub - k1LoW/dirmap: dirmap is a tool for generating a directory map. github.com github.com dirmap dirmapはﾃﾞｨﾚｸﾄﾘを再帰的に走査して各ﾃﾞｨﾚｸﾄﾘの｢概要を説明していそうな箇所の文字列｣を取得し｢各ﾃﾞｨﾚｸﾄﾘの概要説明＝ﾃﾞｨﾚｸﾄﾘﾏｯﾌﾟ｣を生成するﾂｰﾙです｡ たとえば dirmap のﾘﾎﾟｼﾞﾄﾘﾙｰﾄで dirmap generate を実行すると以下のような tree に近い出力を得ることができます｡ $ dirmap generate . ├── .github/ │ └── workflows/ ├── cmd/ ... Commands. ├── config/ ... Configuration file. ├── matcher/ ... Implementation to find the string that will be the overview from the code or Markdown. ├── output/ ... Output format of the directory map. ├── scanner/ ... Implementation of scanning the target directory and its overview from the file system based on the configuration. ├── scripts/ ... scripts for Dockerfile. └── version/ ... Version. この Commands. や scripts for Dockerfile. のような概要っぽい文字列はどこから取得しているかというと､｢そのﾃﾞｨﾚｸﾄﾘにあるMarkdownﾌｧｲﾙの見出しではない最初のﾊﾟﾗｸﾞﾗﾌ｣や｢そのﾃﾞｨﾚｸﾄﾘにあるGoのｿｰｽｺｰﾄﾞに書かれているgodocのpackages Overviewにあたる部分｣などです｡ このように｢そのﾃﾞｨﾚｸﾄﾘにあるﾌｧｲﾙからそのﾃﾞｨﾚｸﾄﾘの説明となる文章を抽出すれば､各ﾃﾞｨﾚｸﾄﾘの概要説明の管理も最小限になるだろう｣という算段です｡ ｢概要っぽい文字列｣の取得ﾙｰﾙは設定ﾌｧｲﾙを渡すことで変更も可能です｡built-inな markdown markdownHeading godoc 以外にも正規表現ﾏｯﾁもｻﾎﾟｰﾄしています｡ 設定ﾌｧｲﾙは dirmap init で生成可能です｡書かれている設定は dirmap のﾃﾞﾌｫﾙﾄ設定（設定ﾌｧｲﾙなしの場合の挙動と同じ）になります｡ $ dirmap init Create .dirmap.yml # $ cat .dirmap.yml targets: - file: .dirmap.md matcher: markdown - file: README.md
