TypeScript を使っていて、「この関数、他のディレクトリからはアクセスして欲しくないんだけどテストのために export しなきゃ行けないな…」みたいなケースありませんか?実は、ESLint でうまく設定してやると解決できます!今回はその方法を紹介します。
お急ぎ開け口
- eslint-plugin-import をインストール
- print-allowed-dir.sh を書く
- print-allowed-dir.sh を使って eslint の設定を書く
詳しくは以下のデモリポジトリを参照ください。
github.com
eslint-plugin-import とは?
eslint-plugin-import は外部モジュールへのアクセスの仕方を設定するプラグインです。(外部モジュールとは、同一階層でないディレクトリとだいたい同義です)
たとえば、以下のように eslint-plugin-import の設定をすると、今回やりたいことが実現できます。
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:import/typescript',
],
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 12,
sourceType: 'module',
},
plugins: ['@typescript-eslint', 'import'],
rules: {
'import/no-internal-modules': [
'error',
{
allow: ['**/dir/*', '**/dir-including-index/index.ts'],
},
],
},
};
src/
- dir/
- reachable.ts
- dir-including-index/
- index.ts
- internal.ts
上の eslint 設定の場合、このディレクトリ構成に対して以下のようなアクセス制限がなされます。
- dir/reachable.ts にはどこからでもアクセス可能
- dir-including-index/internal.ts は dir-including-index/index.ts のみアクセス可能(同一階層のため)
- dir-including-index/index.ts にはどこからでもアクセス可能
うまくやりたいことが実現できました。しかし、いちいち各ディレクトリへのアクセス制限を手動で書くのは馬鹿馬鹿しいですよね。というわけで自動化します。
ディレクトリ列挙を自動化する
いちいち index.ts が含まれたフォルダを探して設定をしていたのでは面倒なので、Shell Script を書いて列挙を自動化しましょう。
以下の Shell Script を print-allowed-dir.sh と名付けて保存してください。実行権限の付与をお忘れなく。
この shell script は以下のことをしています
- ディレクトリを再帰的に全て列挙し、そのうちindexファイルが直下にあるものを除外
- index ファイルを列挙
- 列挙したファイル、ディレクトリを整形
#!/bin/bash
list_directories() {
find ./src -type d
}
list_index_files() {
find ./src -type f -name 'index\.*'
}
subtract() {
diff "$1" "$2" | grep '^< ' | sed -e 's/< //'
}
(
subtract <(list_directories) <(list_index_files | xargs -I{} dirname {} | uniq) | sed -e 's/$/\/*/'
list_index_files
) | sed -e 's/\.\/src/**/' | sed -e '/\*\*\/\*/d'
あとはこれを使って設定できるように .eslintrc.js を書き換えます。
const { execSync } = require('child_process');
const allowList = `${execSync('./print-allowed-dir.sh')}`
.replace(/\n$/, '')
.split('\n');
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:import/typescript',
],
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 12,
sourceType: 'module',
},
plugins: ['@typescript-eslint', 'import'],
rules: {
'import/no-internal-modules': [
'error',
{
allow: allowList,
},
],
},
};
(この記事は同様のことをしてくれるESLintプラグインが見当たらなくて書いたので、同じことをしてくれるプラグインがあれば紹介してほしいです)
おまけ: testディレクトリからはすべてのファイルにアクセス可能とする
ESLint なので、overrides をうまく使うことで様々なことができます。一例として、src
ディレクトリ以下のファイルに対しては上の制限を敷くが、test
ディレクトリには敷かないということをやってみます。
const { execSync } = require('child_process');
const allowList = `${execSync('./print-allowed-dir.sh')}`
.replace(/\n$/, '')
.split('\n');
module.exports = {
overrides: [
{
files: ['src/**/*'],
rules: {
'import/no-internal-modules': [
'error',
{
allow: allowList,
},
],
},
},
{
files: ['test/**/*'],
rules: {
'import/no-internal-modules': 'off',
},
},
],
};
これで、src以下のファイルたちにはアクセス制限を掛けられつつ、test からは自由に private 関数へアクセスできます。