1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
import { mkdtempSync, unlinkSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { describe, expect, it } from "vitest";
import { checkFile } from "./checker.js";
function createTempFile(content: string): string {
const directory = mkdtempSync(join(tmpdir(), "iku-test-"));
const filePath = join(directory, "test.ts");
writeFileSync(filePath, content);
return filePath;
}
function cleanupTempFile(filePath: string): void {
try {
unlinkSync(filePath);
} catch {}
}
describe("checkFile", () => {
describe("imports", () => {
it("passes when imports have no blank lines between them", () => {
const content = `import { foo } from "foo";
import { bar } from "bar";
import { baz } from "baz";
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
it("fails when imports have blank lines between them", () => {
const content = `import { foo } from "foo";
import { bar } from "bar";
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("Blank line between imports");
});
});
describe("same statement types", () => {
it("passes when same statement types are grouped without blank lines", () => {
const content = `const a = 1;
const b = 2;
const c = 3;
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
it("fails when same statement types have unnecessary blank lines", () => {
const content = `const a = 1;
const b = 2;
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain(
"Unnecessary blank line between same statement types",
);
});
it("passes for consecutive expression statements without blank lines", () => {
const content = `console.log("a");
console.log("b");
console.log("c");
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
});
describe("different statement types", () => {
it("passes when different statement types have blank lines between them", () => {
const content = `const a = 1;
console.log(a);
return a;
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
it("fails when different statement types have no blank line between them", () => {
const content = `const a = 1;
console.log(a);
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain(
"Missing blank line between different statement types",
);
});
it("requires blank line between variable declaration and return", () => {
const content = `function test() {
const result = 42;
return result;
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("variableDeclaration -> return");
});
it("requires blank line between expression and if statement", () => {
const content = `function test() {
console.log("start");
if (true) {
return;
}
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("Missing blank line around scoped block");
});
});
describe("scoped blocks", () => {
it("passes when scoped if blocks have blank lines between them", () => {
const content = `function test(a: number, b: number) {
if (a > 0) {
return a;
}
if (b > 0) {
return b;
}
return 0;
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
it("fails when scoped if blocks have no blank line between them", () => {
const content = `function test(a: number, b: number) {
if (a > 0) {
return a;
}
if (b > 0) {
return b;
}
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("Missing blank line around scoped block");
});
it("passes when scoped for loops have blank lines between them", () => {
const content = `function test(items: number[]) {
for (const item of items) {
console.log(item);
}
for (let i = 0; i < 10; i++) {
console.log(i);
}
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
it("fails when scoped for loops have no blank line between them", () => {
const content = `function test(items: number[]) {
for (const item of items) {
console.log(item);
}
for (let i = 0; i < 10; i++) {
console.log(i);
}
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("Missing blank line around scoped block");
});
});
describe("nested blocks", () => {
it("checks formatting inside nested function bodies", () => {
const content = `function outer() {
function inner() {
const a = 1;
console.log(a);
}
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("variableDeclaration -> expression");
});
it("checks formatting inside arrow function bodies", () => {
const content = `const fn = () => {
const a = 1;
return a;
};
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(1);
expect(errors[0]).toContain("variableDeclaration -> return");
});
});
describe("mixed scenarios", () => {
it("handles complex file with multiple statement types correctly", () => {
const content = `import { foo } from "foo";
import { bar } from "bar";
const a = 1;
const b = 2;
console.log(a);
console.log(b);
if (a > b) {
return a;
}
if (b > a) {
return b;
}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(0);
});
it("detects multiple errors in a single file", () => {
const content = `import { foo } from "foo";
import { bar } from "bar";
const a = 1;
const b = 2;
console.log(a);
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors).toHaveLength(3);
});
});
describe("comments", () => {
it("detects single-line comments by default", () => {
const content = `const a = 1;
// this is a comment
const b = 2;
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors.some((error) => error.includes("Comment detected"))).toBe(
true,
);
});
it("detects multi-line comments by default", () => {
const content = `const a = 1;
/* this is a
multi-line comment */
const b = 2;
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors.some((error) => error.includes("Comment detected"))).toBe(
true,
);
});
it("detects trailing comments by default", () => {
const content = `const a = 1; // trailing comment
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors.some((error) => error.includes("Comment detected"))).toBe(
true,
);
});
it("allows comments when noComments is false", () => {
const content = `const a = 1;
// this is a comment
const b = 2;
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath, { noComments: false });
cleanupTempFile(filePath);
expect(errors.some((error) => error.includes("Comment detected"))).toBe(
false,
);
});
it("detects JSDoc comments by default", () => {
const content = `/**
* This is a JSDoc comment
*/
function test() {}
`;
const filePath = createTempFile(content);
const errors = checkFile(filePath);
cleanupTempFile(filePath);
expect(errors.some((error) => error.includes("Comment detected"))).toBe(
true,
);
});
});
});
|