sonicop 26.9.100 → 26.9.101

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a163c5bd6a8d400159bd4ba0f973dffb08ec9a588554d11ba4d1240962b7f4ed
4
- data.tar.gz: 23e90583b4aafc8fbe66ecee0202d0fedddf45ed75d90e6060a7d5fb77345343
3
+ metadata.gz: abbd5f8b1e9dc42497740fd5cd26cc24c29cb7665664870550fe4f6a20f8cb8a
4
+ data.tar.gz: d3f44aadc09ec1df049a798d0d36f296fa39bf2d738eb22c55d6b4ef8c432aaf
5
5
  SHA512:
6
- metadata.gz: 0cb9a7320c8bbbe4b3fa3d773486cf66460bc5f29eb43161226dd195566210ec7cab52757c4543a01a6d9f127e0508bcb3ccb9c1ddcd95dbc6908678a202115a
7
- data.tar.gz: faa62e145f9d96b10db86cf60a9a565a3c6033b8a4b28c994ecb76d99a1a4e8e79ed30775a85e1b512988117901f7b9ddb3ff19e9a8e9d116e34125a0eed03f2
6
+ metadata.gz: 4579d84ab3e333b030a83c5d474e5b317560b5372ff620e5d40af7c460f98173c07ff1ef92e98f632977891727c756c7b6bd69eb3176a2814fecca3968d52985
7
+ data.tar.gz: 3a4f13d0c79163cff5030c3ae08bd0111777d98451e45c7e5af67789896d5a3a5dbb452e87a39e2dbe744fbd0b204e9b4b30d1db40a21da95c58e2b7e3f6d428
data/Cargo.lock CHANGED
@@ -786,7 +786,7 @@ checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba"
786
786
 
787
787
  [[package]]
788
788
  name = "sonicop"
