@tokiumjp/arch

概要

ソースコードの配置を管理するツールです。
arch.ymlで定義した構造をもとに、違反しているファイル・ディレクトリを検出します。

``yml
- directory: src
description: ソースコードのルートディレクトリです。
allow: all
subdirectories:
- directory: controllers
description: コントローラーに関するディレクトリです。
allow: subdirectories
subdirectories:
- directories: users
description: ユーザーに関するコントローラーです。
allow: files
`

このymlに対して、実際には下記のようなディレクトリ構成があったとします。
`bash
- src
- controllers
- users
- index.js
- show.js
- edit.js
- posts
- index.js
- show.js
- edit.js
`

この場合、posts配下はarch.ymlで定義されていないため、エラーが発生します。
`bash
$ arch check --config arch.yml --input src

Invalid files:
- src/controllers/posts/index.js
- src/controllers/posts/show.js
- src/controllers/posts/edit.js
`

ファイル配置を許可するには、subdirectoriesに配置するか、別のymlファイルを作成してincludesに指定します。
`yml


arch-post.yml


- directory: posts
description: 投稿に関するディレクトリです。
allow: files
`

`yml


arch.yml

- directory: src
description: ソースコードのルートディレクトリです。
allow: all
subdirectories:
- directory: controllers
description: コントローラーに関するディレクトリです。
allow: subdirectories
subdirectories:
- directories: users
description: ユーザーに関するコントローラーです。
allow: files
includes:
- arch-post.yml

`

使い方


`bash
$ npm install -g @tokiumjp/arch
`

$3

checkコマンドで、指定したアーキテクチャ定義のyamlファイルと、実際のファイル配置をチェックすることができます。
inputにはディレクトリ・ファイルを指定でき、ディレクトリを指定した場合は配下のファイルを再帰的にチェックします。
`bash
$ arch check --config --input
`

$3

coverageコマンドで、指定したアーキテクチャ定義のyamlファイルと、実際のファイル配置の乖離を計測することができます。
inputにはディレクトリ・ファイルを指定でき、ディレクトリを指定した場合は配下のファイルを再帰的にチェックします。
`bash
$ arch coverage --config --input
`

開発

$3

devcontainerを用意しています。vscodeのRemote-Containers拡張をインストールして、Remote-Containers: Reopen Folder in Container`を実行すると、開発環境が構築されます。