Repolode
loeffel-io

loeffel-io/ls-lint

プロジェクト内のディレクトリ名とファイル名の命名規則を、.ls-lint.ymlで設定してチェックする高速なコマンドラインリンターです。

スター
2,430
フォーク
46
未解決の Issue
43
最終コミット
昨日

これは何?

ls-lintは、プロジェクト内のディレクトリ名とファイル名が、kebab-case、camelCase、PascalCaseなどの定義したルールに沿っているかをチェックします。ソースファイルと同じ場所にテストファイルなどの関連ファイルが存在することも必須にできます。ルールは1つ以上の.ls-lint.ymlファイルに記述し、パスのパターンごとに適用する命名規則を指定します。

あらゆるファイル拡張子とUnicodeの名前に対応し、Windows、macOS、Linuxで動作します。スタンドアロンバイナリのほか、npm、Homebrew、Dockerからインストールできます。CIで実行するためのGitHub Actionも利用できます。ignoreパターンを使えば、node_modulesなどのディレクトリをチェック対象から除外できます。

Goで実装されており、YAMLの解析とglobマッチング用の小規模なライブラリをいくつか使うだけです。

主な機能

  • 01.ls-lint.ymlファイルでパスパターンごとに命名規則を定義
  • 02kebab-case、camelCase、PascalCase、正規表現ベースのパターンに対応
  • 03テストなどの関連ファイルが存在することを必須にできる
  • 04あらゆるファイル拡張子とUnicodeの名前に対応
  • 05ignoreパターンでnode_modulesなどのディレクトリをチェック対象から除外

ユースケース

  • フロントエンドやモノレポのコードベース全体でファイル名の一貫性を保つ
  • プルリクエストのマージ前にCIでファイル名の規則をチェックする
  • 各コンポーネントのディレクトリに必須のテストファイルが含まれているか確認する

クイックスタート

  1. 1

    README に記載されている npm パッケージ @ls-lint/ls-lint、Homebrew formula、または Docker image をインストールします

  2. 2

    ディレクトリとファイル名の命名規則を定義する .ls-lint.yml ファイルを作成します

トピック

よくある質問

ls-lint とは?
プロジェクト内のディレクトリ名とファイル名の命名規則を、.ls-lint.ymlで設定してチェックする高速なコマンドラインリンターです。 ls-lintは、プロジェクト内のディレクトリ名とファイル名が、kebab-case、camelCase、PascalCaseなどの定義したルールに沿っているかをチェックします。ソースファイルと同じ場所にテストファイルなどの関連ファイルが存在することも必須にできます。ルールは1つ以上の.ls-lint.ymlファイルに記述し、パスのパターンごとに適用する命名規則を指定します。
ls-lint は無料で使えますか?ライセンスは?
ls-lint は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
ls-lint は今もメンテナンスされていますか?
活発にメンテナンス中。ls-lint の最終コミットは 2026年10月21日 です。
ls-lint は何に使えますか?
フロントエンドやモノレポのコードベース全体でファイル名の一貫性を保つ プルリクエストのマージ前にCIでファイル名の規則をチェックする 各コンポーネントのディレクトリに必須のテストファイルが含まれているか確認する
ls-lint のインストール方法は?
README に記載されている npm パッケージ @ls-lint/ls-lint、Homebrew formula、または Docker image をインストールします ディレクトリとファイル名の命名規則を定義する .ls-lint.yml ファイルを作成します
ls-lint はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/loeffel-io/ls-lint

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト