|
1 | 1 | /** |
2 | | - * @file Shared path-suffix constants for fleet-canonical files that any |
3 | | - * plugin rule may need to recognize. Centralizing these out of individual |
4 | | - * rule files lets multiple rules share the same opt-in / opt-out list |
5 | | - * without duplicating the path string + its rationale comment. |
6 | | - * |
7 | | - * Examples of consumers: |
| 2 | + * @file Shared path-suffix constants for fleet-canonical files that any plugin |
| 3 | + * rule may need to recognize. Centralizing these out of individual rule files |
| 4 | + * lets multiple rules share the same opt-in / opt-out list without |
| 5 | + * duplicating the path string + its rationale comment. Examples of |
| 6 | + * consumers: |
8 | 7 | * |
9 | 8 | * - `no-file-scope-oxlint-disable` exempts `scripts/paths.mts` (deliberate |
10 | 9 | * flow-ordered exports, see PATHS_FILE constant below). |
11 | 10 | * - `socket/prefer-cached-for-loop` and `socket/no-cached-for-on-iterable` |
12 | 11 | * share `lib/iterable-kind.mts` for the binding-kind heuristic — sibling |
13 | | - * pattern. |
14 | | - * |
15 | | - * When a new rule needs to recognize one of these path patterns, add the |
16 | | - * import here and use the constant, not a re-spelled literal. |
| 12 | + * pattern. When a new rule needs to recognize one of these path patterns, |
| 13 | + * add the import here and use the constant, not a re-spelled literal. |
17 | 14 | */ |
18 | 15 |
|
19 | 16 | /** |
20 | 17 | * The fleet's "1 path, 1 reference" source-of-truth file. Each fleet repo has |
21 | 18 | * one. Its exports are ordered by path-resolution flow (REPO_ROOT → primary |
22 | | - * roots → build paths → helpers) — deliberately not alphabetical, and the |
23 | | - * order is load-bearing for code review. Anything keyed on per-file behavior |
24 | | - * that recognizes `paths.mts` should match by suffix. |
| 19 | + * roots → build paths → helpers) — deliberately not alphabetical, and the order |
| 20 | + * is load-bearing for code review. Anything keyed on per-file behavior that |
| 21 | + * recognizes `paths.mts` should match by suffix. |
25 | 22 | */ |
26 | 23 | export const PATHS_FILE = 'scripts/paths.mts' |
27 | 24 |
|
28 | 25 | /** |
29 | | - * Plugin-internal rule + test directories. Rule files often contain the |
30 | | - * banned shape they ban as lookup-table data (e.g. `no-status-emoji.mts` |
31 | | - * literally contains the emoji it bans). Same for the matching test files, |
32 | | - * which intentionally exercise the banned shape. |
| 26 | + * Plugin-internal rule + test directories. Rule files often contain the banned |
| 27 | + * shape they ban as lookup-table data (e.g. `no-status-emoji.mts` literally |
| 28 | + * contains the emoji it bans). Same for the matching test files, which |
| 29 | + * intentionally exercise the banned shape. |
33 | 30 | */ |
34 | 31 | export const PLUGIN_RULE_DIR = '.config/oxlint-plugin/rules/' |
35 | 32 | export const PLUGIN_TEST_DIR = '.config/oxlint-plugin/test/' |
|
0 commit comments