-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathFormatter.sublime-settings
2621 lines (2582 loc) · 112 KB
/
Formatter.sublime-settings
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
// Enable debug mode to view errors in the console.
// Accepted values: true (verbose), false, OR "status" (recommended)
"debug": false,
// By default, all previous console messages will be cleared. (ST4088+ only)
// If you want to retain the console message history, set this to false.
"clear_console": true,
// Auto open the console panel whenever formatting fails.
// This is useful if "debug" is "status" or true
"open_console_on_failure": false,
// The counterpart for success.
"close_console_on_success": false,
// Timeout to abort subprocess in seconds.
// Default to 10 seconds. Set to false to disable the timeout.
"timeout": 10,
// Limit the total number of characters in the file.
// A max of 1 MB = 1024 * 1024 ≈ 1.048.576 chars seems reasonable.
// Accepted values: int OR false
"file_chars_limit": false,
// Integrate your custom modules into the Formatter ecosystem.
// Modules can be located either locally or remotely (with or without signing).
// This option must be of type string pointing to the JSON metata file path.
// More about the format of this file, see README.md > Integrating modules
"custom_modules_manifest": "",
// Display results in the status bar with the current settings mode info:
// PUS: Persistent User Settings
// PQO: Persistent Quick Options
// TQO: Temporary Quick Options
"show_statusbar": true,
// Display a real-time word and character count in the status bar.
// By default, whitespace is not included in the character count.
"show_words_count": {
"enable": true,
"use_short_label": false,
"ignore_whitespace_char": true
},
// Remember and restore cursor position, selections, bookmarks,
// and foldings each time a file is closed and re-opened.
// This is helpful to resume your work from where you left off.
// It does not remember any sublime sessions as name might suggest.
"remember_session": true,
// Configure the layout when opening new files.
// This only takes effect if the "new_file_on_format" option is true.
// Accepted values: "2cols", "2rows", "single" OR false
"layout": {
"enable": "2cols",
"sync_scroll": true
},
// A set of directories where executable programs are located.
// These can be absolute paths to module directories or Python zipfiles.
// Any environment variables like PATH, PYTHONPATH, GEM_PATH, GOPATH,
// GOROOT, GOBIN, TMPDIR, WHATEVER, etc. can be added here.
// This is similar to running 'export PYTHONPATH="/path/to/my/site-packages"'
// from the terminal. It is temporary, your system environment remains untouched.
// On Windows, you can use either escaped backslashes (e.g., "C:\\a\\b\\c") or
// forward slashes (e.g., "C:/a/b/c") as path separators for all other options.
// Tip: Activating "print_on_console" will help to set the correct environment.
"environ": {
"print_on_console": false,
"PATH": [],
"GEM_PATH": [],
"PYTHONPATH": [],
"OLALA": []
},
// This option resolves the syntax conflicts described in "format_on_save".
// It acts as an override and only applies to the following options:
// 1. "format_on_save"
// 2. "format_on_paste"
// Syntaxes in this option always take precedence over the syntaxes specified there.
// All syntaxes must be unique without any duplicates.
"format_on_priority": {
"enable": false,
"csscomb": ["css"],
"jsbeautifier": ["js"]
},
// This option enables auto-detect formatting for file.
// Configure it here and/or by using the dot files in your working folder.
// If both methods are used, the config from the dot files will override this embedded one.
// Advantage: The embedded one can handle both saved and unsaved files,
// while the dot files variant only applies to saved files, as unsaved files
// (puffer in view) never have a working dir to contain dot files.
//
// This option supports chaining multiple formatters in a single run.
// Chaining requires a list type with a maximum of 10 items in a list.
//
// By default, "format_on_save" and "format_on_paste" use a boolean value: false OR true
// But you can use the dictionary format to exclude dirs, files, extensions and syntaxes:
// "format_on_save": {
// "exclude_dirs_regex": [".*(\\.git|node_modules|__pycache__|env).*", ".*/project/test"],
// "exclude_files_regex": [".*test_file\\.py\\$", ".*/project/test/config\\.json"],
// "exclude_extensions_regex": ["ya?ml", "mjs", "json"],
// "exclude_syntaxes": []
// }
// Terminology: Hidden dot files, like .bashrc, do not have an extension to exclude.
// More about this feature, see README.md > Auto-detect Formatting
"auto_format": {
/*
"config": {
"format_on_save": false,
"format_on_paste": false
},
"python": ["isort", "black"],
"json": "jsbeautifier",
"php": {
"uid": "phpcsfixer"
},
"html": {
"uid": "jsbeautifier",
"exclude_syntaxes": {
"html": ["markdown"]
}
},
*/
},
// THIRD-PARTY PLUGINS LEVEL
// Info: Preferences > Package Settings > Formatter > Modules Info
"formatters": {
"examplemodule": {
// Plugin activation.
// By default, all plugins are disabled.
"enable": false,
// Auto formatting whenever the current file is being saved.
// This option should be used for plugins with unique syntaxes.
// For multi plugins with the same syntaxes, the first plugin takes precedence.
// Remove the identical syntaxes from one of the plugins to avoid conflicts.
// For example:
// Plugin A (enabled): syntaxes ["css", "js"]
// Plugin B (enabled): syntaxes ["html", "css"]
// In the case you want to use Plugin B with "css", then you should remove
// the "css" from plugin A or just disable it, as there is no guarantee of the
// execution order between the two, and determining your favorist is not possible.
// Solution: Use the "format_on_priority" option to workaround this.
//
// By default, this option uses a boolean value: false OR true
// To exclude dirs, files, extensions and syntaxes, use a dictionary format:
// "format_on_save": {
// "exclude_dirs_regex": [".*(\\.git|node_modules|__pycache__|env).*", ".*/project/test"],
// "exclude_files_regex": [".*test_file\\.py\\$", ".*/project/test/config\\.json"],
// "exclude_extensions_regex": ["ya?ml", "mjs", "json"],
// "exclude_syntaxes": []
// }
// Terminology: Hidden dot files, like .bashrc, do not have an extension to exclude.
"format_on_save": false,
// Auto formatting whenever code is pasted into the current file.
// This option works the same way as "format_on_save".
// So the mentioned syntax conflicts and solution are the same.
//
// Also you can use the same dictionary format to exclude:
// dirs, files, extensions, and syntaxes
"format_on_paste": false,
// Create a new file containing formatted code.
// The value of this option is the suffix of the new file being renamed.
// Suffix must be of type string. =true, =false means =false
// Note: It will overwrite any existing file that has the same new name in
// the same location.
// For example:
// "new_file_on_format": "min", will create a new file:
// myfile.raw.js -> myfile.raw.min.js
"new_file_on_format": false,
// Recursive directory formatting, regardless of depth.
// This option requires an existing and currently opened file
// to serve as the starting point.
// - For the sake of convenience, two new folders will be created at
// the same level as the file, which will contain all failed and
// successfully formatted files. Your original files remain unchanged.
// - The "new_file_on_format" option can be used to rename files
// at the same time if needed.
// - The "format_on_save" option above, which only works in the
// single-file mode, does not take effect here.
// - All none-text files (binary) will be automatically ignored.
// - To STOP the current formatting process, press any of the
// arrow keys (up, down, left, right) on your keyboard.
// Any literal "$" must be escaped to "\\$" to distinguish it from
// the variable expansion "${...}". This important rule applies
// to the entire content of this settings file!
//
// By default, this option uses a boolean value: false OR true
// To exclude dirs, files, extensions and syntaxes, use a dictionary format:
// "dir_format": {
// "exclude_dirs_regex": [".*(\\.git|node_modules|__pycache__|env).*", ".*/project/test"],
// "exclude_files_regex": [".*test_file\\.py\\$", ".*/project/test/config\\.json"],
// "exclude_extensions_regex": ["ya?ml", "mjs", "json"],
// "exclude_syntaxes': []
// }
"dir_format": false,
// Syntax support based on the scope name, not file extension.
// Syntax name is part of the scope name and can be retrieved from:
// Tools > Developer > Show Scope Name
// End-users are advised to consult plugin manpages to add more syntaxes.
// The wildcard syntax "*" will accept any syntax, regardless of syntax type.
"syntaxes": ["css", "html", "js", "php"],
// Exclude a list of syntaxes associated with an individual syntax key.
// The wildcard syntax "*" will accept any key, regardless of syntax type.
// This option is useful to exclude part of the scope selector.
// For example: text.html.markdown, want html but wish to filter out html.markdown.
"exclude_syntaxes": {
"html": ["markdown"],
"*": ["markdown"]
},
// Path to the interpreter.
// Omit this option will force Formatter to detect interpreter on PATH and
// automatically set them for you.
// Or you can set the basename as the interpreter name to search on PATH or
// locally, similar to how it is done with the "executable_path" option.
"interpreter_path": ["${HOME}/example/path/to\\$my/php.exe"],
// Path to the plugin executable.
// This option can be either a string or a list of executable paths.
// - If this option is omitted or set to null, then the global executable
// on PATH will be used, OR the local executable if automatically found.
// - If this option is exactly the basename, then it will be used as the
// executable name and searched for on the PATH.
// Basename can be with or without dot.extension as both variants are the same.
// For example: "fiLe.exe" (Windows only), "fiLe" (Windows + Unix + Linux)
// System variable expansions like ${HOME}, ${USER} etc. and the Sublime Text
// specific ${packages} can be used to assign paths.
// Note: Again, any literal "$" must be escaped to "\\$" to distinguish
// it from the variable expansion "${...}".
"executable_path": ["${HOME}/example/path/to\\$my/php-cs-fixer.phar"],
// Path to the config file for each individual syntaxes.
// Syntax keys must match those in the "syntaxes" option above.
// A single config file can be used for all syntaxes.
// In that case, the key must be named: "default"
// - You can choose another config file format as the default one
// provided by Formatter if supported by the third-party plugin.
// - Formatter provides a set of default config files under
// "formatter.assets/config" folder for getting start.
// Avoid using the reference files with the suffix '.master.'
// directly, as they may be overwritten by future updates.
// - Any auto-detected local config dotfile within the file
// tree always takes precedence over this option.
// To ignore the local config dotfile in favor of this option:
// 1. Set "ignore_dotfiles" to true, OR
// 2. Remove or rename the detected local config dotfile, OR
// 3. Use the Quick Options: Ignore Config Dotfiles, OR
// 4. Place an '.sublimeformatter.ignore.json' file inside
// the working root folder. The structure of this file is
// explained in README.md > Auto-detect Formatting
"config_path": {
"ignore_dotfiles": false,
"css": "${packages}/User/formatter.assets/config/only_css_rc.json",
"php": "${packages}/User/formatter.assets/config/only_php_rc.json",
"default": "${packages}/User/formatter.assets/config/css_plus_js_plus_php_rc.json"
},
// Array of additional arguments for the command line.
"args": ["--basedir", "./example/my/foo", "--show-bar", "yes"],
// This option is specifically designed for type graphic.
// It enables SVG image generation for saving.
// Enable it if you need SVG image at the cost of processing time.
// Unlike the generic method, this method only supports SVG generation.
"render_extended": false,
// Manipulate hardcoded command-line arguments.
// This option allow you to modify hardcoded parameters, values and
// their positions without digging into the source code.
// This feature is primarily intended to temporarily fix bugs until
// an official solution is implemented.
// Note: Hardcoded args can be changed (rarely) by any release updates.
// Enable debug mode will help to find all current hardcoded args.
// Use "args" option above to add, this option to remove or manipulate.
// Using regex: Again, any literal "$" must be escaped to "\\$" to
// distinguish it from the variable expansion "${...}". Accepted args:
// [search, [replace, [index, count, new position]]], where:
// - search: @type:str (regex)
// - replace: @type:str
// - index: @type:int (the number is known as a list index); required!
// - count: @type:int (the matching occurrences per index, 0 = all); required!
// - position: @type:int (move old index pos. to new/old one, -1 = delete index); required!
"fix_commands": [
["--autocorrect", "--autocorrect-all", 4, 0, 4], // no index pos change
["^.*?auto.*\\$", "--with", 4, 1, 5], // using escaped "\\$" regex, move index 4 to pos 5
["${packages}/to/old", "${packages}/to/new", 3, 0, 3], // variable expansion, no escaped "$"
["css", 5, 0, 7], // replace the value in index 5 with "css", move it to pos 7
[3, 0, 4], // just move index 3 to the new pos 4. (count 0 irrelevant)
[2, 0, -1], // just delete the index 2. (count 0 irrelevant)
["--show-bar", "xxx", 2, 0, -1] // enough bar, pop it out. ("xxx", 2, 0 irrelevant)
]
},
"examplegeneric": {
// Formatter provides 2 methods to add custom plugins:
// - Generic: this one, you design the bridge yourself. Suitable for simple tasks.
// - Modules: requires writing Python modules for complex tasks.
// Note: The Generic method requires a Sublime Text restart after adding or changing
// the "name" and "type" keys. Also, avoid reusing existing UID keys in JSON.
// The Capitalized plugin name, preferred in PascalCase style (REQUIRED!)
// This will appear in the Sublime menu and other commands.
"name": "ExampleGeneric",
// The plugin type (REQUIRED!)
// This will categorize the plugin. Accepted values:
// "beautifier", "minifier", "converter", "graphic", or any string of your choice.
"type": "beautifier",
// This will activate the "args_extended" option for the graphic type
// to generate extended files like SVG for saving.
"render_extended": false,
// The exit code for the third-party plugin (optional, default to 0).
"success_code": 0,
// Local config dotfiles supported by your plugin (optional).
// These files will be auto detected and used as config file within your project.
"dotfiles": [".pluginrc", "pyproject.toml", ".pycodestyle", "setup.cfg", "tox.ini", ".pep8", ".editorconfig"],
// Keywords to identify special local config dotfiles (optional).
// Special dotfiles: "pyproject.toml", ".pycodestyle", "setup.cfg", "tox.ini", ".pep8", ".editorconfig"
// contain specific sections, such as "[tool.autopep8]" for identification.
// This is only necessary if the uid, here "examplegeneric", differs from "autopep8".
"df_ident": ["juliet", "romeo", "autopep8"],
// Same as the one in the examplemodule.
"enable": false,
// Same as the one in the examplemodule.
"format_on_save": false,
// Same as the one in the examplemodule.
"format_on_paste": false,
// Same as the one in the examplemodule, but disabled/unused for type graphic.
"new_file_on_format": false,
// Same as the one in the examplemodule, but disabled/unused for type graphic.
"dir_format": false,
// Same as the one in the examplemodule.
"syntaxes": ["css", "html", "js", "php"],
// Same as the one in the examplemodule.
"exclude_syntaxes": {},
// Same as the one in the examplemodule.
"interpreter_path": ["${HOME}/example/path/to\\$my/php.exe"],
// Same as the one in the examplemodule.
"executable_path": ["${HOME}/example/path/to\\$my/php-cs-fixer.phar"],
// Same as the one in the examplemodule.
"config_path": {
"ignore_dotfiles": false,
"css": "${packages}/User/formatter.assets/config/only_css_rc.json",
"php": "${packages}/User/formatter.assets/config/only_php_rc.json",
"default": "${packages}/User/formatter.assets/config/css_plus_js_plus_php_rc.json"
},
// Main commands to trigger the formatting process.
// You can either set the qualified paths directly or use variable substitution for:
// - "interpreter_path" : "{{i}}"
// - "executable_path" : "{{e}}", "{{e=node}}" (for local executable auto-resolving with runtime type node)
// - "config_path" : "{{c}}"
// - SPECIAL CASE GRAPHIC : "{{o}}" (output PNG image, e.g: "args": [... "--output", "{{o}}"])
// Variable substitution provides advanced mechanisms such as auto-search path, auto-config, etc.
// SPECIAL CASE GRAPHIC requirements:
// 1. The plugin must support exporting PNG format.
// 2. The hardcoded "{{o}}" MUST ALWAYS be included in "args".
// You might regret using your own path instead of "{{o}}" or daring to omit "{{o}}" in this case.
// In all other cases, output may not be as a file; use "-" or "--" instead.
"args": ["{{i}}", "{{e=node}}", "--config", "{{c}}", "--basedir", "./example/my/foo", "--"],
// This is for the SPECIAL CASE GRAPHIC to saving extended graphic files.
// To use this, the trigger option "render_extended" above must be activated.
// Sublime Text only supports PNG, JPG, and GIF images. Formatter uses PNG to display
// image in view and generates the same image in various formats for you.
// WARNING: Formatter will loop subprocess to render extended files. This means, process
// will takes more time. This option might be useful for the final step to production.
// "key":["value",..], where key is the output file extension, value is the command arguments.
"args_extended": {
"svg": ["{{e}}", "--config", "{{c}}", "--blabla-format", "svgv5", "--output", "{{o}}"],
"pdf": ["{{e}}", "--config", "{{c}}", "--blabla-format", "pdf2001", "--output", "{{o}}"]
}
},
// -- END of explanation --
// -- BEAUTIFIERS --
"appleswiftformat": {
"info": "https://github.com/apple/swift-format",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["swift"],
"executable_path": ["/path/to/bin/swift-format"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/apple_swift_format_rc.json"
}
},
"asmfmt": {
"info": "https://github.com/klauspost/asmfmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["asm"],
"executable_path": ["/path/to/bin/asmfmt"]
/* Opinionated, no config. */
},
"astyle": {
"info": "https://sourceforge.net/projects/astyle",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["c", "c++", "cs", "objc", "objc++", "java", "js"],
"executable_path": ["/path/to/bin/astyle"],
"config_path": {
"ignore_dotfiles": false,
"java": "${packages}/User/formatter.assets/config/artistic_style_java_rc.ini",
"default": "${packages}/User/formatter.assets/config/artistic_style_astyle_rc.ini"
}
},
"autopep8": {
"info": "https://github.com/hhatto/autopep8",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["python"],
"executable_path": ["/path/to/bin/autopep8"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/autopep8_rc.cfg"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"beautysh": {
"info": "https://github.com/lovesegfault/beautysh",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["bash"],
"executable_path": ["/path/to/bin/beautysh"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/beautysh_rc.json"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"bibtextidy": {
"info": "https://github.com/FlamingTempura/bibtex-tidy",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["bibtex"],
"executable_path": ["/path/to/node_modules/.bin/bibtex-tidy(.cmd on windows)"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/bibtex_tidy_rc.yaml"
}
/* Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"biome": {
"info": "https://github.com/biomejs/biome",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["js", "jsx", "ts", "tsx", "json"],
"executable_path": ["/path/to/bin/biome (standalone binary) or /path/to/node_modules/.bin/biome(.cmd on windows)"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/biome_rc.json"
}
/* Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"black": {
"info": "https://github.com/psf/black",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["python"],
"executable_path": ["/path/to/bin/black"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/black_rc.toml"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"bladeformatter": {
"info": "https://github.com/shufo/blade-formatter",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["blade"],
"executable_path": ["/path/to/node_modules/.bin/blade-formatter(.cmd on windows)"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/bladeformatter_rc.json"
}
/* Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"cabalfmt": {
"info": "https://github.com/phadej/cabal-fmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["cabal"],
"executable_path": ["/path/to/.cabal/bin/cabal-fmt"],
"args": ["--tabular", "--indent", "4"]
/* Requires haskell. Use "args" instead of "config_path". */
},
"caddyfmt": {
"info": "https://github.com/caddyserver/caddy",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["Caddyfile"],
"executable_path": ["/path/to/bin/caddy"]
/* Opinionated, no config. */
},
"clangformat": {
"info": "https://clang.llvm.org/docs/ClangFormat.html",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["c", "cs", "c++", "objc", "objc++", "js", "tsx", "jsx", "json", "java", "proto", "protodevel", "td", "sv", "svh", "v", "vh", "glsl"],
"executable_path": ["/path/to/bin/clang-format"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/clang_format_llvm_rc.yaml"
}
/* Requires clang+llvm-14.0.0-rc1 or newer (clang-format >= 14.0.0). */
},
"cljfmt": {
"info": "https://github.com/weavejester/cljfmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["clojure"],
"interpreter_path": ["/path/to/bin/java.exe or /path/to/bin/lein"],
"executable_path": ["/path/to/bin/cljfmt"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/cljfmt_rc.edn"
}
/* Omit "interpreter_path" if "executable_path" is set to the standalone version of cljfmt. */
},
"cmakeformat": {
"info": "https://github.com/cheshirekow/cmake_format",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["cmake"],
"executable_path": ["/path/to/bin/cmake-format"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/cmakeformat_rc.py"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"crystal": {
"info": "https://github.com/crystal-lang/crystal",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["crystal"],
"executable_path": ["/path/to/bin/crystal"]
/* Opinionated, no config. */
},
"csscomb": {
"info": "https://github.com/csscomb/csscomb.js",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["css", "scss", "sass", "less"],
"executable_path": ["/path/to/node_modules/.bin/csscomb(.cmd on windows)"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/csscomb_rc.json"
}
/* Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"d2fmt": {
"info": "https://github.com/terrastruct/d2",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["d2"],
"executable_path": ["/path/to/bin/d2"]
/* Opinionated, no config. */
},
"dartformat": {
"info": "https://dart.dev/tools/dart-format",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["dart"],
"executable_path": ["/path/to/bin/dart"]
/* Opinionated, no config. */
},
"deno": {
"info": "https://github.com/denoland/deno",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["js", "jsx", "ts", "tsx", "json", "markdown", "ipynb"],
"executable_path": ["/path/to/bin/deno"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/deno_rc.json"
}
},
"dhallformat": {
"info": "https://github.com/dhall-lang/dhall-haskell",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["dhall"],
"executable_path": ["/path/to/bin/dhall"]
/* Opinionated, no config. */
},
"docformatter": {
"info": "https://github.com/PyCQA/docformatter",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["python"],
"executable_path": ["/path/to/bin/docformatter"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/docformatter_rc.toml"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"dockfmt": {
"info": "https://github.com/jessfraz/dockfmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["dockerfile"],
"executable_path": ["/path/to/bin/dockfmt"]
/* Opinionated, no config. */
},
"dprint": {
"info": "https://github.com/dprint/dprint",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["js", "jsx", "ts", "tsx", "json", "markdown", "toml"],
"executable_path": ["/path/to/bin/dprint"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/dprint_rc.json"
}
},
"efmt": {
"info": "https://github.com/sile/efmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["erlang"],
"executable_path": ["/path/to/bin/efmt (standalone bin)"]
/* Opinionated, no config. No rebar3 upstream support, use efmt standalone instead. Omit "interpreter_path" if efmt already on PATH. */
},
"elixirmix": {
"info": "https://github.com/elixir-lang/elixir",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["elixir"],
"executable_path": ["/path/to/elixir/bin/mix"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/elixirmix_rc.exs"
}
/* No "interpreter_path", instead use "environ": {"PATH": ["/path/to/erlang@22/bin:$PATH", "$PATH:/path/to/elixir/bin"]}. */
},
"elmformat": {
"info": "https://github.com/avh4/elm-format",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["elm"],
"executable_path": ["/path/to/bin/elm-format"]
/* Opinionated, no config. */
},
"erlfmt": {
"info": "https://github.com/WhatsApp/erlfmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["erlang"],
"executable_path": ["/path/to/erlfmt (standalone bin) or /path/to/rebar3"]
/* Opinionated, no config. */
},
"eslint": {
"info": "https://github.com/eslint/eslint",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["js"],
"executable_path": ["/path/to/node_modules/.bin/eslint(.cmd on windows)"],
"args": ["--resolve-plugins-relative-to", "/path/to/eslintv8/javascript/node_modules"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/eslint_rc.json_(v8)_or_eslint_config_rc.mjs_(v9)"
}
/* Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"eslintd": {
"info": "https://github.com/mantoni/eslint_d.js",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["js"],
"executable_path": ["/path/to/node_modules/.bin/eslint_d(.cmd on windows)"],
"args": ["--resolve-plugins-relative-to", "/path/to/eslintv8/javascript/node_modules"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/eslintd_rc.json_(v8)_or_eslintd_config_rc.mjs_(v9)"
}
/* Min. eslint_d 14.0.0 or higher. Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"floskell": {
"info": "https://github.com/ennocramer/floskell",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["haskell"],
"executable_path": ["/path/to/.cabal/bin/floskell"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/floskell_rc.json"
}
},
"formatr": {
"info": "https://github.com/yihui/formatR",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["r"],
"executable_path": ["/path/to/bin/R"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/formatr_rc.cfg"
}
},
"fourmolu": {
"info": "https://github.com/fourmolu/fourmolu",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["haskell"],
"executable_path": ["/path/to/bin/fourmolu"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/fourmolu_rc.yaml"
}
},
"fprettify": {
"info": "https://github.com/pseewald/fprettify",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["fortran"],
"executable_path": ["/path/to/bin/fprettify"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/fprettify_rc.cfg"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"gleam": {
"info": "https://github.com/gleam-lang/gleam",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["gleam"],
"executable_path": ["/path/to/bin/gleam"]
/* Opinionated, no config. */
},
"gofmt": {
"info": "https://pkg.go.dev/cmd/gofmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["go"],
"executable_path": ["/path/to/bin/gofmt"]
/* Opinionated, no config. */
},
"gofumpt": {
"info": "https://github.com/mvdan/gofumpt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["go"],
"executable_path": ["/path/to/bin/gofumpt"]
/* Opinionated, no config. */
},
"goimports": {
"info": "https://pkg.go.dev/golang.org/x/tools/cmd/goimports",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["go"],
"executable_path": ["/path/to/bin/goimports"]
/* Opinionated, no config. */
},
"googlejavaformat": {
"info": "https://github.com/google/google-java-format",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["java"],
"interpreter_path": ["/path/to/bin/java.exe"],
"executable_path": ["/path/to/bin/google-java-format-all-deps.jar"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/google_java_format_rc.yaml"
}
/* Omit "interpreter_path" if java already on PATH. */
},
"hclfmt": {
"info": "https://github.com/hashicorp/hcl",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["hcl"],
"executable_path": ["/path/to/go/bin/hclfmt"]
/* Opinionated, no config. */
},
"hindent": {
"info": "https://github.com/mihaimaruseac/hindent",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["haskell"],
"executable_path": ["/path/to/bin/hindent"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/hindent_rc.yaml"
}
},
"htmltidy": {
"info": "https://github.com/htacg/tidy-html5",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["html", "xml"],
"executable_path": ["/path/to/bin/tidy"],
"config_path": {
"ignore_dotfiles": false,
"html": "${packages}/User/formatter.assets/config/htmltidy_html_rc.cfg",
"xml": "${packages}/User/formatter.assets/config/htmltidy_xml_rc.cfg"
}
},
"isort": {
"info": "https://github.com/PyCQA/isort",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["python"],
"executable_path": ["/path/to/bin/isort"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/isort_rc.toml"
}
/* Requires "environ": {"PYTHONPATH": ["/lib/python3.7/site-packages"]}. Omit "interpreter_path" if python already on PATH. */
},
"jsbeautifier": {
"info": "https://github.com/beautify-web/js-beautify",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["js", "css", "html", "json", "tsx", "vue"],
"exclude_syntaxes": {
"html": ["markdown"]
},
"executable_path": ["/path/to/node_modules/.bin/js-beautify(.cmd on windows)"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/jsbeautify_rc.json"
}
/* Omit "interpreter_path" as files in /node_modules/.bin/ already point to node. */
},
"jsonmax": {
"info": "build-in",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["json"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/jsonmax_rc.json"
}
/* Build-in, no "executable_path". Standard JSON, not superset JSON5 with comments. */
},
"juliaformatter": {
"info": "https://github.com/domluna/JuliaFormatter.jl",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["julia"],
"interpreter_path": ["/path/to/bin/julia.exe"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/juliaformatter_rc.toml"
}
/* Install: julia> using Pkg; Pkg.add("JuliaFormatter"). No "executable_path". No "args". Omit "interpreter_path" if julia already on PATH. */
},
"ktlint": {
"info": "https://github.com/pinterest/ktlint",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["kotlin"],
"interpreter_path": ["/path/to/bin/java.exe"],
"executable_path": ["/path/to/bin/ktlint or path/to/ktlint.bat"]
/* Opinionated, no config. Omit "interpreter_path" if java already on PATH. */
},
"latexindent": {
"info": "https://github.com/cmhughes/latexindent.pl",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["tex", "latex"],
"executable_path": ["/path/to/latexindent or /path/to/latexindent.pl"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/latexindent_rc.yaml"
}
/* Omit "interpreter_path" if perl already on PATH. */
},
"luaformatter": {
"info": "https://github.com/Koihik/LuaFormatter",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,
"syntaxes": ["lua"],
"executable_path": ["/path/to/bin/lua-format"],
"config_path": {
"ignore_dotfiles": false,
"default": "${packages}/User/formatter.assets/config/luaformatter_rc.yaml"
}
},
"nasmfmt": {
"info": "https://github.com/yamnikov-oleg/nasmfmt",
"enable": false,
"format_on_save": false,
"format_on_paste": false,
"dir_format": false,