Commit 75c0376
docs(permissions): add JSDoc to address CodeRabbit docstring coverage warning
CodeRabbit flagged the PR with "Docstring coverage is 50.00% which is
insufficient (threshold 80.00%)". Added JSDoc to:
1. `formatDirectoryList` in pathValidation.ts — the only production
function in the changed files that lacked JSDoc. Brief description
of the truncation behavior + reference to MAX_DIRS_TO_LIST.
2. Both `describeIfWindows` blocks in pathValidation.test.ts — explain
the security rationale of the MinGW-normalization fix and the
sandbox-escape regression scenarios. Individual `test()` calls
already self-document via their string descriptions.
Co-Authored-By: Claude <noreply@anthropic.com>1 parent 93ab1de commit 75c0376
2 files changed
Lines changed: 24 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
51 | 59 | | |
52 | 60 | | |
53 | 61 | | |
| |||
151 | 159 | | |
152 | 160 | | |
153 | 161 | | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
154 | 172 | | |
155 | 173 | | |
156 | 174 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
39 | 45 | | |
40 | 46 | | |
41 | 47 | | |
| |||
0 commit comments