789
- version = "26.9.100"
789
+ version = "26.9.101"
790
790
  dependencies = [
791
791
  "anyhow",
792
792
  "assert_cmd",
data/Cargo.toml CHANGED
@@ -1,8 +1,8 @@
1
1
  [package]
2
2
  name = "sonicop"
3
- version = "26.9.100"
3
+ version = "26.9.101"
4
4
  edition = "2024"
5
- rust-version = "1.85"
5
+ rust-version = "1.98"
6
6
  description = "A fast, native RuboCop-compatible Ruby linter and formatter"
7
7
  license = "MIT"
8
8
  repository = "https://github.com/owayo/sonicop"
@@ -40,7 +40,7 @@ assert_cmd = "2.2.2"
40
40
  blake3 = "1.8.7"
41
41
 
42
42
  [profile.release]
43
- lto = "thin"
43
+ lto = true
44
44
  codegen-units = 1
45
45
  strip = true
46
46
 
data/README.ja.md CHANGED
@@ -1,55 +1,55 @@
1
- <h1 align="center">
2
- <img src="docs/images/sonicop_logo_header.png" width="600" alt="Sonicop">
3
- </h1>
1
+ <p align="center">
2
+ <img src="docs/images/sonicop_logo_header.png" width="320" alt="sonicop">
3
+ </p>
4
+
5
+ <h1 align="center">sonicop</h1>
4
6
 
5
7
  <p align="center">
6
- <strong>Rust で実装した高速なネイティブ RuboCop 互換 Ruby リンター/フォーマッター。</strong>
8
+ Rust で実装した高速なネイティブ RuboCop 互換 Ruby リンター/フォーマッター
7
9
  </p>
8
10
 
11
+ <!-- standard:badges:start -->
12
+ <h3 align="center">対応プラットフォーム</h3>
13
+
9
14
  <p align="center">
10
- <a href="https://github.com/owayo/sonicop/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/owayo/sonicop/actions/workflows/ci.yml/badge.svg?branch=main"></a>
11
- <a href="https://rubygems.org/gems/sonicop"><img alt="Gem Version" src="https://img.shields.io/gem/v/sonicop"></a>
12
- <a href="LICENSE"><img alt="License" src="https://img.shields.io/github/license/owayo/sonicop"></a>
15
+ <img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&amp;logoColor=black" alt="Linux">
16
+ <img src="https://img.shields.io/badge/macOS-000000?logo=apple&amp;logoColor=white" alt="macOS">
17
+ <img src="https://img.shields.io/badge/Windows-0078D6" alt="Windows">
18
+ </p>
19
+
20
+ <p align="center">
21
+ <a href="https://github.com/owayo/sonicop/actions/workflows/ci.yml"><img src="https://github.com/owayo/sonicop/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
22
+ <a href="https://github.com/owayo/sonicop/releases/latest"><img src="https://img.shields.io/github/v/release/owayo/sonicop" alt="Release"></a>
23
+ <a href="LICENSE"><img src="https://img.shields.io/github/license/owayo/sonicop" alt="License"></a>
24
+ <a href="https://rubygems.org/gems/sonicop"><img src="https://img.shields.io/gem/v/sonicop" alt="RubyGems"></a>
13
25
  </p>
14
26
 
15
27
  <p align="center">
16
28
  <a href="README.md">English</a> |
17
29
  <a href="README.ja.md">日本語</a>
18
30
  </p>
31
+ <!-- standard:badges:end -->
19
32
 
20
33
  ---
21
34
 
22
- ## 概要
23
-
24
- Sonicop は、Ruby プロセスを起動せずに動作する高速な Rust 製 Ruby リンター/フォーマッターです。
25
- 既存の `.rubocop.yml` をそのまま利用でき、サブディレクトリごとの設定、設定の継承、対象ファイルの
26
- Include/Exclude、severity、自動修正設定にも対応しています。
35
+ Sonicop は、Ruby プロセスを起動せずに動作する高速な Rust 製 Ruby リンター/フォーマッターです。既存の `.rubocop.yml` をそのまま利用でき、サブディレクトリごとの設定、設定の継承、対象ファイルの Include/Exclude、severity、自動修正設定にも対応しています。
27
36
 
28
- 最新の Ruby 構文へ追従する
29
- [owayo/tree-sitter-ruby](https://github.com/owayo/tree-sitter-ruby) を使い、ファイルを並列に検査して
30
- 修正をアトミックに適用します。RuboCop 1.89 互換の CLI と JSON 出力により、既存のエディタや
31
- CI へ最小限の変更で導入できます。
37
+ 最新の Ruby 構文へ追従する [owayo/tree-sitter-ruby](https://github.com/owayo/tree-sitter-ruby) を使い、ファイルを並列に検査して修正をアトミックに適用します。RuboCop 1.89 互換の CLI と JSON 出力により、既存のエディタや CI へ最小限の変更で導入できます。
32
38
 
33
- ## 主な機能
39
+ ## 機能
34
40
 
35
- Bundler、Gemspec、Layout、Lint、Metrics、Migration、Naming、Security、Style の各デパートメントの
36
- Cop を実装しています。一覧はバイナリ自身が正本です。
41
+ Bundler、Gemspec、Layout、Lint、Metrics、Migration、Naming、Security、Style の各デパートメントの Cop を実装しています。一覧はバイナリ自身が正本です。
37
42
 
38
43
  ```bash
39
44
  # 認識済み Cop と実装状況の一覧
40
45
  sonicop --show-cops
41
46
  ```
42
47
 
43
- **RuboCop 1.89 の全 609 Cop を実装しています。** 本家のレジストリと名前まで一致しています。
44
- `Enabled: pending` の 159 個と `Enabled: false` の 56 個も含みます。この 215 個は本家でも
45
- 既定の実行では走らないので、`--only` で名指しするか設定で有効にしてください。本家に存在しない
46
- Cop 名を書いた場合だけエラーで止まります(`--ignore-unrecognized-cops` で続行できます)。
48
+ **RuboCop 1.89 の全 609 Cop を実装しています。** 本家のレジストリと名前まで一致しています。`Enabled: pending` の 159 個と `Enabled: false` の 56 個も含みます。この 215 個は本家でも既定の実行では走らないので、`--only` で名指しするか設定で有効にしてください。本家に存在しない Cop 名を書いた場合だけエラーで止まります(`--ignore-unrecognized-cops` で続行できます)。
47
49
 
48
50
  ### Cop 別の一致状況
49
51
 
50
- 全 609 Cop を両者で有効にし、本家の spec が供給する 37,491 ケースを、それぞれの spec が
51
- 指定した `TargetRubyVersion` で走らせて比較した結果です。**完全一致**とは、その Cop の offense が
52
- 位置・メッセージ・重大度・修正可否まで 1 件残らず一致し、どちらにも余りがないことを指します。
52
+ 全 609 Cop を両者で有効にし、本家の spec が供給する 37,491 ケースを、それぞれの spec が指定した `TargetRubyVersion` で走らせて比較した結果です。**完全一致**とは、その Cop の offense が位置・メッセージ・重大度・修正可否まで 1 件残らず一致し、どちらにも余りがないことを指します。
53
53
 
54
54
  <!-- conformance:start -->
55
55
  | デパートメント | Cop 数 | 検証済み | 完全一致 | 相違 |
@@ -66,62 +66,44 @@ Cop 名を書いた場合だけエラーで止まります(`--ignore-unrecogni
66
66
  | **合計** | **609** | **609** | **579** | **30** |
67
67
  <!-- conformance:end -->
68
68
 
69
- **先に読むべきは「検証済み」の列です。** ここで一度も発火しなかった Cop は、沈黙が一致と
70
- 見分けられないため、訊かれないまま一致に数えられてしまいます。**609 個すべてがここで発火します**。
71
- それが「完全一致」の列を意味あるものにしています。
72
-
73
- そのうち 3 個は専用の run を要しました。`Lint/DeprecatedReference`・`Lint/NameTypo`・
74
- `Lint/UnusedPrivateMethod` は `rubydex` のプロジェクトインデックスが無ければ何も報告せず、
75
- gem の導入と `AllCops/UseProjectIndex` の有効化が要ります。`Lint/DeprecatedReference` は
76
- さらに条件があり、`@deprecated` を持つメソッドの定義クラスを**継承したクラスの中**から
77
- 呼ぶ必要があります。本家の spec は「インデックス無しでは offense を出さない」という
78
- `expect_no_offenses` で始まるので「到達不能」と読みたくなりますが、そうではありません。
79
-
80
- 「完全一致」を 609 にし、「相違」をゼロにすることが現在の目標です。実コードを足しても
81
- 届きません。RuboCop が既定で無効にしている 56 Cop と、pending として出荷している Cop の多くは、
82
- ツリーがどれだけ大きくても素の実行では発火しないためです。そこに届くのは本家の spec が
83
- 供給する入力の方で、`tests/fixtures/upstream_spec_capture.jsonl` に記録したケースは
84
- **609 Cop すべてに到達します**(実測)。走らせ方には間違えやすい点が 2 つあり、
85
- **どちらも失敗せずに表を縮めます**。
86
-
87
- - **`TargetRubyVersion` は入力の一部であって、全体の設定ではありません。** 2.7 に固定すると
88
- `Style/ArrayIntersect`・`Naming/BlockForwarding`・`Style/ItBlockParameter` ほか 11 個が
89
- そもそも発火できません。各ケースはその spec が指定した版で走らせます。
90
- - **ファイル名そのものを見る Cop があります。** `Bundler/*` は `Gemfile`、`Gemspec/*` は
91
- `.gemspec`、`Naming/FileName` は名前自体を読みます。全ケースを `.rb` で書き出すと、
92
- この 17 Cop が何にも一致しませんでした。
93
-
94
- これとは別に、2026-08-29 に本家 Cop spec から直接抽出できた 11,506 ケースを oracle で
95
- 照合しました。本家が入力を読めなかった 226 ケースとクラッシュした 1 ケースを除き、測定できた
96
- 範囲では Sonicop の**検出差分・訂正差分ともにゼロ**でした。この結果は上の表には加えていません。
97
- 直接抽出できるケースが無い Cop が 51 個あり、ディレクティブ系 3 Cop は `--only` では測定不能な
98
- ため、この掃引だけで全 609 Cop の完全一致を証明できないからです。また、この直接掃引は各例の
99
- `TargetRubyVersion` をすべて再現せず、中立的な既定条件で実行しています。そのため、今回変更した
100
- Ruby 3.4 依存の 4 Cop は 3.4 で別途比較し、メッセージと位置が本家に完全一致することを確認しました。
101
-
102
- 設定値については別に測っています。既定値でしか一致しない Cop は半分しか実装していないのと
103
- 同じだからです。`Enforced*` 系の設定を持つ 111 Cop すべてを**既定以外の値**に倒して同じコーパスを
104
- 流すと、**622,317 件の offense のうち 99.995% が一致**し、発火した 96 Cop のうち 85 個が完全一致です。
105
- 残るのは 10 Cop(いずれも 17 件以下)と、本家がクラッシュして sonicop が正常に検出する 1 Cop です。
106
- 内訳は [CONFORMANCE.md](CONFORMANCE.md) にあります。
107
-
108
- どちらの表も `scripts/conformance_table.rb` で再現できます。
69
+ **先に読むべきは「検証済み」の列です。** ここで一度も発火しなかった Cop は、沈黙が一致と見分けられないため、訊かれないまま一致に数えられてしまいます。**609 個すべてがここで発火します**。それが「完全一致」の列を意味あるものにしています。
70
+
71
+ すべての Cop に届かせる方法、本家 spec から直接抽出したケースでの照合、既定以外の設定値の計測は [docs/cop-conformance.ja.md](docs/cop-conformance.ja.md) にまとめています。
109
72
 
110
73
  ## インストール
111
74
 
75
+ <!-- standard:install:start -->
76
+ ### Cargo
77
+
78
+ Rust 1.98 以上が必要です。
79
+
80
+ ```bash
81
+ cargo install --git https://github.com/owayo/sonicop --locked
82
+ ```
83
+
84
+ ### RubyGems
85
+
112
86
  ```bash
113
87
  gem install sonicop
114
88
  ```
115
89
 
116
- Linux、macOS、Windows 向けの platform gem にはネイティブ実行ファイルが含まれます。
117
- 対応する platform gem がない環境では、source gem がインストール時に Cargo でビルドします。
90
+ ### ソースから
118
91
 
119
- 最新版のソースから直接インストールすることもできます。
92
+ [mise](https://mise.jdx.dev/) が必要です (Rust のツールチェーンは `mise.toml` で固定しています)。
120
93
 
121
94
  ```bash
122
- cargo install --git https://github.com/owayo/sonicop
95
+ git clone https://github.com/owayo/sonicop.git
96
+ cd sonicop
97
+ make install
123
98
  ```
124
99
 
100
+ `make install` は `/usr/local/bin` に入れます。場所を変えるときは `INSTALL_PATH` を指定します (例: `make install INSTALL_PATH="$HOME/.local/bin"`)。
101
+ <!-- standard:install:end -->
102
+
103
+ ### プラットフォーム別の gem
104
+
105
+ [RubyGems](https://rubygems.org/gems/sonicop) で配っている Linux、macOS、Windows 向けの platform gem には、ネイティブ実行ファイルが含まれます。対応する platform gem がない環境では、source gem がインストール時に Cargo でビルドします。
106
+
125
107
  ## 使い方
126
108
 
127
109
  ```bash
@@ -138,27 +120,26 @@ sonicop -A
138
120
  # RuboCop 互換形状の JSON
139
121
  sonicop --format json
140
122
 
123
+ # エディタからの入力
124
+ printf '%s\n' 'value=10000' | sonicop --stdin example.rb --format json
125
+
141
126
  # 認識済み Cop と実装状況
142
127
  sonicop --show-cops
143
128
  ```
144
129
 
145
- 主な互換オプションは `-l`、`-x`、`--only`、`--except`、`-s/--stdin`、
146
- `-P/--parallel`、`-f/--format`、`-a/--autocorrect`、`-A/--autocorrect-all`、
147
- `-L/--list-target-files`、`-c/--config`、`-v/--version`、`-V/--verbose-version` です。
130
+ 主な互換オプションは `-l`、`-x`、`--only`、`--except`、`-s/--stdin`、`-P/--parallel`、`-f/--format`、`-a/--autocorrect`、`-A/--autocorrect-all`、`-L/--list-target-files`、`-c/--config`、`-v/--version`、`-V/--verbose-version` です。
148
131
 
149
- ### 設定
132
+ ## 設定
150
133
 
151
- 対象ファイルごとに `.rubocop.yml` を解決するため、1 回の実行でもサブディレクトリ設定が
152
- 適用されます。ローカル/HTTPS の `inherit_from`、`inherit_gem`、`inherit_mode`、
153
- `AllCops/DisabledByDefault`、`Include`/`Exclude`、Cop ごとの `Enabled`、`Exclude`、
154
- `Severity`、`Safe`、`SafeAutoCorrect` と設定値に対応します。宣言されたプラグイン由来の
155
- Cop は「認識済み・未実装」として受理し、Ruby プラグインコード自体は実行しません。
156
- リモート設定のリクエストには 30 秒のネットワークタイムアウトを設け、応答は 1 件あたり
157
- 5 MiB に制限します。
134
+ 対象ファイルごとに `.rubocop.yml` を解決するため、1 回の実行でもサブディレクトリ設定が適用されます。ローカル/HTTPS の `inherit_from`、`inherit_gem`、`inherit_mode`、`AllCops/DisabledByDefault`、`Include`/`Exclude`、Cop ごとの `Enabled`、`Exclude`、`Severity`、`Safe`、`SafeAutoCorrect` と設定値に対応します。宣言されたプラグイン由来の Cop は「認識済み・未実装」として受理し、Ruby プラグインコード自体は実行しません。リモート設定のリクエストには 30 秒のネットワークタイムアウトを設け、応答は 1 件あたり 5 MiB に制限します。
158
135
 
159
136
  ```yaml
160
137
  inherit_from: .rubocop_todo.yml
161
138
 
139
+ AllCops:
140
+ Exclude:
141
+ - "vendor/**/*"
142
+
162
143
  Layout/LineLength:
163
144
  Max: 100
164
145
 
@@ -166,70 +147,33 @@ Style/StringLiterals:
166
147
  EnforcedStyle: single_quotes
167
148
  ```
168
149
 
169
- 既存コマンドとの互換性を保つため、server/LSP/MCP、plugin 系の引数も受理します。
170
- サーバートランスポート、Ruby プラグイン実行、カスタム Cop、実装済み以外の Cop は実行しません。
171
- これらはその旨を出力します。`--server` / `--no-server` / `--lsp` / `--mcp` / `--plugin` は
172
- stderr に 1 行の注記を出します。
150
+ 既存コマンドとの互換性を保つため、server/LSP/MCP、plugin 系の引数も受理します。サーバートランスポート、Ruby プラグイン実行、カスタム Cop、実装済み以外の Cop は実行しません。これらはその旨を出力します。`--server` / `--no-server` / `--lsp` / `--mcp` / `--plugin` は stderr に 1 行の注記を出します。
173
151
 
174
- cache 系の引数は、受理するだけでなく実際に効きます。sonicop は独自の結果キャッシュを持ち、
175
- 検査時からサイズ・更新時刻・パーミッションのいずれも動いていないファイルには、
176
- 保存済みのレポートをそのまま返します。
152
+ cache 系の引数は、受理するだけでなく実際に効きます。sonicop は独自の結果キャッシュを持ち、検査時からサイズ・更新時刻・パーミッションのいずれも動いていないファイルには、保存済みのレポートをそのまま返します。
177
153
 
178
- - キャッシュは既定で有効です。`--cache false` で無効化できます。設定ファイルの
179
- `AllCops/MaxFilesInCache: 0` でも同じです。
180
- - 置き場所は `--cache-root DIR` で指定します。省略時は `$XDG_CACHE_HOME/sonicop`、
181
- macOS では `~/Library/Caches/sonicop`、それ以外は `~/.cache/sonicop` です。
182
- `--cache-root` は `--cache false` とは併用できません。
154
+ - キャッシュは既定で有効です。`--cache false` で無効化できます。設定ファイルの `AllCops/MaxFilesInCache: 0` でも同じです。
155
+ - 置き場所は `--cache-root DIR` で指定します。省略時は `$XDG_CACHE_HOME/sonicop`、macOS では `~/Library/Caches/sonicop`、それ以外は `~/.cache/sonicop` です。`--cache-root` は `--cache false` とは併用できません。
183
156
  - 保持するレポート数の上限は `AllCops/MaxFilesInCache` で、既定は本家と同じ 20,000 件です。
184
157
  - autocorrect 実行、`--stdin`、`--profile`、`--memory` では読み書きしません。
185
- - 本家のキャッシュとは共有しません。形式が別物であり、書いたときとまったく同じ
186
- ビルドの sonicop にしかエントリを返さないためです。
187
-
188
- 無言なのは Cop の設定値のほうです。sonicop が実装していない設定値は**警告なしに無視されます**。
189
- 名前を綴り間違えた設定値も同様です。つまり
190
- **offense が 0 件であることは、その設定が効いた証拠にはなりません**。
191
- 無視された設定値と、違反の無いファイルが、同じ出力になるためです。
192
- どの設定値まで検証済みかは上の *Cop 別の一致状況* を参照してください。
193
-
194
- Cop の*名前*は検査されます。設定ファイルに未知の Cop 名があれば、実行はエラーで止まります。
195
- 素通りするのは、既知の Cop の中の設定値です。
196
-
197
- ### 適合性
198
-
199
- 実装済み Cop は、RuboCop 自身・Rails・Ruby・Homebrew・Mastodon の 5 プロジェクト
200
- 計 18,251 ファイルに対して、両者とも本家既定設定で検証しています。offense は Cop 名・パス・
201
- 行・桁・終端行・終端桁・長さ・メッセージ・重大度・修正可否のすべてで突き合わせます。
202
-
203
- 5 つのうち 3 つが**完全一致**です。RuboCop 自身のツリー(5,766 件)、Rails(167,760 件)、
204
- Mastodon(15,286 件)で、過剰も不足もメタデータ差もありません。対象ファイル一覧は 5 つすべてで
205
- **件数だけでなくパスまで**一致します(集合として比較。どの側にも余りはありません)。
206
- 残る差分は `Lint/Syntax` に集中しています。その大半は、本家の LALR パーサが
207
- 構文エラーから回復して出す追加診断を tree-sitter では再現できないことによるもので、
208
- 診断位置の差は不足と過剰の両方に出ます。Homebrew の不足 997 件・過剰 263 件はすべて
209
- `Lint/Syntax` ですが、**構文エラーと判定したファイル集合は 569 対 569 で完全一致**し、
210
- 移植版だけが拒否したファイルは 0 件です。過剰 263 件は共有エラーファイル 135 件にあり、
211
- すべて同じファイル内の共通診断より後ろにあるため、別の受理判定バグではなく回復後の診断位置差です。
212
- Homebrew を問題の構文をサポートする Ruby 3.1 として測ると、両者とも `Lint/Syntax` は 0 件になります。
213
- autocorrect は RuboCop 自身のツリーと Mastodon でバイト単位に一致します。この 2 つは死守ラインと
214
- して扱い、バイト一致が崩れた場合は既知差分ではなく退行として直します。
215
-
216
- コマンド、この数値を測ったコーパスのコミット、この種の計測が誤った結論を導く 2 つの罠は
217
- [CONFORMANCE.md](CONFORMANCE.md) にまとめています。
218
-
219
- ### 性能
220
-
221
- 適合性検証に使う 5 コーパスすべてで測定しました。両者とも同梱の既定設定
222
- (`--force-default-config`)で走らせているためプロジェクト側の `.rubocop.yml` は読まず、
223
- どのコーパスでも**対象ファイル数は一致**しています。この計測に必要なのはそこまでで、
224
- どちらの側も少なく検査してはいない、と言えます。パス単位の一致はより強い主張で、
225
- 上の*適合性*の節で 5 つすべてについて示していますが、それは固定したリビジョンでの測定であって
226
- この速度計測の run そのものではありません。
227
-
228
- 両者とも既定の全 Cop で走らせています。**同じ 394 Cop** が名前まで一致しているため、
229
- どちらも絞る必要がなく、素の実行がそのまま対等な比較になります。
230
- (394 は 609 から `Enabled: pending` の 159 個と `Enabled: false` の 56 個を除いた残りで、
231
- 既定の実行はどちらの群にも届きません。)
232
- 各値は暖機後 2 回の最速値です。
158
+ - 本家のキャッシュとは共有しません。形式が別物であり、書いたときとまったく同じビルドの sonicop にしかエントリを返さないためです。
159
+
160
+ 無言なのは Cop の設定値のほうです。sonicop が実装していない設定値は**警告なしに無視されます**。名前を綴り間違えた設定値も同様です。つまり **offense が 0 件であることは、その設定が効いた証拠にはなりません**。無視された設定値と、違反の無いファイルが、同じ出力になるためです。どの設定値まで検証済みかは [既定以外の設定値](docs/cop-conformance.ja.md#既定以外の設定値) を参照してください。
161
+
162
+ Cop の*名前*は検査されます。設定ファイルに未知の Cop 名があれば、実行はエラーで止まります。素通りするのは、既知の Cop の中の設定値です。
163
+
164
+ ## 適合性
165
+
166
+ 実装済み Cop は、RuboCop 自身・Rails・Ruby・Homebrew・Mastodon の 5 プロジェクト計 18,251 ファイルに対して、両者とも本家既定設定で検証しています。offense は Cop 名・パス・行・桁・終端行・終端桁・長さ・メッセージ・重大度・修正可否のすべてで突き合わせます。
167
+
168
+ 5 つのうち 3 つが**完全一致**です。RuboCop 自身のツリー(5,766 件)、Rails(167,760 件)、Mastodon(15,286 件)で、過剰も不足もメタデータ差もありません。対象ファイル一覧は 5 つすべてで**件数だけでなくパスまで**一致します(集合として比較。どの側にも余りはありません)。残る差分は `Lint/Syntax` に集中しています。その大半は、本家の LALR パーサが構文エラーから回復して出す追加診断を tree-sitter では再現できないことによるもので、診断位置の差は不足と過剰の両方に出ます。Homebrew の不足 997 件・過剰 263 件はすべて `Lint/Syntax` ですが、**構文エラーと判定したファイル集合は 569 対 569 で完全一致**し、移植版だけが拒否したファイルは 0 件です。過剰 263 件は共有エラーファイル 135 件にあり、すべて同じファイル内の共通診断より後ろにあるため、別の受理判定バグではなく回復後の診断位置差です。Homebrew を問題の構文をサポートする Ruby 3.1 として測ると、両者とも `Lint/Syntax` は 0 件になります。autocorrect は RuboCop 自身のツリーと Mastodon でバイト単位に一致します。この 2 つは死守ラインとして扱い、バイト一致が崩れた場合は既知差分ではなく退行として直します。
169
+
170
+ コマンド、この数値を測ったコーパスのコミット、この種の計測が誤った結論を導く 2 つの罠は [CONFORMANCE.md](CONFORMANCE.md) にまとめています。
171
+
172
+ ## 性能
173
+
174
+ 適合性検証に使う 5 コーパスすべてで測定しました。両者とも同梱の既定設定(`--force-default-config`)で走らせているためプロジェクト側の `.rubocop.yml` は読まず、どのコーパスでも**対象ファイル数は一致**しています。この計測に必要なのはそこまでで、どちらの側も少なく検査してはいない、と言えます。パス単位の一致はより強い主張で、上の[適合性](#適合性)の節で 5 つすべてについて示していますが、それは固定したリビジョンでの測定であってこの速度計測の run そのものではありません。
175
+
176
+ 両者とも既定の全 Cop で走らせています。**同じ 394 Cop** が名前まで一致しているため、どちらも絞る必要がなく、素の実行がそのまま対等な比較になります。(394 は 609 から `Enabled: pending` の 159 個と `Enabled: false` の 56 個を除いた残りで、既定の実行はどちらの群にも届きません。)各値は暖機後 2 回の最速値です。
233
177
 
234
178
  | コーパス | ファイル | offense | RuboCop 並列 | Sonicop 並列 | RuboCop 単一 | Sonicop 単一 |
235
179
  |---|---:|---:|---:|---:|---:|---:|
@@ -239,30 +183,11 @@ autocorrect は RuboCop 自身のツリーと Mastodon でバイト単位に一
239
183
  | rails/rails | 3,562 | 168,615 | 32.90 秒 | **8.84 秒** | 85.71 秒 | **19.17 秒** |
240
184
  | ruby/ruby | 7,477 | 765,975 | 86.89 秒 | **15.59 秒** | 193.59 秒 | **37.98 秒** |
241
185
 
242
- 差は並列で 3.7〜7.4 倍、単一プロセスで 4.5〜6.2 倍と幅があり、1 コーパスでは代表できません。
243
- **単一プロセスの列を読み、並列は目安として扱ってください。** 同じ 2 つのバイナリを 1 日に
244
- 3 回測ったところ、単一プロセスの値は毎回 16% 以内に収まったのに対し、RuboCop 自身のツリーでの
245
- 並列の倍率は、マシンが他に何をしていたかだけで 3.3 倍から 9.2 倍まで動きました。単一プロセスは
246
- エンジンを測っていますが、並列はエンジンに加えて「その実行でスケジューリングがそのツリーに
247
- どれだけ噛み合ったか」を測っています。
248
-
249
- 仕事を省いて速いわけではありません。この同じ 394 Cop について、表のどのコーパスでも
250
- **offense の総数が一致**し、RuboCop 自身のツリーと Mastodon ではその 1 件ずつが同じ位置・
251
- 同じメッセージ・同じ severity です。Rails は 168,615 件のうち 2 件だけ食い違います
252
- (Sonicop が出す `Style/CaseLikeIf` 1 件と、出さない `Metrics/AbcSize` 1 件)。
253
- RuboCop 自身のツリーでは 1 件の `correctable` フラグが違います。
254
- autocorrect は前者と後者でバイト単位に一致します。
255
-
256
- 再現時に注意が必要な点が 4 つあります。RuboCop は **`--cache false` と併用すると
257
- `--parallel` を黙って無効化します**。そのためここでの並列実行はキャッシュを有効にしたうえで
258
- 実行ごとにキャッシュディレクトリを消しており、`--cache false --parallel` で計測すると
259
- 単一プロセスを測ることになり差が過大に出ます。また RuboCop の既定は単一プロセス、
260
- Sonicop は `--no-parallel` を渡さない限り並列です。そして**両方ともキャッシュを空にする**
261
- 必要があります。Sonicop も既定でキャッシュするため、同じツリーを 2 回目に流すと自分の
262
- キャッシュが答えてしまい、エンジンについては何も測れません。どちらにも使い捨ての
263
- キャッシュディレクトリを渡してください。最後に、そのキャッシュディレクトリは**実パス**である
264
- 必要があります。macOS の `mktemp -d` は `/var/folders/…` を返し、その `/var` は symlink なので
265
- RuboCop はそこを拒み、キャッシュ無しで走ってしまいます。
186
+ 差は並列で 3.7〜7.4 倍、単一プロセスで 4.5〜6.2 倍と幅があり、1 コーパスでは代表できません。**単一プロセスの列を読み、並列は目安として扱ってください。** 同じ 2 つのバイナリを 1 日に 3 回測ったところ、単一プロセスの値は毎回 16% 以内に収まったのに対し、RuboCop 自身のツリーでの並列の倍率は、マシンが他に何をしていたかだけで 3.3 倍から 9.2 倍まで動きました。単一プロセスはエンジンを測っていますが、並列はエンジンに加えて「その実行でスケジューリングがそのツリーにどれだけ噛み合ったか」を測っています。
187
+
188
+ 仕事を省いて速いわけではありません。この同じ 394 Cop について、表のどのコーパスでも **offense の総数が一致**し、RuboCop 自身のツリーと Mastodon ではその 1 件ずつが同じ位置・同じメッセージ・同じ severity です。Rails は 168,615 件のうち 2 件だけ食い違います(Sonicop が出す `Style/CaseLikeIf` 1 件と、出さない `Metrics/AbcSize` 1 件)。RuboCop 自身のツリーでは 1 件の `correctable` フラグが違います。autocorrect は前者と後者でバイト単位に一致します。
189
+
190
+ 再現時に注意が必要な点が 4 つあります。RuboCop は **`--cache false` と併用すると `--parallel` を黙って無効化します**。そのためここでの並列実行はキャッシュを有効にしたうえで実行ごとにキャッシュディレクトリを消しており、`--cache false --parallel` で計測すると単一プロセスを測ることになり差が過大に出ます。また RuboCop の既定は単一プロセス、Sonicop は `--no-parallel` を渡さない限り並列です。そして**両方ともキャッシュを空にする**必要があります。Sonicop も既定でキャッシュするため、同じツリーを 2 回目に流すと自分のキャッシュが答えてしまい、エンジンについては何も測れません。どちらにも使い捨てのキャッシュディレクトリを渡してください。最後に、そのキャッシュディレクトリは**実パス**である必要があります。macOS の `mktemp -d` は `/var/folders/…` を返し、その `/var` は symlink なので RuboCop はそこを拒み、キャッシュ無しで走ってしまいます。
266
191
 
267
192
  ```bash
268
193
  # RuboCop(並列・キャッシュは毎回空・既定の全 394 Cop)
@@ -274,69 +199,45 @@ rubocop --force-default-config --cache true --cache-root "$root" \
274
199
  sonicop --force-default-config --cache-root "$root" --format quiet
275
200
  ```
276
201
 
277
- キャッシュの書き込みもこの数値に含まれており、無料ではありません。索引は全 offense を
278
- 「見つかった行のテキスト」付きで保持するため、`ruby/ruby` では 336 MB になります。
279
- 2 回目の実行(キャッシュ命中)は `ruby/ruby` で 1.59 秒、Rails で 0.42 秒です。
280
-
281
- 測定機は Apple M2(8 コア)、Ruby 4.0.6(YJIT 利用可)、RubyGems 導入の RuboCop 1.89.0。
282
- 2026-08-31 に、`rubocop_rubocop` 2693129 / `mastodon_mastodon` b59ddc7 / `Homebrew_brew` b42173b /
283
- `rails_rails` a19f07f / `ruby_ruby` 22e4a75 の各リビジョンに対して測定しました。
284
- 1 分平均のロードアベレージは各行の測定時点で 4.5〜7.1 で、その大半は RuboCop 自身の並列
285
- ワーカーです(計測する以上避けられません)。**アイドル状態ではありません。**
286
- 各コーパスで両者を連続して同じ条件で測っているため倍率は保たれますが、秒数そのものは下限ではなく、
287
- 静かなマシンならより速く出ます。コアを奪い合うものが動いていると両者とも膨らみ、その度合いは
288
- 一致しません。それが並列の列があれだけ動く理由です。秒数そのものが重要なときは、他に負荷のない
289
- 状態で測り、**実行の前後でロードアベレージを記録してください** — その情報が無い数値は、
290
- 別の数値と比べられません。
202
+ キャッシュの書き込みもこの数値に含まれており、無料ではありません。索引は全 offense を「見つかった行のテキスト」付きで保持するため、`ruby/ruby` では 336 MB になります。2 回目の実行(キャッシュ命中)は `ruby/ruby` で 1.59 秒、Rails で 0.42 秒です。
203
+
204
+ 測定機は Apple M2(8 コア)、Ruby 4.0.6(YJIT 利用可)、RubyGems 導入の RuboCop 1.89.0。2026-08-31 に、`rubocop_rubocop` 2693129 / `mastodon_mastodon` b59ddc7 / `Homebrew_brew` b42173b / `rails_rails` a19f07f / `ruby_ruby` 22e4a75 の各リビジョンに対して測定しました。1 分平均のロードアベレージは各行の測定時点で 4.5〜7.1 で、その大半は RuboCop 自身の並列ワーカーです(計測する以上避けられません)。**アイドル状態ではありません。** 各コーパスで両者を連続して同じ条件で測っているため倍率は保たれますが、秒数そのものは下限ではなく、静かなマシンならより速く出ます。コアを奪い合うものが動いていると両者とも膨らみ、その度合いは一致しません。それが並列の列があれだけ動く理由です。秒数そのものが重要なときは、他に負荷のない状態で測り、**実行の前後でロードアベレージを記録してください** — その情報が無い数値は、別の数値と比べられません。
291
205
 
292
206
  ## 開発
293
207
 
294
- 入口は `make` に一本化しています。`make help` で全ターゲットを確認できます。gem 配布の
295
- タスクは Rakefile 側にあり、`make` から呼び出します。
208
+ <!-- standard:dev:start -->
209
+ [mise](https://mise.jdx.dev/) が必要です。ツールの版は `mise.toml` で固定しています。
296
210
 
297
211
  ```bash
298
- make build # デバッグビルド
299
- make check # fmt、clippy、Rust テスト、Ruby ラッパーテスト、バージョン整合
300
- make gem # source gem
212
+ make setup # ツールチェーン (mise) と依存を取得する
213
+ make ci # CI と同じ検査 (書き換えない)
301
214
  ```
302
215
 
303
- ### Cop の追加
304
-
305
- Cop は `src/rules/<デパートメント>/<cop>.rs` の 1 ファイルで、公開するのは
306
- `check(context, offenses)` の 1 関数だけです。登録はデパートメントの `mod.rs` に 1 行を足します。
307
-
308
- ```rust
309
- department_rules! {
310
- "Layout";
311
- line_length => ("LineLength", Convention),
312
- }
313
- ```
314
-
315
- Cop 名と既定 severity を書くのはこの 1 行だけです。Cop 本体では名前は暗黙で、
316
- `context.setting("Max")` が `Layout/LineLength: Max` を読み、`context.offense(message, range)` が
317
- その Cop の名前と設定済み severity で報告します。Cop が自分の名前を 2 度書ける設計では、
318
- レジストリと食い違っても型検査では捕まりません。
319
-
320
- 全ノード走査より `context.nodes_of("kind")` を優先してください。Cop は全ファイルに対して走るため、
321
- Cop ごとの全走査はファイル規模ではなく Cop 数に比例して重くなります。
322
-
323
- バージョンの正本は `Cargo.toml` です。`lib/sonicop/version.rb` は `make version-sync` で
324
- 生成してコミットします(gemspec がパッケージ時に読むため)。両者が食い違うと CI が落ちます。
325
-
326
- `config/default.yml` は上流 RuboCop から取り込んだものです。再取得は
327
- `scripts/sync_default_yml.sh <rubocop-version>` で行い、由来のバージョンがファイル先頭に
328
- 記録されます。
329
-
330
- `src/display_width_table.rs` も生成物で、コミットします。RuboCop は表示桁を
331
- `unicode-display_width` gem で数えるため、この表は手書きせず gem から生成しています。
332
- 手書きの例外表は実際にずれており、NFD 分解された日本語でキャレットの本数が合わなくなっていました。
333
- 再生成は `ruby scripts/dump_display_width.rb > src/display_width_table.rs` で行い、
334
- gem と Unicode のバージョンがファイル先頭に記録されます。
335
-
336
- 依存更新には `depup --install` を使います。Ruby grammar は再現可能性のため `Cargo.toml` で
337
- fork のコミットを固定しています。
216
+ | コマンド | 説明 |
217
+ |---|---|
218
+ | `make setup` | ツールチェーン (mise) と依存を取得する |
219
+ | `make build` | デバッグ版をビルドする |
220
+ | `make release` | リリース版をビルドする |
221
+ | `make run` | デバッグ版を実行する (引数は ARGS="...") |
222
+ | `make test` | テストを実行する |
223
+ | `make lint` | clippy を警告ゼロで通す |
224
+ | `make fmt` | コードを整形する (書き換える) |
225
+ | `make fmt-check` | 整形済みかを確かめる (書き換えない) |
226
+ | `make check` | 整形と静的検査 (書き換えない) |
227
+ | `make ci` | CI と同じ検査 (書き換えない) |
228
+ | `make install` | リリース版を INSTALL_PATH (既定 /usr/local/bin) に入れる |
229
+ | `make uninstall` | INSTALL_PATH から取り除く |
230
+ | `make clean` | ビルド成果物を消す |
231
+
232
+ `make` でターゲットの一覧を表示します。リリースは GitHub Actions で行います (**Actions → Release → Run workflow**)。
233
+ <!-- standard:dev:end -->
234
+
235
+ Rakefile には gem の組み立てと版の処理だけがあり、`make gem`・`make gem-platform`・`make version-sync` がそれを呼びます。版の正本は `Cargo.toml` です。Cop の追加、上流から取り込むファイル、ほかのターゲットは [docs/development.ja.md](docs/development.ja.md) にまとめています。
338
236
 
339
237
  ## ライセンス
340
238
 
341
- [MIT](LICENSE)。同梱する RuboCop 既定設定とパーサー依存の著作権表示は
342
- [NOTICE](NOTICE) および [`licenses/`](licenses/) に収録しています。
239
+ <!-- standard:license:start -->
240
+ [MIT](LICENSE)
241
+ <!-- standard:license:end -->
242
+
243
+ 同梱する RuboCop 既定設定とパーサー依存の著作権表示は [NOTICE](NOTICE) および [`licenses/`](licenses/) に収録しています。