🚀 Grammar-Aware Code Formatter: Structure through separation (supports Go, JavaScript, TypeScript, JSX, and TSX)
go
formatter
code-formatter
javascript
typescript
jsx
tsx
feat: Initial commit
+1913
+1
.gitignore
+1
.gitignore
···
1
+
iku
+674
LICENSE.txt
+674
LICENSE.txt
···
1
+
GNU GENERAL PUBLIC LICENSE
2
+
Version 3, 29 June 2007
3
+
4
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+
Everyone is permitted to copy and distribute verbatim copies
6
+
of this license document, but changing it is not allowed.
7
+
8
+
Preamble
9
+
10
+
The GNU General Public License is a free, copyleft license for
11
+
software and other kinds of works.
12
+
13
+
The licenses for most software and other practical works are designed
14
+
to take away your freedom to share and change the works. By contrast,
15
+
the GNU General Public License is intended to guarantee your freedom to
16
+
share and change all versions of a program--to make sure it remains free
17
+
software for all its users. We, the Free Software Foundation, use the
18
+
GNU General Public License for most of our software; it applies also to
19
+
any other work released this way by its authors. You can apply it to
20
+
your programs, too.
21
+
22
+
When we speak of free software, we are referring to freedom, not
23
+
price. Our General Public Licenses are designed to make sure that you
24
+
have the freedom to distribute copies of free software (and charge for
25
+
them if you wish), that you receive source code or can get it if you
26
+
want it, that you can change the software or use pieces of it in new
27
+
free programs, and that you know you can do these things.
28
+
29
+
To protect your rights, we need to prevent others from denying you
30
+
these rights or asking you to surrender the rights. Therefore, you have
31
+
certain responsibilities if you distribute copies of the software, or if
32
+
you modify it: responsibilities to respect the freedom of others.
33
+
34
+
For example, if you distribute copies of such a program, whether
35
+
gratis or for a fee, you must pass on to the recipients the same
36
+
freedoms that you received. You must make sure that they, too, receive
37
+
or can get the source code. And you must show them these terms so they
38
+
know their rights.
39
+
40
+
Developers that use the GNU GPL protect your rights with two steps:
41
+
(1) assert copyright on the software, and (2) offer you this License
42
+
giving you legal permission to copy, distribute and/or modify it.
43
+
44
+
For the developers' and authors' protection, the GPL clearly explains
45
+
that there is no warranty for this free software. For both users' and
46
+
authors' sake, the GPL requires that modified versions be marked as
47
+
changed, so that their problems will not be attributed erroneously to
48
+
authors of previous versions.
49
+
50
+
Some devices are designed to deny users access to install or run
51
+
modified versions of the software inside them, although the manufacturer
52
+
can do so. This is fundamentally incompatible with the aim of
53
+
protecting users' freedom to change the software. The systematic
54
+
pattern of such abuse occurs in the area of products for individuals to
55
+
use, which is precisely where it is most unacceptable. Therefore, we
56
+
have designed this version of the GPL to prohibit the practice for those
57
+
products. If such problems arise substantially in other domains, we
58
+
stand ready to extend this provision to those domains in future versions
59
+
of the GPL, as needed to protect the freedom of users.
60
+
61
+
Finally, every program is threatened constantly by software patents.
62
+
States should not allow patents to restrict development and use of
63
+
software on general-purpose computers, but in those that do, we wish to
64
+
avoid the special danger that patents applied to a free program could
65
+
make it effectively proprietary. To prevent this, the GPL assures that
66
+
patents cannot be used to render the program non-free.
67
+
68
+
The precise terms and conditions for copying, distribution and
69
+
modification follow.
70
+
71
+
TERMS AND CONDITIONS
72
+
73
+
0. Definitions.
74
+
75
+
"This License" refers to version 3 of the GNU General Public License.
76
+
77
+
"Copyright" also means copyright-like laws that apply to other kinds of
78
+
works, such as semiconductor masks.
79
+
80
+
"The Program" refers to any copyrightable work licensed under this
81
+
License. Each licensee is addressed as "you". "Licensees" and
82
+
"recipients" may be individuals or organizations.
83
+
84
+
To "modify" a work means to copy from or adapt all or part of the work
85
+
in a fashion requiring copyright permission, other than the making of an
86
+
exact copy. The resulting work is called a "modified version" of the
87
+
earlier work or a work "based on" the earlier work.
88
+
89
+
A "covered work" means either the unmodified Program or a work based
90
+
on the Program.
91
+
92
+
To "propagate" a work means to do anything with it that, without
93
+
permission, would make you directly or secondarily liable for
94
+
infringement under applicable copyright law, except executing it on a
95
+
computer or modifying a private copy. Propagation includes copying,
96
+
distribution (with or without modification), making available to the
97
+
public, and in some countries other activities as well.
98
+
99
+
To "convey" a work means any kind of propagation that enables other
100
+
parties to make or receive copies. Mere interaction with a user through
101
+
a computer network, with no transfer of a copy, is not conveying.
102
+
103
+
An interactive user interface displays "Appropriate Legal Notices"
104
+
to the extent that it includes a convenient and prominently visible
105
+
feature that (1) displays an appropriate copyright notice, and (2)
106
+
tells the user that there is no warranty for the work (except to the
107
+
extent that warranties are provided), that licensees may convey the
108
+
work under this License, and how to view a copy of this License. If
109
+
the interface presents a list of user commands or options, such as a
110
+
menu, a prominent item in the list meets this criterion.
111
+
112
+
1. Source Code.
113
+
114
+
The "source code" for a work means the preferred form of the work
115
+
for making modifications to it. "Object code" means any non-source
116
+
form of a work.
117
+
118
+
A "Standard Interface" means an interface that either is an official
119
+
standard defined by a recognized standards body, or, in the case of
120
+
interfaces specified for a particular programming language, one that
121
+
is widely used among developers working in that language.
122
+
123
+
The "System Libraries" of an executable work include anything, other
124
+
than the work as a whole, that (a) is included in the normal form of
125
+
packaging a Major Component, but which is not part of that Major
126
+
Component, and (b) serves only to enable use of the work with that
127
+
Major Component, or to implement a Standard Interface for which an
128
+
implementation is available to the public in source code form. A
129
+
"Major Component", in this context, means a major essential component
130
+
(kernel, window system, and so on) of the specific operating system
131
+
(if any) on which the executable work runs, or a compiler used to
132
+
produce the work, or an object code interpreter used to run it.
133
+
134
+
The "Corresponding Source" for a work in object code form means all
135
+
the source code needed to generate, install, and (for an executable
136
+
work) run the object code and to modify the work, including scripts to
137
+
control those activities. However, it does not include the work's
138
+
System Libraries, or general-purpose tools or generally available free
139
+
programs which are used unmodified in performing those activities but
140
+
which are not part of the work. For example, Corresponding Source
141
+
includes interface definition files associated with source files for
142
+
the work, and the source code for shared libraries and dynamically
143
+
linked subprograms that the work is specifically designed to require,
144
+
such as by intimate data communication or control flow between those
145
+
subprograms and other parts of the work.
146
+
147
+
The Corresponding Source need not include anything that users
148
+
can regenerate automatically from other parts of the Corresponding
149
+
Source.
150
+
151
+
The Corresponding Source for a work in source code form is that
152
+
same work.
153
+
154
+
2. Basic Permissions.
155
+
156
+
All rights granted under this License are granted for the term of
157
+
copyright on the Program, and are irrevocable provided the stated
158
+
conditions are met. This License explicitly affirms your unlimited
159
+
permission to run the unmodified Program. The output from running a
160
+
covered work is covered by this License only if the output, given its
161
+
content, constitutes a covered work. This License acknowledges your
162
+
rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+
You may make, run and propagate covered works that you do not
165
+
convey, without conditions so long as your license otherwise remains
166
+
in force. You may convey covered works to others for the sole purpose
167
+
of having them make modifications exclusively for you, or provide you
168
+
with facilities for running those works, provided that you comply with
169
+
the terms of this License in conveying all material for which you do
170
+
not control copyright. Those thus making or running the covered works
171
+
for you must do so exclusively on your behalf, under your direction
172
+
and control, on terms that prohibit them from making any copies of
173
+
your copyrighted material outside their relationship with you.
174
+
175
+
Conveying under any other circumstances is permitted solely under
176
+
the conditions stated below. Sublicensing is not allowed; section 10
177
+
makes it unnecessary.
178
+
179
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+
No covered work shall be deemed part of an effective technological
182
+
measure under any applicable law fulfilling obligations under article
183
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+
similar laws prohibiting or restricting circumvention of such
185
+
measures.
186
+
187
+
When you convey a covered work, you waive any legal power to forbid
188
+
circumvention of technological measures to the extent such circumvention
189
+
is effected by exercising rights under this License with respect to
190
+
the covered work, and you disclaim any intention to limit operation or
191
+
modification of the work as a means of enforcing, against the work's
192
+
users, your or third parties' legal rights to forbid circumvention of
193
+
technological measures.
194
+
195
+
4. Conveying Verbatim Copies.
196
+
197
+
You may convey verbatim copies of the Program's source code as you
198
+
receive it, in any medium, provided that you conspicuously and
199
+
appropriately publish on each copy an appropriate copyright notice;
200
+
keep intact all notices stating that this License and any
201
+
non-permissive terms added in accord with section 7 apply to the code;
202
+
keep intact all notices of the absence of any warranty; and give all
203
+
recipients a copy of this License along with the Program.
204
+
205
+
You may charge any price or no price for each copy that you convey,
206
+
and you may offer support or warranty protection for a fee.
207
+
208
+
5. Conveying Modified Source Versions.
209
+
210
+
You may convey a work based on the Program, or the modifications to
211
+
produce it from the Program, in the form of source code under the
212
+
terms of section 4, provided that you also meet all of these conditions:
213
+
214
+
a) The work must carry prominent notices stating that you modified
215
+
it, and giving a relevant date.
216
+
217
+
b) The work must carry prominent notices stating that it is
218
+
released under this License and any conditions added under section
219
+
7. This requirement modifies the requirement in section 4 to
220
+
"keep intact all notices".
221
+
222
+
c) You must license the entire work, as a whole, under this
223
+
License to anyone who comes into possession of a copy. This
224
+
License will therefore apply, along with any applicable section 7
225
+
additional terms, to the whole of the work, and all its parts,
226
+
regardless of how they are packaged. This License gives no
227
+
permission to license the work in any other way, but it does not
228
+
invalidate such permission if you have separately received it.
229
+
230
+
d) If the work has interactive user interfaces, each must display
231
+
Appropriate Legal Notices; however, if the Program has interactive
232
+
interfaces that do not display Appropriate Legal Notices, your
233
+
work need not make them do so.
234
+
235
+
A compilation of a covered work with other separate and independent
236
+
works, which are not by their nature extensions of the covered work,
237
+
and which are not combined with it such as to form a larger program,
238
+
in or on a volume of a storage or distribution medium, is called an
239
+
"aggregate" if the compilation and its resulting copyright are not
240
+
used to limit the access or legal rights of the compilation's users
241
+
beyond what the individual works permit. Inclusion of a covered work
242
+
in an aggregate does not cause this License to apply to the other
243
+
parts of the aggregate.
244
+
245
+
6. Conveying Non-Source Forms.
246
+
247
+
You may convey a covered work in object code form under the terms
248
+
of sections 4 and 5, provided that you also convey the
249
+
machine-readable Corresponding Source under the terms of this License,
250
+
in one of these ways:
251
+
252
+
a) Convey the object code in, or embodied in, a physical product
253
+
(including a physical distribution medium), accompanied by the
254
+
Corresponding Source fixed on a durable physical medium
255
+
customarily used for software interchange.
256
+
257
+
b) Convey the object code in, or embodied in, a physical product
258
+
(including a physical distribution medium), accompanied by a
259
+
written offer, valid for at least three years and valid for as
260
+
long as you offer spare parts or customer support for that product
261
+
model, to give anyone who possesses the object code either (1) a
262
+
copy of the Corresponding Source for all the software in the
263
+
product that is covered by this License, on a durable physical
264
+
medium customarily used for software interchange, for a price no
265
+
more than your reasonable cost of physically performing this
266
+
conveying of source, or (2) access to copy the
267
+
Corresponding Source from a network server at no charge.
268
+
269
+
c) Convey individual copies of the object code with a copy of the
270
+
written offer to provide the Corresponding Source. This
271
+
alternative is allowed only occasionally and noncommercially, and
272
+
only if you received the object code with such an offer, in accord
273
+
with subsection 6b.
274
+
275
+
d) Convey the object code by offering access from a designated
276
+
place (gratis or for a charge), and offer equivalent access to the
277
+
Corresponding Source in the same way through the same place at no
278
+
further charge. You need not require recipients to copy the
279
+
Corresponding Source along with the object code. If the place to
280
+
copy the object code is a network server, the Corresponding Source
281
+
may be on a different server (operated by you or a third party)
282
+
that supports equivalent copying facilities, provided you maintain
283
+
clear directions next to the object code saying where to find the
284
+
Corresponding Source. Regardless of what server hosts the
285
+
Corresponding Source, you remain obligated to ensure that it is
286
+
available for as long as needed to satisfy these requirements.
287
+
288
+
e) Convey the object code using peer-to-peer transmission, provided
289
+
you inform other peers where the object code and Corresponding
290
+
Source of the work are being offered to the general public at no
291
+
charge under subsection 6d.
292
+
293
+
A separable portion of the object code, whose source code is excluded
294
+
from the Corresponding Source as a System Library, need not be
295
+
included in conveying the object code work.
296
+
297
+
A "User Product" is either (1) a "consumer product", which means any
298
+
tangible personal property which is normally used for personal, family,
299
+
or household purposes, or (2) anything designed or sold for incorporation
300
+
into a dwelling. In determining whether a product is a consumer product,
301
+
doubtful cases shall be resolved in favor of coverage. For a particular
302
+
product received by a particular user, "normally used" refers to a
303
+
typical or common use of that class of product, regardless of the status
304
+
of the particular user or of the way in which the particular user
305
+
actually uses, or expects or is expected to use, the product. A product
306
+
is a consumer product regardless of whether the product has substantial
307
+
commercial, industrial or non-consumer uses, unless such uses represent
308
+
the only significant mode of use of the product.
309
+
310
+
"Installation Information" for a User Product means any methods,
311
+
procedures, authorization keys, or other information required to install
312
+
and execute modified versions of a covered work in that User Product from
313
+
a modified version of its Corresponding Source. The information must
314
+
suffice to ensure that the continued functioning of the modified object
315
+
code is in no case prevented or interfered with solely because
316
+
modification has been made.
317
+
318
+
If you convey an object code work under this section in, or with, or
319
+
specifically for use in, a User Product, and the conveying occurs as
320
+
part of a transaction in which the right of possession and use of the
321
+
User Product is transferred to the recipient in perpetuity or for a
322
+
fixed term (regardless of how the transaction is characterized), the
323
+
Corresponding Source conveyed under this section must be accompanied
324
+
by the Installation Information. But this requirement does not apply
325
+
if neither you nor any third party retains the ability to install
326
+
modified object code on the User Product (for example, the work has
327
+
been installed in ROM).
328
+
329
+
The requirement to provide Installation Information does not include a
330
+
requirement to continue to provide support service, warranty, or updates
331
+
for a work that has been modified or installed by the recipient, or for
332
+
the User Product in which it has been modified or installed. Access to a
333
+
network may be denied when the modification itself materially and
334
+
adversely affects the operation of the network or violates the rules and
335
+
protocols for communication across the network.
336
+
337
+
Corresponding Source conveyed, and Installation Information provided,
338
+
in accord with this section must be in a format that is publicly
339
+
documented (and with an implementation available to the public in
340
+
source code form), and must require no special password or key for
341
+
unpacking, reading or copying.
342
+
343
+
7. Additional Terms.
344
+
345
+
"Additional permissions" are terms that supplement the terms of this
346
+
License by making exceptions from one or more of its conditions.
347
+
Additional permissions that are applicable to the entire Program shall
348
+
be treated as though they were included in this License, to the extent
349
+
that they are valid under applicable law. If additional permissions
350
+
apply only to part of the Program, that part may be used separately
351
+
under those permissions, but the entire Program remains governed by
352
+
this License without regard to the additional permissions.
353
+
354
+
When you convey a copy of a covered work, you may at your option
355
+
remove any additional permissions from that copy, or from any part of
356
+
it. (Additional permissions may be written to require their own
357
+
removal in certain cases when you modify the work.) You may place
358
+
additional permissions on material, added by you to a covered work,
359
+
for which you have or can give appropriate copyright permission.
360
+
361
+
Notwithstanding any other provision of this License, for material you
362
+
add to a covered work, you may (if authorized by the copyright holders of
363
+
that material) supplement the terms of this License with terms:
364
+
365
+
a) Disclaiming warranty or limiting liability differently from the
366
+
terms of sections 15 and 16 of this License; or
367
+
368
+
b) Requiring preservation of specified reasonable legal notices or
369
+
author attributions in that material or in the Appropriate Legal
370
+
Notices displayed by works containing it; or
371
+
372
+
c) Prohibiting misrepresentation of the origin of that material, or
373
+
requiring that modified versions of such material be marked in
374
+
reasonable ways as different from the original version; or
375
+
376
+
d) Limiting the use for publicity purposes of names of licensors or
377
+
authors of the material; or
378
+
379
+
e) Declining to grant rights under trademark law for use of some
380
+
trade names, trademarks, or service marks; or
381
+
382
+
f) Requiring indemnification of licensors and authors of that
383
+
material by anyone who conveys the material (or modified versions of
384
+
it) with contractual assumptions of liability to the recipient, for
385
+
any liability that these contractual assumptions directly impose on
386
+
those licensors and authors.
387
+
388
+
All other non-permissive additional terms are considered "further
389
+
restrictions" within the meaning of section 10. If the Program as you
390
+
received it, or any part of it, contains a notice stating that it is
391
+
governed by this License along with a term that is a further
392
+
restriction, you may remove that term. If a license document contains
393
+
a further restriction but permits relicensing or conveying under this
394
+
License, you may add to a covered work material governed by the terms
395
+
of that license document, provided that the further restriction does
396
+
not survive such relicensing or conveying.
397
+
398
+
If you add terms to a covered work in accord with this section, you
399
+
must place, in the relevant source files, a statement of the
400
+
additional terms that apply to those files, or a notice indicating
401
+
where to find the applicable terms.
402
+
403
+
Additional terms, permissive or non-permissive, may be stated in the
404
+
form of a separately written license, or stated as exceptions;
405
+
the above requirements apply either way.
406
+
407
+
8. Termination.
408
+
409
+
You may not propagate or modify a covered work except as expressly
410
+
provided under this License. Any attempt otherwise to propagate or
411
+
modify it is void, and will automatically terminate your rights under
412
+
this License (including any patent licenses granted under the third
413
+
paragraph of section 11).
414
+
415
+
However, if you cease all violation of this License, then your
416
+
license from a particular copyright holder is reinstated (a)
417
+
provisionally, unless and until the copyright holder explicitly and
418
+
finally terminates your license, and (b) permanently, if the copyright
419
+
holder fails to notify you of the violation by some reasonable means
420
+
prior to 60 days after the cessation.
421
+
422
+
Moreover, your license from a particular copyright holder is
423
+
reinstated permanently if the copyright holder notifies you of the
424
+
violation by some reasonable means, this is the first time you have
425
+
received notice of violation of this License (for any work) from that
426
+
copyright holder, and you cure the violation prior to 30 days after
427
+
your receipt of the notice.
428
+
429
+
Termination of your rights under this section does not terminate the
430
+
licenses of parties who have received copies or rights from you under
431
+
this License. If your rights have been terminated and not permanently
432
+
reinstated, you do not qualify to receive new licenses for the same
433
+
material under section 10.
434
+
435
+
9. Acceptance Not Required for Having Copies.
436
+
437
+
You are not required to accept this License in order to receive or
438
+
run a copy of the Program. Ancillary propagation of a covered work
439
+
occurring solely as a consequence of using peer-to-peer transmission
440
+
to receive a copy likewise does not require acceptance. However,
441
+
nothing other than this License grants you permission to propagate or
442
+
modify any covered work. These actions infringe copyright if you do
443
+
not accept this License. Therefore, by modifying or propagating a
444
+
covered work, you indicate your acceptance of this License to do so.
445
+
446
+
10. Automatic Licensing of Downstream Recipients.
447
+
448
+
Each time you convey a covered work, the recipient automatically
449
+
receives a license from the original licensors, to run, modify and
450
+
propagate that work, subject to this License. You are not responsible
451
+
for enforcing compliance by third parties with this License.
452
+
453
+
An "entity transaction" is a transaction transferring control of an
454
+
organization, or substantially all assets of one, or subdividing an
455
+
organization, or merging organizations. If propagation of a covered
456
+
work results from an entity transaction, each party to that
457
+
transaction who receives a copy of the work also receives whatever
458
+
licenses to the work the party's predecessor in interest had or could
459
+
give under the previous paragraph, plus a right to possession of the
460
+
Corresponding Source of the work from the predecessor in interest, if
461
+
the predecessor has it or can get it with reasonable efforts.
462
+
463
+
You may not impose any further restrictions on the exercise of the
464
+
rights granted or affirmed under this License. For example, you may
465
+
not impose a license fee, royalty, or other charge for exercise of
466
+
rights granted under this License, and you may not initiate litigation
467
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
468
+
any patent claim is infringed by making, using, selling, offering for
469
+
sale, or importing the Program or any portion of it.
470
+
471
+
11. Patents.
472
+
473
+
A "contributor" is a copyright holder who authorizes use under this
474
+
License of the Program or a work on which the Program is based. The
475
+
work thus licensed is called the contributor's "contributor version".
476
+
477
+
A contributor's "essential patent claims" are all patent claims
478
+
owned or controlled by the contributor, whether already acquired or
479
+
hereafter acquired, that would be infringed by some manner, permitted
480
+
by this License, of making, using, or selling its contributor version,
481
+
but do not include claims that would be infringed only as a
482
+
consequence of further modification of the contributor version. For
483
+
purposes of this definition, "control" includes the right to grant
484
+
patent sublicenses in a manner consistent with the requirements of
485
+
this License.
486
+
487
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+
patent license under the contributor's essential patent claims, to
489
+
make, use, sell, offer for sale, import and otherwise run, modify and
490
+
propagate the contents of its contributor version.
491
+
492
+
In the following three paragraphs, a "patent license" is any express
493
+
agreement or commitment, however denominated, not to enforce a patent
494
+
(such as an express permission to practice a patent or covenant not to
495
+
sue for patent infringement). To "grant" such a patent license to a
496
+
party means to make such an agreement or commitment not to enforce a
497
+
patent against the party.
498
+
499
+
If you convey a covered work, knowingly relying on a patent license,
500
+
and the Corresponding Source of the work is not available for anyone
501
+
to copy, free of charge and under the terms of this License, through a
502
+
publicly available network server or other readily accessible means,
503
+
then you must either (1) cause the Corresponding Source to be so
504
+
available, or (2) arrange to deprive yourself of the benefit of the
505
+
patent license for this particular work, or (3) arrange, in a manner
506
+
consistent with the requirements of this License, to extend the patent
507
+
license to downstream recipients. "Knowingly relying" means you have
508
+
actual knowledge that, but for the patent license, your conveying the
509
+
covered work in a country, or your recipient's use of the covered work
510
+
in a country, would infringe one or more identifiable patents in that
511
+
country that you have reason to believe are valid.
512
+
513
+
If, pursuant to or in connection with a single transaction or
514
+
arrangement, you convey, or propagate by procuring conveyance of, a
515
+
covered work, and grant a patent license to some of the parties
516
+
receiving the covered work authorizing them to use, propagate, modify
517
+
or convey a specific copy of the covered work, then the patent license
518
+
you grant is automatically extended to all recipients of the covered
519
+
work and works based on it.
520
+
521
+
A patent license is "discriminatory" if it does not include within
522
+
the scope of its coverage, prohibits the exercise of, or is
523
+
conditioned on the non-exercise of one or more of the rights that are
524
+
specifically granted under this License. You may not convey a covered
525
+
work if you are a party to an arrangement with a third party that is
526
+
in the business of distributing software, under which you make payment
527
+
to the third party based on the extent of your activity of conveying
528
+
the work, and under which the third party grants, to any of the
529
+
parties who would receive the covered work from you, a discriminatory
530
+
patent license (a) in connection with copies of the covered work
531
+
conveyed by you (or copies made from those copies), or (b) primarily
532
+
for and in connection with specific products or compilations that
533
+
contain the covered work, unless you entered into that arrangement,
534
+
or that patent license was granted, prior to 28 March 2007.
535
+
536
+
Nothing in this License shall be construed as excluding or limiting
537
+
any implied license or other defenses to infringement that may
538
+
otherwise be available to you under applicable patent law.
539
+
540
+
12. No Surrender of Others' Freedom.
541
+
542
+
If conditions are imposed on you (whether by court order, agreement or
543
+
otherwise) that contradict the conditions of this License, they do not
544
+
excuse you from the conditions of this License. If you cannot convey a
545
+
covered work so as to satisfy simultaneously your obligations under this
546
+
License and any other pertinent obligations, then as a consequence you may
547
+
not convey it at all. For example, if you agree to terms that obligate you
548
+
to collect a royalty for further conveying from those to whom you convey
549
+
the Program, the only way you could satisfy both those terms and this
550
+
License would be to refrain entirely from conveying the Program.
551
+
552
+
13. Use with the GNU Affero General Public License.
553
+
554
+
Notwithstanding any other provision of this License, you have
555
+
permission to link or combine any covered work with a work licensed
556
+
under version 3 of the GNU Affero General Public License into a single
557
+
combined work, and to convey the resulting work. The terms of this
558
+
License will continue to apply to the part which is the covered work,
559
+
but the special requirements of the GNU Affero General Public License,
560
+
section 13, concerning interaction through a network will apply to the
561
+
combination as such.
562
+
563
+
14. Revised Versions of this License.
564
+
565
+
The Free Software Foundation may publish revised and/or new versions of
566
+
the GNU General Public License from time to time. Such new versions will
567
+
be similar in spirit to the present version, but may differ in detail to
568
+
address new problems or concerns.
569
+
570
+
Each version is given a distinguishing version number. If the
571
+
Program specifies that a certain numbered version of the GNU General
572
+
Public License "or any later version" applies to it, you have the
573
+
option of following the terms and conditions either of that numbered
574
+
version or of any later version published by the Free Software
575
+
Foundation. If the Program does not specify a version number of the
576
+
GNU General Public License, you may choose any version ever published
577
+
by the Free Software Foundation.
578
+
579
+
If the Program specifies that a proxy can decide which future
580
+
versions of the GNU General Public License can be used, that proxy's
581
+
public statement of acceptance of a version permanently authorizes you
582
+
to choose that version for the Program.
583
+
584
+
Later license versions may give you additional or different
585
+
permissions. However, no additional obligations are imposed on any
586
+
author or copyright holder as a result of your choosing to follow a
587
+
later version.
588
+
589
+
15. Disclaimer of Warranty.
590
+
591
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+
16. Limitation of Liability.
601
+
602
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+
SUCH DAMAGES.
611
+
612
+
17. Interpretation of Sections 15 and 16.
613
+
614
+
If the disclaimer of warranty and limitation of liability provided
615
+
above cannot be given local legal effect according to their terms,
616
+
reviewing courts shall apply local law that most closely approximates
617
+
an absolute waiver of all civil liability in connection with the
618
+
Program, unless a warranty or assumption of liability accompanies a
619
+
copy of the Program in return for a fee.
620
+
621
+
END OF TERMS AND CONDITIONS
622
+
623
+
How to Apply These Terms to Your New Programs
624
+
625
+
If you develop a new program, and you want it to be of the greatest
626
+
possible use to the public, the best way to achieve this is to make it
627
+
free software which everyone can redistribute and change under these terms.
628
+
629
+
To do so, attach the following notices to the program. It is safest
630
+
to attach them to the start of each source file to most effectively
631
+
state the exclusion of warranty; and each file should have at least
632
+
the "copyright" line and a pointer to where the full notice is found.
633
+
634
+
<one line to give the program's name and a brief idea of what it does.>
635
+
Copyright (C) <year> <name of author>
636
+
637
+
This program is free software: you can redistribute it and/or modify
638
+
it under the terms of the GNU General Public License as published by
639
+
the Free Software Foundation, either version 3 of the License, or
640
+
(at your option) any later version.
641
+
642
+
This program is distributed in the hope that it will be useful,
643
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
644
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645
+
GNU General Public License for more details.
646
+
647
+
You should have received a copy of the GNU General Public License
648
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
649
+
650
+
Also add information on how to contact you by electronic and paper mail.
651
+
652
+
If the program does terminal interaction, make it output a short
653
+
notice like this when it starts in an interactive mode:
654
+
655
+
<program> Copyright (C) <year> <name of author>
656
+
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
+
This is free software, and you are welcome to redistribute it
658
+
under certain conditions; type `show c' for details.
659
+
660
+
The hypothetical commands `show w' and `show c' should show the appropriate
661
+
parts of the General Public License. Of course, your program's commands
662
+
might be different; for a GUI interface, you would use an "about box".
663
+
664
+
You should also get your employer (if you work as a programmer) or school,
665
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
666
+
For more information on this, and how to apply and follow the GNU GPL, see
667
+
<https://www.gnu.org/licenses/>.
668
+
669
+
The GNU General Public License does not permit incorporating your program
670
+
into proprietary programs. If your program is a subroutine library, you
671
+
may consider it more useful to permit linking proprietary applications with
672
+
the library. If this is what you want to do, use the GNU Lesser General
673
+
Public License instead of this License. But first, please read
674
+
<https://www.gnu.org/licenses/why-not-lgpl.html>.
+212
README.md
+212
README.md
···
1
+
# 🚀 Iku
2
+
3
+
> Grammar-Aware Go Formatter
4
+
5
+
Iku is a grammar-based Go formatter that enforces consistent blank-line placement by AST node type.
6
+
7
+
## Philosophy
8
+
9
+
Code structure should be visually apparent from its formatting. Iku groups statements by grammatical type and separates them with blank lines, making the code flow easier to read at a glance.
10
+
11
+
## Rules
12
+
13
+
1. **Same AST type means no blank line**: Consecutive statements of the same type stay together
14
+
2. **Different AST type means blank line**: Transitions between statement types get visual separation
15
+
3. **Scoped statements get blank lines**: `if`, `for`, `switch`, `select` always have blank lines before them
16
+
4. **Top-level declarations are separated**: Functions, types, and variables at the package level get blank lines between them
17
+
18
+
## How It Works
19
+
20
+
Iku runs `go fmt` first, then applies its grammar-based blank-line rules on top of it. Your code gets standard Go formatting plus structural separation.
21
+
22
+
## Installation
23
+
24
+
```bash
25
+
go install github.com/Fuwn/iku@latest
26
+
```
27
+
28
+
## Usage
29
+
30
+
```bash
31
+
# Format stdin
32
+
echo 'package main...' | iku
33
+
34
+
# Format and print to stdout
35
+
iku file.go
36
+
37
+
# Format in-place
38
+
iku -w file.go
39
+
40
+
# Format entire directory
41
+
iku -w ./...
42
+
43
+
# List files that need formatting
44
+
iku -l .
45
+
46
+
# Show diff
47
+
iku -d file.go
48
+
```
49
+
50
+
### Flags
51
+
52
+
| Flag | Description |
53
+
|------|-------------|
54
+
| `-w` | Write result to file instead of stdout |
55
+
| `-l` | List files whose formatting differs |
56
+
| `-d` | Display diffs instead of rewriting |
57
+
| `--comments` | Comment attachment mode: `follow`, `precede`, `standalone` |
58
+
| `--version` | Print version |
59
+
60
+
## Examples
61
+
62
+
### Before
63
+
64
+
```go
65
+
package main
66
+
67
+
func main() {
68
+
x := 1
69
+
y := 2
70
+
var config = loadConfig()
71
+
defer cleanup()
72
+
defer closeDB()
73
+
if err != nil {
74
+
return err
75
+
}
76
+
if x > 0 {
77
+
process(x)
78
+
}
79
+
go worker()
80
+
return nil
81
+
}
82
+
```
83
+
84
+
### After
85
+
86
+
```go
87
+
package main
88
+
89
+
func main() {
90
+
x := 1
91
+
y := 2
92
+
93
+
var config = loadConfig()
94
+
95
+
defer cleanup()
96
+
defer closeDB()
97
+
98
+
if err != nil {
99
+
return err
100
+
}
101
+
102
+
if x > 0 {
103
+
process(x)
104
+
}
105
+
106
+
go worker()
107
+
108
+
return nil
109
+
}
110
+
```
111
+
112
+
Notice how:
113
+
- `x := 1` and `y := 2` (both `AssignStmt`) stay together
114
+
- `var config` (`DeclStmt`) gets separated from assignments
115
+
- `defer` statements stay grouped together
116
+
- Each `if` statement gets a blank line before it (scoped statement)
117
+
- `go worker()` (`GoStmt`) is separated from the `if` above
118
+
- `return` (`ReturnStmt`) is separated from the `go` statement
119
+
120
+
### Top-Level Declarations
121
+
122
+
```go
123
+
// Before
124
+
package main
125
+
type Config struct {
126
+
Name string
127
+
}
128
+
var defaultConfig = Config{}
129
+
func main() {
130
+
run()
131
+
}
132
+
func run() {
133
+
process()
134
+
}
135
+
136
+
// After
137
+
package main
138
+
139
+
type Config struct {
140
+
Name string
141
+
}
142
+
143
+
var defaultConfig = Config{}
144
+
145
+
func main() {
146
+
run()
147
+
}
148
+
149
+
func run() {
150
+
process()
151
+
}
152
+
```
153
+
154
+
### Switch Statements
155
+
156
+
```go
157
+
// Before
158
+
func process(x int) {
159
+
result := compute(x)
160
+
switch result {
161
+
case 1:
162
+
handleOne()
163
+
if needsExtra {
164
+
doExtra()
165
+
}
166
+
case 2:
167
+
handleTwo()
168
+
}
169
+
cleanup()
170
+
}
171
+
172
+
// After
173
+
func process(x int) {
174
+
result := compute(x)
175
+
176
+
switch result {
177
+
case 1:
178
+
handleOne()
179
+
180
+
if needsExtra {
181
+
doExtra()
182
+
}
183
+
case 2:
184
+
handleTwo()
185
+
}
186
+
187
+
cleanup()
188
+
}
189
+
```
190
+
191
+
## AST Node Types
192
+
193
+
For reference, here are common Go statement types that Iku distinguishes:
194
+
195
+
| Type | Examples |
196
+
|------|----------|
197
+
| `*ast.AssignStmt` | `x := 1`, `x = 2` |
198
+
| `*ast.DeclStmt` | `var x = 1` |
199
+
| `*ast.ExprStmt` | `fmt.Println()`, `doSomething()` |
200
+
| `*ast.ReturnStmt` | `return x` |
201
+
| `*ast.IfStmt` | `if x > 0 { }` |
202
+
| `*ast.ForStmt` | `for i := 0; i < n; i++ { }` |
203
+
| `*ast.RangeStmt` | `for k, v := range m { }` |
204
+
| `*ast.SwitchStmt` | `switch x { }` |
205
+
| `*ast.SelectStmt` | `select { }` |
206
+
| `*ast.DeferStmt` | `defer f()` |
207
+
| `*ast.GoStmt` | `go f()` |
208
+
| `*ast.SendStmt` | `ch <- x` |
209
+
210
+
## License
211
+
212
+
This project is licensed under the [GNU General Public License v3.0](./LICENSE.txt).
+315
formatter.go
+315
formatter.go
···
1
+
package main
2
+
3
+
import (
4
+
"go/ast"
5
+
"go/format"
6
+
"go/parser"
7
+
"go/token"
8
+
"reflect"
9
+
"regexp"
10
+
"strings"
11
+
)
12
+
13
+
type CommentMode int
14
+
15
+
const (
16
+
CommentsFollow CommentMode = iota
17
+
CommentsPrecede
18
+
CommentsStandalone
19
+
)
20
+
21
+
type Formatter struct {
22
+
CommentMode CommentMode
23
+
}
24
+
25
+
type lineInfo struct {
26
+
statementType string
27
+
isTopLevel bool
28
+
isScoped bool
29
+
isStartLine bool
30
+
}
31
+
32
+
func (f *Formatter) Format(source []byte) ([]byte, error) {
33
+
formatted, err := format.Source(source)
34
+
35
+
if err != nil {
36
+
return nil, err
37
+
}
38
+
39
+
fileSet := token.NewFileSet()
40
+
file, err := parser.ParseFile(fileSet, "", formatted, parser.ParseComments)
41
+
42
+
if err != nil {
43
+
return nil, err
44
+
}
45
+
46
+
lineInfoMap := f.buildLineInfo(fileSet, file)
47
+
48
+
return f.rewrite(formatted, lineInfoMap), nil
49
+
}
50
+
51
+
func (f *Formatter) buildLineInfo(fileSet *token.FileSet, file *ast.File) map[int]*lineInfo {
52
+
lineInfoMap := make(map[int]*lineInfo)
53
+
tokenFile := fileSet.File(file.Pos())
54
+
55
+
if tokenFile == nil {
56
+
return lineInfoMap
57
+
}
58
+
59
+
for _, declaration := range file.Decls {
60
+
startLine := tokenFile.Line(declaration.Pos())
61
+
endLine := tokenFile.Line(declaration.End())
62
+
typeName := reflect.TypeOf(declaration).String()
63
+
lineInfoMap[startLine] = &lineInfo{statementType: typeName, isTopLevel: true, isStartLine: true}
64
+
lineInfoMap[endLine] = &lineInfo{statementType: typeName, isTopLevel: true, isStartLine: false}
65
+
}
66
+
67
+
ast.Inspect(file, func(node ast.Node) bool {
68
+
if node == nil {
69
+
return true
70
+
}
71
+
72
+
switch typedNode := node.(type) {
73
+
case *ast.BlockStmt:
74
+
f.processBlock(tokenFile, typedNode, lineInfoMap)
75
+
case *ast.CaseClause:
76
+
f.processStatementList(tokenFile, typedNode.Body, lineInfoMap)
77
+
case *ast.CommClause:
78
+
f.processStatementList(tokenFile, typedNode.Body, lineInfoMap)
79
+
}
80
+
81
+
return true
82
+
})
83
+
84
+
return lineInfoMap
85
+
}
86
+
87
+
func (f *Formatter) processBlock(tokenFile *token.File, block *ast.BlockStmt, lineInfoMap map[int]*lineInfo) {
88
+
if block == nil {
89
+
return
90
+
}
91
+
92
+
f.processStatementList(tokenFile, block.List, lineInfoMap)
93
+
}
94
+
95
+
func (f *Formatter) processStatementList(tokenFile *token.File, statements []ast.Stmt, lineInfoMap map[int]*lineInfo) {
96
+
for _, statement := range statements {
97
+
startLine := tokenFile.Line(statement.Pos())
98
+
endLine := tokenFile.Line(statement.End())
99
+
typeName := reflect.TypeOf(statement).String()
100
+
isScoped := false
101
+
102
+
switch statement.(type) {
103
+
case *ast.IfStmt, *ast.ForStmt, *ast.RangeStmt, *ast.SwitchStmt,
104
+
*ast.TypeSwitchStmt, *ast.SelectStmt, *ast.BlockStmt:
105
+
106
+
isScoped = true
107
+
}
108
+
109
+
existingStart := lineInfoMap[startLine]
110
+
111
+
if existingStart == nil || !existingStart.isStartLine {
112
+
lineInfoMap[startLine] = &lineInfo{statementType: typeName, isTopLevel: false, isScoped: isScoped, isStartLine: true}
113
+
}
114
+
115
+
existingEnd := lineInfoMap[endLine]
116
+
117
+
if existingEnd == nil || !existingEnd.isStartLine {
118
+
lineInfoMap[endLine] = &lineInfo{statementType: typeName, isTopLevel: false, isScoped: isScoped, isStartLine: false}
119
+
}
120
+
121
+
switch typedStatement := statement.(type) {
122
+
case *ast.IfStmt:
123
+
f.processBlock(tokenFile, typedStatement.Body, lineInfoMap)
124
+
125
+
if typedStatement.Else != nil {
126
+
if elseBlock, isBlockStatement := typedStatement.Else.(*ast.BlockStmt); isBlockStatement {
127
+
f.processBlock(tokenFile, elseBlock, lineInfoMap)
128
+
} else if elseIfStatement, isIfStatement := typedStatement.Else.(*ast.IfStmt); isIfStatement {
129
+
f.processIfStatement(tokenFile, elseIfStatement, lineInfoMap)
130
+
}
131
+
}
132
+
case *ast.ForStmt:
133
+
f.processBlock(tokenFile, typedStatement.Body, lineInfoMap)
134
+
case *ast.RangeStmt:
135
+
f.processBlock(tokenFile, typedStatement.Body, lineInfoMap)
136
+
case *ast.SwitchStmt:
137
+
f.processBlock(tokenFile, typedStatement.Body, lineInfoMap)
138
+
case *ast.TypeSwitchStmt:
139
+
f.processBlock(tokenFile, typedStatement.Body, lineInfoMap)
140
+
case *ast.SelectStmt:
141
+
f.processBlock(tokenFile, typedStatement.Body, lineInfoMap)
142
+
case *ast.BlockStmt:
143
+
f.processBlock(tokenFile, typedStatement, lineInfoMap)
144
+
}
145
+
}
146
+
}
147
+
148
+
func (f *Formatter) processIfStatement(tokenFile *token.File, ifStatement *ast.IfStmt, lineInfoMap map[int]*lineInfo) {
149
+
startLine := tokenFile.Line(ifStatement.Pos())
150
+
endLine := tokenFile.Line(ifStatement.End())
151
+
existingStart := lineInfoMap[startLine]
152
+
153
+
if existingStart == nil || !existingStart.isStartLine {
154
+
lineInfoMap[startLine] = &lineInfo{statementType: "*ast.IfStmt", isTopLevel: false, isScoped: true, isStartLine: true}
155
+
}
156
+
157
+
existingEnd := lineInfoMap[endLine]
158
+
159
+
if existingEnd == nil || !existingEnd.isStartLine {
160
+
lineInfoMap[endLine] = &lineInfo{statementType: "*ast.IfStmt", isTopLevel: false, isScoped: true, isStartLine: false}
161
+
}
162
+
163
+
f.processBlock(tokenFile, ifStatement.Body, lineInfoMap)
164
+
165
+
if ifStatement.Else != nil {
166
+
if elseBlock, isBlockStatement := ifStatement.Else.(*ast.BlockStmt); isBlockStatement {
167
+
f.processBlock(tokenFile, elseBlock, lineInfoMap)
168
+
} else if elseIfStatement, isIfStatement := ifStatement.Else.(*ast.IfStmt); isIfStatement {
169
+
f.processIfStatement(tokenFile, elseIfStatement, lineInfoMap)
170
+
}
171
+
}
172
+
}
173
+
174
+
func (f *Formatter) rewrite(source []byte, lineInfoMap map[int]*lineInfo) []byte {
175
+
lines := strings.Split(string(source), "\n")
176
+
177
+
var result []string
178
+
179
+
closingBracePattern := regexp.MustCompile(`^\s*[\}\)]`)
180
+
openingBracePattern := regexp.MustCompile(`[\{\(]\s*$`)
181
+
caseLabelPattern := regexp.MustCompile(`^\s*(case\s+.*|default\s*):\s*$`)
182
+
commentOnlyPattern := regexp.MustCompile(`^\s*//`)
183
+
packageLinePattern := regexp.MustCompile(`^package\s+`)
184
+
previousWasOpenBrace := false
185
+
previousType := ""
186
+
previousWasComment := false
187
+
previousWasTopLevel := false
188
+
insideRawString := false
189
+
190
+
for index, line := range lines {
191
+
backtickCount := strings.Count(line, "`")
192
+
wasInsideRawString := insideRawString
193
+
194
+
if backtickCount%2 == 1 {
195
+
insideRawString = !insideRawString
196
+
}
197
+
198
+
if wasInsideRawString {
199
+
result = append(result, line)
200
+
continue
201
+
}
202
+
203
+
lineNumber := index + 1
204
+
trimmed := strings.TrimSpace(line)
205
+
isBlank := trimmed == ""
206
+
isClosingBrace := closingBracePattern.MatchString(line)
207
+
isOpeningBrace := openingBracePattern.MatchString(line)
208
+
isCaseLabel := caseLabelPattern.MatchString(line)
209
+
isCommentOnlyLine := commentOnlyPattern.MatchString(line)
210
+
isPackageLine := packageLinePattern.MatchString(trimmed)
211
+
212
+
if isBlank {
213
+
continue
214
+
}
215
+
216
+
info := lineInfoMap[lineNumber]
217
+
currentType := ""
218
+
219
+
if info != nil {
220
+
currentType = info.statementType
221
+
}
222
+
223
+
if isPackageLine {
224
+
currentType = "package"
225
+
}
226
+
227
+
needsBlank := false
228
+
currentIsTopLevel := info != nil && info.isTopLevel
229
+
currentIsScoped := info != nil && info.isScoped
230
+
231
+
if len(result) > 0 && !previousWasOpenBrace && !isClosingBrace && !isCaseLabel {
232
+
if currentIsTopLevel && previousWasTopLevel {
233
+
if f.CommentMode == CommentsFollow && previousWasComment {
234
+
} else {
235
+
needsBlank = true
236
+
}
237
+
} else if currentIsScoped {
238
+
if f.CommentMode == CommentsFollow && previousWasComment {
239
+
} else {
240
+
needsBlank = true
241
+
}
242
+
} else if currentType != "" && previousType != "" && currentType != previousType {
243
+
if f.CommentMode == CommentsFollow && previousWasComment {
244
+
} else {
245
+
needsBlank = true
246
+
}
247
+
}
248
+
249
+
if f.CommentMode == CommentsFollow && isCommentOnlyLine && !previousWasComment {
250
+
nextLineNumber := f.findNextNonCommentLine(lines, index+1)
251
+
252
+
if nextLineNumber > 0 {
253
+
nextInfo := lineInfoMap[nextLineNumber]
254
+
255
+
if nextInfo != nil {
256
+
nextIsTopLevel := nextInfo.isTopLevel
257
+
nextIsScoped := nextInfo.isScoped
258
+
259
+
if nextIsTopLevel && previousWasTopLevel {
260
+
needsBlank = true
261
+
} else if nextIsScoped {
262
+
needsBlank = true
263
+
} else if nextInfo.statementType != "" && previousType != "" && nextInfo.statementType != previousType {
264
+
needsBlank = true
265
+
}
266
+
}
267
+
}
268
+
}
269
+
}
270
+
271
+
if needsBlank {
272
+
result = append(result, "")
273
+
}
274
+
275
+
result = append(result, line)
276
+
previousWasOpenBrace = isOpeningBrace || isCaseLabel
277
+
previousWasComment = isCommentOnlyLine
278
+
279
+
if info != nil {
280
+
previousType = info.statementType
281
+
previousWasTopLevel = info.isTopLevel
282
+
} else if currentType != "" {
283
+
previousType = currentType
284
+
previousWasTopLevel = false
285
+
}
286
+
}
287
+
288
+
output := strings.Join(result, "\n")
289
+
290
+
if !strings.HasSuffix(output, "\n") {
291
+
output += "\n"
292
+
}
293
+
294
+
return []byte(output)
295
+
}
296
+
297
+
func (f *Formatter) findNextNonCommentLine(lines []string, startIndex int) int {
298
+
commentOnlyPattern := regexp.MustCompile(`^\s*//`)
299
+
300
+
for index := startIndex; index < len(lines); index++ {
301
+
trimmed := strings.TrimSpace(lines[index])
302
+
303
+
if trimmed == "" {
304
+
continue
305
+
}
306
+
307
+
if commentOnlyPattern.MatchString(lines[index]) {
308
+
continue
309
+
}
310
+
311
+
return index + 1
312
+
}
313
+
314
+
return 0
315
+
}
+49
formatter_bench_test.go
+49
formatter_bench_test.go
···
1
+
package main
2
+
3
+
import (
4
+
"strings"
5
+
"testing"
6
+
)
7
+
8
+
func BenchmarkFormat_Small(b *testing.B) {
9
+
input := []byte(`package main
10
+
func main() {
11
+
x := 1
12
+
y := 2
13
+
if x > 0 {
14
+
z := 3
15
+
}
16
+
a := 4
17
+
}
18
+
`)
19
+
f := &Formatter{CommentMode: CommentsFollow}
20
+
21
+
for b.Loop() {
22
+
_, _ = f.Format(input)
23
+
}
24
+
}
25
+
26
+
func BenchmarkFormat_Large(b *testing.B) {
27
+
var sb strings.Builder
28
+
29
+
sb.WriteString("package main\n\n")
30
+
31
+
for i := range 100 {
32
+
sb.WriteString("func foo")
33
+
sb.WriteString(string(rune('A' + i%26)))
34
+
sb.WriteString("() {\n")
35
+
sb.WriteString("\tx := 1\n")
36
+
sb.WriteString("\tif x > 0 {\n")
37
+
sb.WriteString("\t\ty := 2\n")
38
+
sb.WriteString("\t}\n")
39
+
sb.WriteString("\tz := 3\n")
40
+
sb.WriteString("}\n\n")
41
+
}
42
+
43
+
input := []byte(sb.String())
44
+
f := &Formatter{CommentMode: CommentsFollow}
45
+
46
+
for b.Loop() {
47
+
_, _ = f.Format(input)
48
+
}
49
+
}
+424
formatter_test.go
+424
formatter_test.go
···
1
+
package main
2
+
3
+
import (
4
+
"testing"
5
+
)
6
+
7
+
func TestFormat_RemovesExtraBlankLines(t *testing.T) {
8
+
input := `package main
9
+
10
+
func main() {
11
+
x := 1
12
+
13
+
14
+
y := 2
15
+
}
16
+
`
17
+
expected := `package main
18
+
19
+
func main() {
20
+
x := 1
21
+
y := 2
22
+
}
23
+
`
24
+
f := &Formatter{CommentMode: CommentsFollow}
25
+
result, err := f.Format([]byte(input))
26
+
27
+
if err != nil {
28
+
t.Fatalf("Format error: %v", err)
29
+
}
30
+
31
+
if string(result) != expected {
32
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
33
+
}
34
+
}
35
+
36
+
func TestFormat_AddsBlankLineAroundScopedStatements(t *testing.T) {
37
+
input := `package main
38
+
39
+
func main() {
40
+
x := 1
41
+
if x > 0 {
42
+
y := 2
43
+
}
44
+
z := 3
45
+
}
46
+
`
47
+
expected := `package main
48
+
49
+
func main() {
50
+
x := 1
51
+
52
+
if x > 0 {
53
+
y := 2
54
+
}
55
+
56
+
z := 3
57
+
}
58
+
`
59
+
f := &Formatter{CommentMode: CommentsFollow}
60
+
result, err := f.Format([]byte(input))
61
+
62
+
if err != nil {
63
+
t.Fatalf("Format error: %v", err)
64
+
}
65
+
66
+
if string(result) != expected {
67
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
68
+
}
69
+
}
70
+
71
+
func TestFormat_NestedScopes(t *testing.T) {
72
+
input := `package main
73
+
74
+
func main() {
75
+
if true {
76
+
x := 1
77
+
if false {
78
+
y := 2
79
+
}
80
+
z := 3
81
+
}
82
+
}
83
+
`
84
+
expected := `package main
85
+
86
+
func main() {
87
+
if true {
88
+
x := 1
89
+
90
+
if false {
91
+
y := 2
92
+
}
93
+
94
+
z := 3
95
+
}
96
+
}
97
+
`
98
+
f := &Formatter{CommentMode: CommentsFollow}
99
+
result, err := f.Format([]byte(input))
100
+
101
+
if err != nil {
102
+
t.Fatalf("Format error: %v", err)
103
+
}
104
+
105
+
if string(result) != expected {
106
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
107
+
}
108
+
}
109
+
110
+
func TestFormat_ForLoop(t *testing.T) {
111
+
input := `package main
112
+
113
+
func main() {
114
+
x := 1
115
+
for i := 0; i < 10; i++ {
116
+
y := i
117
+
}
118
+
z := 2
119
+
}
120
+
`
121
+
expected := `package main
122
+
123
+
func main() {
124
+
x := 1
125
+
126
+
for i := 0; i < 10; i++ {
127
+
y := i
128
+
}
129
+
130
+
z := 2
131
+
}
132
+
`
133
+
f := &Formatter{CommentMode: CommentsFollow}
134
+
result, err := f.Format([]byte(input))
135
+
136
+
if err != nil {
137
+
t.Fatalf("Format error: %v", err)
138
+
}
139
+
140
+
if string(result) != expected {
141
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
142
+
}
143
+
}
144
+
145
+
func TestFormat_Switch(t *testing.T) {
146
+
input := `package main
147
+
148
+
func main() {
149
+
x := 1
150
+
switch x {
151
+
case 1:
152
+
y := 2
153
+
}
154
+
z := 3
155
+
}
156
+
`
157
+
expected := `package main
158
+
159
+
func main() {
160
+
x := 1
161
+
162
+
switch x {
163
+
case 1:
164
+
y := 2
165
+
}
166
+
167
+
z := 3
168
+
}
169
+
`
170
+
f := &Formatter{CommentMode: CommentsFollow}
171
+
result, err := f.Format([]byte(input))
172
+
173
+
if err != nil {
174
+
t.Fatalf("Format error: %v", err)
175
+
}
176
+
177
+
if string(result) != expected {
178
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
179
+
}
180
+
}
181
+
182
+
func TestFormat_MultipleFunctions(t *testing.T) {
183
+
input := `package main
184
+
185
+
func foo() {
186
+
x := 1
187
+
}
188
+
189
+
190
+
func bar() {
191
+
y := 2
192
+
}
193
+
`
194
+
expected := `package main
195
+
196
+
func foo() {
197
+
x := 1
198
+
}
199
+
200
+
func bar() {
201
+
y := 2
202
+
}
203
+
`
204
+
f := &Formatter{CommentMode: CommentsFollow}
205
+
result, err := f.Format([]byte(input))
206
+
207
+
if err != nil {
208
+
t.Fatalf("Format error: %v", err)
209
+
}
210
+
211
+
if string(result) != expected {
212
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
213
+
}
214
+
}
215
+
216
+
func TestFormat_TypeStruct(t *testing.T) {
217
+
input := `package main
218
+
219
+
type Foo struct {
220
+
X int
221
+
}
222
+
var x = 1
223
+
`
224
+
expected := `package main
225
+
226
+
type Foo struct {
227
+
X int
228
+
}
229
+
230
+
var x = 1
231
+
`
232
+
f := &Formatter{CommentMode: CommentsFollow}
233
+
result, err := f.Format([]byte(input))
234
+
235
+
if err != nil {
236
+
t.Fatalf("Format error: %v", err)
237
+
}
238
+
239
+
if string(result) != expected {
240
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
241
+
}
242
+
}
243
+
244
+
func TestFormat_DifferentStatementTypes(t *testing.T) {
245
+
input := `package main
246
+
247
+
func main() {
248
+
x := 1
249
+
y := 2
250
+
var a = 3
251
+
defer cleanup()
252
+
defer cleanup2()
253
+
go worker()
254
+
return
255
+
}
256
+
`
257
+
expected := `package main
258
+
259
+
func main() {
260
+
x := 1
261
+
y := 2
262
+
263
+
var a = 3
264
+
265
+
defer cleanup()
266
+
defer cleanup2()
267
+
268
+
go worker()
269
+
270
+
return
271
+
}
272
+
`
273
+
f := &Formatter{CommentMode: CommentsFollow}
274
+
result, err := f.Format([]byte(input))
275
+
276
+
if err != nil {
277
+
t.Fatalf("Format error: %v", err)
278
+
}
279
+
280
+
if string(result) != expected {
281
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
282
+
}
283
+
}
284
+
285
+
func TestFormat_ConsecutiveIfs(t *testing.T) {
286
+
input := `package main
287
+
288
+
func main() {
289
+
if err != nil {
290
+
return
291
+
}
292
+
if x > 0 {
293
+
y = 1
294
+
}
295
+
}
296
+
`
297
+
expected := `package main
298
+
299
+
func main() {
300
+
if err != nil {
301
+
return
302
+
}
303
+
304
+
if x > 0 {
305
+
y = 1
306
+
}
307
+
}
308
+
`
309
+
f := &Formatter{CommentMode: CommentsFollow}
310
+
result, err := f.Format([]byte(input))
311
+
312
+
if err != nil {
313
+
t.Fatalf("Format error: %v", err)
314
+
}
315
+
316
+
if string(result) != expected {
317
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
318
+
}
319
+
}
320
+
321
+
func TestFormat_CaseClauseStatements(t *testing.T) {
322
+
input := `package main
323
+
324
+
func main() {
325
+
switch x {
326
+
case 1:
327
+
foo()
328
+
if err != nil {
329
+
return
330
+
}
331
+
}
332
+
}
333
+
`
334
+
expected := `package main
335
+
336
+
func main() {
337
+
switch x {
338
+
case 1:
339
+
foo()
340
+
341
+
if err != nil {
342
+
return
343
+
}
344
+
}
345
+
}
346
+
`
347
+
f := &Formatter{CommentMode: CommentsFollow}
348
+
result, err := f.Format([]byte(input))
349
+
350
+
if err != nil {
351
+
t.Fatalf("Format error: %v", err)
352
+
}
353
+
354
+
if string(result) != expected {
355
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
356
+
}
357
+
}
358
+
359
+
func TestFormat_DeferWithInlineFunc(t *testing.T) {
360
+
input := `package main
361
+
362
+
func main() {
363
+
defer func() { _ = file.Close() }()
364
+
fileInfo, err := file.Stat()
365
+
}
366
+
`
367
+
expected := `package main
368
+
369
+
func main() {
370
+
defer func() { _ = file.Close() }()
371
+
372
+
fileInfo, err := file.Stat()
373
+
}
374
+
`
375
+
f := &Formatter{CommentMode: CommentsFollow}
376
+
result, err := f.Format([]byte(input))
377
+
378
+
if err != nil {
379
+
t.Fatalf("Format error: %v", err)
380
+
}
381
+
382
+
if string(result) != expected {
383
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
384
+
}
385
+
}
386
+
387
+
func TestFormat_CaseClauseConsecutiveAssignments(t *testing.T) {
388
+
input := `package main
389
+
390
+
func main() {
391
+
switch x {
392
+
case "user":
393
+
roleStyle = UserStyle
394
+
contentStyle = ContentStyle
395
+
prefix = "You"
396
+
case "assistant":
397
+
roleStyle = AssistantStyle
398
+
}
399
+
}
400
+
`
401
+
expected := `package main
402
+
403
+
func main() {
404
+
switch x {
405
+
case "user":
406
+
roleStyle = UserStyle
407
+
contentStyle = ContentStyle
408
+
prefix = "You"
409
+
case "assistant":
410
+
roleStyle = AssistantStyle
411
+
}
412
+
}
413
+
`
414
+
f := &Formatter{CommentMode: CommentsFollow}
415
+
result, err := f.Format([]byte(input))
416
+
417
+
if err != nil {
418
+
t.Fatalf("Format error: %v", err)
419
+
}
420
+
421
+
if string(result) != expected {
422
+
t.Errorf("got:\n%s\nwant:\n%s", result, expected)
423
+
}
424
+
}
+235
main.go
+235
main.go
···
1
+
package main
2
+
3
+
import (
4
+
"bytes"
5
+
"flag"
6
+
"fmt"
7
+
"io"
8
+
"os"
9
+
"path/filepath"
10
+
"runtime"
11
+
"strings"
12
+
"sync"
13
+
)
14
+
15
+
var version = "dev"
16
+
17
+
var (
18
+
writeFlag = flag.Bool("w", false, "write result to (source) file instead of stdout")
19
+
listFlag = flag.Bool("l", false, "list files whose formatting differs from iku's")
20
+
diffFlag = flag.Bool("d", false, "display diffs instead of rewriting files")
21
+
commentsFlag = flag.String("comments", "follow", "comment attachment mode: follow, precede, standalone")
22
+
versionFlag = flag.Bool("version", false, "print version")
23
+
)
24
+
25
+
func main() {
26
+
flag.Usage = func() {
27
+
fmt.Fprintf(os.Stderr, "usage: iku [flags] [path ...]\n")
28
+
flag.PrintDefaults()
29
+
}
30
+
31
+
flag.Parse()
32
+
33
+
if *versionFlag {
34
+
fmt.Println("iku", version)
35
+
os.Exit(0)
36
+
}
37
+
38
+
commentMode, err := parseCommentMode(*commentsFlag)
39
+
40
+
if err != nil {
41
+
fmt.Fprintf(os.Stderr, "iku: %v\n", err)
42
+
os.Exit(2)
43
+
}
44
+
45
+
formatter := &Formatter{CommentMode: commentMode}
46
+
47
+
if flag.NArg() == 0 {
48
+
if *writeFlag {
49
+
fmt.Fprintln(os.Stderr, "iku: cannot use -w with standard input")
50
+
os.Exit(2)
51
+
}
52
+
53
+
if err := processFile(formatter, "<stdin>", os.Stdin, os.Stdout, false); err != nil {
54
+
fmt.Fprintf(os.Stderr, "iku: %v\n", err)
55
+
os.Exit(1)
56
+
}
57
+
58
+
return
59
+
}
60
+
61
+
exitCode := 0
62
+
63
+
for _, path := range flag.Args() {
64
+
switch info, err := os.Stat(path); {
65
+
case err != nil:
66
+
fmt.Fprintf(os.Stderr, "iku: %v\n", err)
67
+
68
+
exitCode = 1
69
+
case info.IsDir():
70
+
if err := processDir(formatter, path, &exitCode); err != nil {
71
+
fmt.Fprintf(os.Stderr, "iku: %v\n", err)
72
+
73
+
exitCode = 1
74
+
}
75
+
default:
76
+
if err := processFilePath(formatter, path, &exitCode); err != nil {
77
+
fmt.Fprintf(os.Stderr, "iku: %v\n", err)
78
+
79
+
exitCode = 1
80
+
}
81
+
}
82
+
}
83
+
84
+
os.Exit(exitCode)
85
+
}
86
+
87
+
func parseCommentMode(mode string) (CommentMode, error) {
88
+
switch strings.ToLower(mode) {
89
+
case "follow":
90
+
return CommentsFollow, nil
91
+
case "precede":
92
+
return CommentsPrecede, nil
93
+
case "standalone":
94
+
return CommentsStandalone, nil
95
+
default:
96
+
return 0, fmt.Errorf("invalid comment mode: %q (use follow, precede, or standalone)", mode)
97
+
}
98
+
}
99
+
100
+
func processDir(formatter *Formatter, directory string, exitCode *int) error {
101
+
var files []string
102
+
103
+
err := filepath.Walk(directory, func(path string, info os.FileInfo, err error) error {
104
+
if err != nil {
105
+
return err
106
+
}
107
+
108
+
if !info.IsDir() && strings.HasSuffix(path, ".go") {
109
+
files = append(files, path)
110
+
}
111
+
112
+
return nil
113
+
})
114
+
115
+
if err != nil {
116
+
return err
117
+
}
118
+
119
+
var waitGroup sync.WaitGroup
120
+
var mutex sync.Mutex
121
+
122
+
semaphore := make(chan struct{}, runtime.NumCPU())
123
+
124
+
for _, path := range files {
125
+
waitGroup.Add(1)
126
+
127
+
go func(filePath string) {
128
+
defer waitGroup.Done()
129
+
130
+
semaphore <- struct{}{}
131
+
132
+
defer func() { <-semaphore }()
133
+
134
+
if err := processFilePath(formatter, filePath, exitCode); err != nil {
135
+
mutex.Lock()
136
+
fmt.Fprintf(os.Stderr, "iku: %v\n", err)
137
+
138
+
*exitCode = 1
139
+
140
+
mutex.Unlock()
141
+
}
142
+
}(path)
143
+
}
144
+
145
+
waitGroup.Wait()
146
+
147
+
return nil
148
+
}
149
+
150
+
func processFilePath(formatter *Formatter, path string, _ *int) error {
151
+
file, err := os.Open(path)
152
+
153
+
if err != nil {
154
+
return err
155
+
}
156
+
157
+
defer func() { _ = file.Close() }()
158
+
159
+
var output io.Writer = os.Stdout
160
+
161
+
if *writeFlag {
162
+
output = nil
163
+
}
164
+
165
+
return processFile(formatter, path, file, output, true)
166
+
}
167
+
168
+
func processFile(formatter *Formatter, filename string, input io.Reader, outputWriter io.Writer, isFile bool) error {
169
+
source, err := io.ReadAll(input)
170
+
171
+
if err != nil {
172
+
return fmt.Errorf("%s: %v", filename, err)
173
+
}
174
+
175
+
result, err := formatter.Format(source)
176
+
177
+
if err != nil {
178
+
return fmt.Errorf("%s: %v", filename, err)
179
+
}
180
+
181
+
if *listFlag {
182
+
if !bytes.Equal(source, result) {
183
+
fmt.Println(filename)
184
+
}
185
+
186
+
return nil
187
+
}
188
+
189
+
if *diffFlag {
190
+
if !bytes.Equal(source, result) {
191
+
difference := unifiedDiff(filename, source, result)
192
+
_, _ = os.Stdout.Write(difference)
193
+
}
194
+
195
+
return nil
196
+
}
197
+
198
+
if *writeFlag && isFile {
199
+
if !bytes.Equal(source, result) {
200
+
return os.WriteFile(filename, result, 0644)
201
+
}
202
+
203
+
return nil
204
+
}
205
+
206
+
if outputWriter != nil {
207
+
_, err = outputWriter.Write(result)
208
+
209
+
return err
210
+
}
211
+
212
+
return nil
213
+
}
214
+
215
+
func unifiedDiff(filename string, original, formatted []byte) []byte {
216
+
var buffer bytes.Buffer
217
+
218
+
fmt.Fprintf(&buffer, "--- %s\n", filename)
219
+
fmt.Fprintf(&buffer, "+++ %s\n", filename)
220
+
221
+
originalLines := strings.Split(string(original), "\n")
222
+
formattedLines := strings.Split(string(formatted), "\n")
223
+
224
+
fmt.Fprintf(&buffer, "@@ -1,%d +1,%d @@\n", len(originalLines), len(formattedLines))
225
+
226
+
for _, line := range originalLines {
227
+
fmt.Fprintf(&buffer, "-%s\n", line)
228
+
}
229
+
230
+
for _, line := range formattedLines {
231
+
fmt.Fprintf(&buffer, "+%s\n", line)
232
+
}
233
+
234
+
return buffer.Bytes()
235
+
}