summaryrefslogtreecommitdiff
path: root/doc/ale.txt
blob: 38c1f35334d4db644dfd9ff6f1675ff1b88fa08b (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
*ale.txt*	Plugin to lint and fix files asynchronously
*ale*

ALE - Asynchronous Lint Engine

===============================================================================
CONTENTS                                                         *ale-contents*

  1. Introduction.........................|ale-introduction|
  2. Supported Languages & Tools..........|ale-support|
  3. Linting..............................|ale-lint|
    3.1 Adding Language Servers...........|ale-lint-language-servers|
    3.2 Other Sources.....................|ale-lint-other-sources|
  4. Fixing Problems......................|ale-fix|
  5. Language Server Protocol Support.....|ale-lsp|
    5.1 Completion........................|ale-completion|
    5.2 Go To Definition..................|ale-go-to-definition|
    5.3 Go To Type Definition.............|ale-go-to-type-definition|
    5.4 Find References...................|ale-find-references|
    5.5 Hovering..........................|ale-hover|
    5.6 Symbol Search.....................|ale-symbol-search|
  6. Global Options.......................|ale-options|
    6.1 Highlights........................|ale-highlights|
  7. Linter/Fixer Options.................|ale-integration-options|
    7.1 Options for alex..................|ale-alex-options|
    7.2 Options for languagetool..........|ale-languagetool-options|
    7.3 Options for write-good............|ale-write-good-options|
    7.4 Other Linter/Fixer Options........|ale-other-integration-options|
  8. Commands/Keybinds....................|ale-commands|
  9. API..................................|ale-api|
  10. Special Thanks......................|ale-special-thanks|
  11. Contact.............................|ale-contact|

===============================================================================
1. Introduction                                              *ale-introduction*

ALE provides the means to run linters asynchronously in Vim in a variety of
languages and tools. ALE sends the contents of buffers to linter programs
using the |job-control| features available in Vim 8 and NeoVim. For Vim 8,
Vim must be compiled with the |job| and |channel| and |timers| features
as a minimum.

ALE supports the following key features for linting:

1. Running linters when text is changed.
2. Running linters when files are opened.
3. Running linters when files are saved. (When a global flag is set.)
4. Populating the |loclist| with warning and errors.
5. Setting |signs| with warnings and errors for error markers.
6. Using |echo| to show error messages when the cursor moves.
7. Setting syntax highlights for errors.

ALE can fix problems with files with the |ALEFix| command, using the same job
control functionality used for checking for problems. Try using the
|ALEFixSuggest| command for browsing tools that can be used to fix problems
for the current buffer.

If you are interested in contributing to the development of ALE, read the
developer documentation. See |ale-development|

===============================================================================
2. Supported Languages & Tools                                    *ale-support*

ALE supports a wide variety of languages and tools. See |ale-supported-list|
for the full list.

===============================================================================
3. Linting                                                           *ale-lint*

ALE's primary focus is on checking for problems with your code with various
programs via some Vim code for integrating with those programs, referred to
as 'linters.' ALE supports a wide array of programs for linting by default,
but additional programs can be added easily by defining files in |runtimepath|
with the filename pattern `ale_linters/<filetype>/<filename>.vim`. For more
information on defining new linters, see the extensive documentation
for |ale#linter#Define()|.

Without any configuration, ALE will attempt to check all of the code for every
file you open in Vim with all available tools by default. To see what ALE
is doing, and what options have been set, try using the |:ALEInfo| command.

Most of the linters ALE runs will check the Vim buffer you are editing instead
of the file on disk. This allows you to check your code for errors before you
have even saved your changes. ALE will check your code in the following
circumstances, which can be configured with the associated options.

* When you modify a buffer.                - |g:ale_lint_on_text_changed|
* On leaving insert mode.                  - |g:ale_lint_on_insert_leave|
* When you open a new or modified buffer.  - |g:ale_lint_on_enter|
* When you save a buffer.                  - |g:ale_lint_on_save|
* When the filetype changes for a buffer.  - |g:ale_lint_on_filetype_changed|
* If ALE is used to check code manually.   - |:ALELint|

                                                 *ale-lint-settings-on-startup*

It is worth reading the documentation for every option. You should configure
which events ALE will use before ALE is loaded, so it can optimize which
autocmd commands to run. You can force autocmd commands to be reloaded with
`:ALEDisable | ALEEnable`

This also applies to the autocmd commands used for |g:ale_echo_cursor|.

                                                        *ale-lint-file-linters*

Some programs must be run against files which have been saved to disk, and
simply do not support reading temporary files or stdin, either of which are
required for ALE to be able to check for errors as you type. The programs
which behave this way are documented in the lists and tables of supported
programs. ALE will only lint files with these programs in the following
circumstances.

* When you open a new or modified buffer.  - |g:ale_lint_on_enter|
* When you save a buffer.                  - |g:ale_lint_on_save|
* When the filetype changes for a buffer.  - |g:ale_lint_on_filetype_changed|
* If ALE is used to check code manually.   - |:ALELint|

ALE will report problems with your code in the following ways, listed with
their relevant options.

* By updating loclist. (On by default)             - |g:ale_set_loclist|
* By updating quickfix. (Off by default)           - |g:ale_set_quickfix|
* By setting error highlights.                     - |g:ale_set_highlights|
* By creating signs in the sign column.            - |g:ale_set_signs|
* By echoing messages based on your cursor.        - |g:ale_echo_cursor|
* By inline text based on your cursor.             - |g:ale_virtualtext_cursor|
* By displaying the preview based on your cursor.  - |g:ale_cursor_detail|
* By showing balloons for your mouse cursor        - |g:ale_set_balloons|

Please consult the documentation for each option, which can reveal some other
ways of tweaking the behaviour of each way of displaying problems. You can
disable or enable whichever options you prefer.

Most settings can be configured for each buffer. (|b:| instead of |g:|),
including disabling ALE for certain buffers with |b:ale_enabled|. The
|g:ale_pattern_options| setting can be used to configure files differently
based on regular expressions for filenames. For configuring entire projects,
the buffer-local options can be used with external plugins for reading Vim
project configuration files. Buffer-local settings can also be used in
ftplugin files for different filetypes.

ALE offers several options for controlling which linters are run.

* Selecting linters to run.            - |g:ale_linters|
* Aliasing filetypes for linters       - |g:ale_linter_aliases|
* Only running linters you asked for.  - |g:ale_linters_explicit|
* Disabling only a subset of linters.  - |g:ale_linters_ignore|
* Disabling LSP linters and `tsserver`.  - |g:ale_disable_lsp|


-------------------------------------------------------------------------------
3.1 Adding Language Servers                         *ale-lint-language-servers*

ALE comes with many default configurations for language servers, so they can
be detected and run automatically. ALE can connect to other language servers
by defining a new linter for a filetype. New linters can be defined in |vimrc|,
in plugin files, or `ale_linters` directories in |runtimepath|.

See |ale-linter-loading-behavior| for more information on loading linters.

A minimal configuration for a language server linter might look so. >

  call ale#linter#Define('filetype_here', {
  \   'name': 'any_name_you_want',
  \   'lsp': 'stdio',
  \   'executable': '/path/to/executable',
  \   'command': '%e run',
  \   'project_root': '/path/to/root_of_project',
  \})
<
For language servers that use a TCP socket connection, you should define the
address to connect to instead. >

  call ale#linter#Define('filetype_here', {
  \   'name': 'any_name_you_want',
  \   'lsp': 'socket',
  \   'address': 'servername:1234',
  \   'project_root': '/path/to/root_of_project',
  \})
<
  Most of the options for a language server can be replaced with a |Funcref|
  for a function accepting a buffer number for dynamically computing values
  such as the executable path, the project path, the server address, etc,
  most of which can also be determined based on executing some other
  asynchronous task. See |ale#command#Run()| for computing linter options
  based on asynchronous results.

  See |ale#linter#Define()| for a detailed explanation of all of the options
  for configuring linters.


-------------------------------------------------------------------------------
3.2 Other Sources                                      *ale-lint-other-sources*

Problems for a buffer can be taken from other sources and rendered by ALE.
This allows ALE to be used in combination with other plugins which also want
to display any problems they might find with a buffer. ALE's API includes the
following components for making this possible.

* |ale#other_source#StartChecking()| - Tell ALE that a buffer is being checked.
* |ale#other_source#ShowResults()|   - Show results from another source.
* |ALEWantResults|                   - A signal for when ALE wants results.

Other resources can provide results for ALE to display at any time, following
ALE's loclist format. (See |ale-loclist-format|) For example: >

  " Tell ALE to show some results.
  " This function can be called at any time.
  call ale#other_source#ShowResults(bufnr(''), 'some-linter-name', [
  \ {'text': 'Something went wrong', 'lnum': 13},
  \])
<

Other sources should use a unique name for identifying themselves. A single
linter name can be used for all problems from another source, or a series of
unique linter names can be used. Results can be cleared for that source by
providing an empty List.

|ale#other_source#StartChecking()| should be called whenever another source
starts checking a buffer, so other tools can know that a buffer is being
checked by some plugin. The |ALEWantResults| autocmd event can be used to
start checking a buffer for problems every time that ALE does. When
|ALEWantResults| is signaled, |g:ale_want_results_buffer| will be set to the
number of the buffer that ALE wants to check.
|ale#other_source#StartChecking()| should be called synchronously, and other
sources should perform their checks on a buffer in the background
asynchronously, so they don't interrupt editing.

A plugin might integrate its own checks with ALE like so: >

  augroup SomeGroupName
    autocmd!
    autocmd User ALEWantResults call Hook(g:ale_want_results_buffer)
  augroup END

  function! DoBackgroundWork(buffer) abort
    " Start some work in the background here.
    " ...
    " Then call WorkDone(a:buffer, results)
  endfunction

  function! Hook(buffer) abort
    " Tell ALE we're going to check this buffer.
    call ale#other_source#StartChecking(a:buffer, 'some-name')
    call DoBackgroundWork(a:buffer)
  endfunction

  function! WorkDone(buffer, results) abort
    " Send results to ALE after they have been collected.
    call ale#other_source#ShowResults(buffer, 'some-name', a:results)
  endfunction
<

===============================================================================
4. Fixing Problems                                                    *ale-fix*

ALE can fix problems with files with the |ALEFix| command. |ALEFix|
accepts names of fixers to be applied as arguments. Alternatively,
when no arguments are provided, the variable |g:ale_fixers| will be
read for getting a |List| of commands for filetypes, split on `.`, and
the functions named in |g:ale_fixers| will be executed for fixing the
errors.

The |ALEFixSuggest| command can be used to suggest tools that be used to
fix problems for the current buffer.

The values for `g:ale_fixers` can be a list of |String|, |Funcref|, or
|lambda| values. String values must either name a function, or a short name
for a function set in the ALE fixer registry.

Each function for fixing errors must accept either one argument `(buffer)` or
two arguments `(buffer, lines)`, representing the buffer being fixed and the
lines to fix. The functions must return either `0`, for changing nothing, a
|List| for new lines to set, a |Dictionary| for describing a command to be
run in the background, or the result of |ale#command#Run()|.

Functions receiving a variable number of arguments will not receive the second
argument `lines`. Functions should name two arguments if the `lines` argument
is desired. This is required to avoid unnecessary copying of the lines of
the buffers being checked.

When a |Dictionary| is returned for an |ALEFix| callback, the following keys
are supported for running the commands.

  `command`             A |String| for the command to run. This key is required.

                      When `%t` is included in a command string, a temporary
                      file will be created, containing the lines from the file
                      after previous adjustment have been done.

  `read_temporary_file` When set to `1`, ALE will read the contents of the
                      temporary file created for `%t`. This option can be used
                      for commands which need to modify some file on disk in
                      order to fix files.

  `process_with`        An optional callback for post-processing.

                      The callback must accept two arguments,
                      `(buffer, output)`, which can be used for converting
                      the output from a command into lines to replace the
                      buffer's contents with.

                      A |List| of |String|s must be returned.

  `read_buffer`         An optional key for disabling reading the buffer.

                      When set to `0`, ALE will not pipe the buffer's data
                      into the command via stdin. This option is ignored and
                      the buffer is not read when `read_temporary_file` is
                      `1`.

                      This option defaults to `1`.

                                                        *ale-fix-configuration*

Synchronous functions and asynchronous jobs will be run in a sequence for
fixing files, and can be combined. For example:
>
  let g:ale_fixers = {
  \   'javascript': [
  \       'DoSomething',
  \       'eslint',
  \       {buffer, lines -> filter(lines, 'v:val !=~ ''^\s*//''')},
  \   ],
  \}

  ALEFix
<
The above example will call a function called `DoSomething` which could act
upon some lines immediately, then run `eslint` from the ALE registry, and
then call a lambda function which will remove every single line comment
from the file.

For buffer-local settings, such as in |g:ale_pattern_options| or in ftplugin
files, a |List| may be used for configuring the fixers instead.
>
  " Same as the above, only a List can be used instead of a Dictionary.
  let b:ale_fixers = [
  \   'DoSomething',
  \   'eslint',
  \   {buffer, lines -> filter(lines, 'v:val !=~ ''^\s*//''')},
  \]

  ALEFix
<
For convenience, a plug mapping is defined for |ALEFix|, so you can set up a
keybind easily for fixing files. >

  " Bind F8 to fixing problems with ALE
  nmap <F8> <Plug>(ale_fix)
<
Files can be fixed automatically with the following options, which are all off
by default.

|g:ale_fix_on_save| - Fix files when they are saved.

Fixers can be disabled on save with |g:ale_fix_on_save_ignore|. They will
still be run when you manually run |ALEFix|.


===============================================================================
5. Language Server Protocol Support                                   *ale-lsp*

ALE offers some support for integrating with Language Server Protocol (LSP)
servers. LSP linters can be used in combination with any other linter, and
will automatically connect to LSP servers when needed. ALE also supports
`tsserver` for TypeScript, which uses a different but very similar protocol.

If you want to use another plugin for LSP features and tsserver, you can use
the |g:ale_disable_lsp| setting to disable ALE's own LSP integrations, or
ignore particular linters with |g:ale_linters_ignore|.

-------------------------------------------------------------------------------
5.1 Completion                                                 *ale-completion*

ALE offers support for automatic completion of code while you type.
Completion is only supported while at least one LSP linter is enabled. ALE
will only suggest symbols provided by the LSP servers.

                                                     *ale-deoplete-integration*

ALE integrates with Deoplete for offering automatic completion data. ALE's
completion source for Deoplete is named `'ale'`, and should enabled
automatically if Deoplete is enabled and configured correctly. Deoplete
integration should not be combined with ALE's own implementation.

                                                 *ale-asyncomplete-integration*

ALE additionally integrates with asyncomplete.vim for offering automatic
completion data. ALE's asyncomplete source requires registration and should
use the defaults provided by the|asyncomplete#sources#ale#get_source_options| function >

  " Use ALE's function for asyncomplete defaults
  au User asyncomplete_setup call asyncomplete#register_source(asyncomplete#sources#ale#get_source_options({
      \ 'priority': 10, " Provide your own overrides here
      \ }))
>
ALE also offers its own completion implementation, which does not require any
other plugins. Suggestions will be made while you type after completion is
enabled. ALE's own completion implementation can be enabled by setting
|g:ale_completion_enabled| to `1`. This setting must be set to `1` before ALE
is loaded. The delay for completion can be configured with
|g:ale_completion_delay|. This setting should not be enabled if you wish to
use ALE as a completion source for other plugins.

ALE provides an 'omnifunc' function |ale#completion#OmniFunc| for triggering
completion manually with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| >

  " Use ALE's function for omnicompletion.
  set omnifunc=ale#completion#OmniFunc
<
ALE will only suggest so many possible matches for completion. The maximum
number of items can be controlled with |g:ale_completion_max_suggestions|.

If you don't like some of the suggestions you see, you can filter them out
with |g:ale_completion_excluded_words| or |b:ale_completion_excluded_words|.

The |ALEComplete| command can be used to show completion suggestions manually,
even when |g:ale_completion_enabled| is set to `0`. For manually requesting
completion information with Deoplete, consult Deoplete's documentation.

When working with TypeScript files, ALE by can support automatic imports
from external modules. This behavior can be enabled by setting the
|g:ale_completion_tsserver_autoimport| variable to `1`.

                                               *ale-completion-completeopt-bug*

ALE Automatic completion implementation replaces |completeopt| before opening
the omnicomplete menu with <C-x><C-o>. In some versions of Vim, the value set
for the option will not be respected. If you experience issues with Vim
automatically inserting text while you type, set the following option in
vimrc, and your issues should go away. >

  set completeopt=menu,menuone,preview,noselect,noinsert
<

Or alternatively, if you want to show documentation in popups: >

  set completeopt=menu,menuone,popup,noselect,noinsert
<
                                                                  *ale-symbols*

ALE provides a set of basic completion symbols. If you want to replace those
symbols with others, you can set the variable |g:ale_completion_symbols| with
a mapping of the type of completion to the symbol or other string that you
would like to use. An example here shows the available options for symbols  >

  let g:ale_completion_symbols = {
  \ 'text': '',
  \ 'method': '',
  \ 'function': '',
  \ 'constructor': '',
  \ 'field': '',
  \ 'variable': '',
  \ 'class': '',
  \ 'interface': '',
  \ 'module': '',
  \ 'property': '',
  \ 'unit': 'unit',
  \ 'value': 'val',
  \ 'enum': '',
  \ 'keyword': 'keyword',
  \ 'snippet': '',
  \ 'color': 'color',
  \ 'file': '',
  \ 'reference': 'ref',
  \ 'folder': '',
  \ 'enum member': '',
  \ 'constant': '',
  \ 'struct': '',
  \ 'event': 'event',
  \ 'operator': '',
  \ 'type_parameter': 'type param',
  \ '<default>': 'v'
  \ }
<
-------------------------------------------------------------------------------
5.2 Go To Definition                                     *ale-go-to-definition*

ALE supports jumping to the files and locations where symbols are defined
through any enabled LSP linters. The locations ALE will jump to depend on the
information returned by LSP servers. The |ALEGoToDefinition| command will jump
to the definition of symbols under the cursor. See the documentation for the
command for configuring how the location will be displayed.

ALE will update Vim's |tagstack| automatically unless |g:ale_update_tagstack| is
set to `0`.

-------------------------------------------------------------------------------
5.3 Go To Type Definition                           *ale-go-to-type-definition*

ALE supports jumping to the files and locations where symbols' types are
defined through any enabled LSP linters. The locations ALE will jump to depend
on the information returned by LSP servers. The |ALEGoToTypeDefinition|
command will jump to the definition of symbols under the cursor. See the
documentation for the command for configuring how the location will be
displayed.

-------------------------------------------------------------------------------
5.4 Find References                                       *ale-find-references*

ALE supports finding references for symbols though any enabled LSP linters.
ALE will display a preview window showing the places where a symbol is
referenced in a codebase when a command is run. The following commands are
supported:

|ALEFindReferences| - Find references for the word under the cursor.

Options:
  `-relative`       Show file paths in the results relative to the working dir

-------------------------------------------------------------------------------
5.5 Hovering                                                        *ale-hover*

ALE supports "hover" information for printing brief information about symbols
at the cursor taken from LSP linters. The following commands are supported:

|ALEHover| - Print information about the symbol at the cursor.

If |g:ale_set_balloons| is set to `1` and your version of Vim supports the
|balloon_show()| function, then "hover" information also show up when you move
the mouse over a symbol in a buffer. Diagnostic information will take priority
over hover information for balloons. If a line contains a problem, that
problem will be displayed in a balloon instead of hover information.

Hover information can be displayed in the preview window instead by setting
|g:ale_hover_to_preview| to `1`.

For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
|balloonexpr| commands in terminals can cause scrolling issues in terminals,
so ALE will not attempt to show balloons unless |g:ale_set_balloons| is set to
`1` before ALE is loaded.

For enabling mouse support in terminals, you may have to change your mouse
settings. For example: >

  " Example mouse settings.
  " You will need to try different settings, depending on your terminal.
  set mouse=a
  set ttymouse=xterm
<

Documentation for symbols at the cursor can be retrieved using the
|ALEDocumentation| command. This command is only available for `tsserver`.

-------------------------------------------------------------------------------
5.6 Symbol Search                                           *ale-symbol-search*

ALE supports searching for workspace symbols via LSP linters. The following
commands are supported:

|ALESymbolSearch| - Search for symbols in the workspace.

Options:
  `-relative`     Show file paths in the results relative to the working dir

===============================================================================
6. Global Options                                                 *ale-options*

g:airline#extensions#ale#enabled             *g:airline#extensions#ale#enabled*

  Type: |Number|
  Default: `1`

  Enables or disables the |airline|'s native extension for ale, which displays
  warnings and errors in the status line, prefixed by
  |airline#extensions#ale#error_symbol| and
  |airline#extensions#ale#warning_symbol|.


g:ale_cache_executable_check_failures   *g:ale_cache_executable_check_failures*

  Type: |Number|
  Default: undefined

  When set to `1`, ALE will cache failing executable checks for linters. By
  default, only executable checks which succeed will be cached.

  When this option is set to `1`, Vim will have to be restarted after new
  executables are installed for ALE to be able to run linters for those
  executables.


g:ale_change_sign_column_color                 *g:ale_change_sign_column_color*

  Type: |Number|
  Default: `0`

  When set to `1`, this option will set different highlights for the sign
  column itself when ALE reports problems with a file. This option can be
  combined with |g:ale_sign_column_always|.

  ALE uses the following highlight groups for highlighting the sign column:

  `ALESignColumnWithErrors`    -  Links to `error` by default.
  `ALESignColumnWithoutErrors` -  Uses the value for `SignColumn` by default.

  The sign column color can only be changed globally in Vim. The sign column
  might produce unexpected results if editing different files in split
  windows.


g:ale_close_preview_on_insert                   *g:ale_close_preview_on_insert*

  Type: |Number|
  Default: `0`

  When this option is set to `1`, ALE's |preview-window| will be automatically
  closed upon entering Insert Mode. This option can be used in combination
  with |g:ale_cursor_detail| for automatically displaying the preview window
  on problem lines, and automatically closing it again when editing text.

  This setting must be set to `1` before ALE is loaded for this behavior
  to be enabled. See |ale-lint-settings-on-startup|.


g:ale_command_wrapper                                   *g:ale_command_wrapper*
                                                        *b:ale_command_wrapper*
  Type: |String|
  Default: `''`

  An option for wrapping all commands that ALE runs, for linters, fixers,
  and LSP commands. This option can be set globally, or for specific buffers.

  This option can be used to apply nice to all commands. For example: >

    " Prefix all commands with nice.
    let g:ale_command_wrapper = 'nice -n5'
<
  Use the |ALEInfo| command to view the commands that are run. All of the
  arguments for commands will be put on the end of the wrapped command by
  default. A `%*` marker can be used to spread the arguments in the wrapped
  command. >

    " Has the same effect as the above.
    let g:ale_command_wrapper = 'nice -n5 %*'
<

  For passing all of the arguments for a command as one argument to a wrapper,
  `%@` can be used instead. >

    " Will result in say: /bin/bash -c 'other-wrapper -c "some command" -x'
    let g:ale_command_wrapper = 'other-wrapper -c %@ -x'
<
  For commands including `&&` or `;`, only the last command in the list will
  be passed to the wrapper. `&&` is most commonly used in ALE to change the
  working directory before running a command.


g:ale_completion_delay                                 *g:ale_completion_delay*

  Type: |Number|
  Default: `100`

  The number of milliseconds before ALE will send a request to a language
  server for completions after you have finished typing.

  See |ale-completion|


g:ale_completion_enabled                             *g:ale_completion_enabled*
                                                     *b:ale_completion_enabled*

  Type: |Number|
  Default: `0`

  When this option is set to `1`, completion support will be enabled.

  This setting must be set to `1` before ALE is loaded for this behavior
  to be enabled.

  This setting should not be enabled if you wish to use ALE as a completion
  source for other completion plugins.

  A buffer-local version of this setting `b:ale_completion_enabled` can be set
  to `0` to disable ALE's automatic completion support for a single buffer.
  ALE's completion support must be enabled globally to be enabled locally.

  See |ale-completion|


g:ale_completion_tsserver_autoimport     *g:ale_completion_tsserver_autoimport*

  Type: Number
  Default: `0`

  When this option is set to `0`, ALE will not try to automatically import
  completion results from external modules. It can be enabled by setting it
  to `1`.


g:ale_completion_excluded_words               *g:ale_completion_excluded_words*
                                              *b:ale_completion_excluded_words*
  Type: |List|
  Default: `[]`

  This option can be set to a list of |String| values for "words" to exclude
  from completion results, as in the words for |complete-items|. The strings
  will be matched exactly in a case-sensitive manner. (|==#|)

  This setting can be configured in ftplugin files with buffer variables, so
  that different lists can be used for different filetypes. For example: >

  " In ~/.vim/ftplugin/typescript.vim

  " Don't suggest `it` or `describe` so we can use snippets for those words.
  let b:ale_completion_excluded_words = ['it', 'describe']
<

g:ale_completion_symbols                             *g:ale_completion_symbols*

  Type: |Dictionary|


  A mapping from completion types to symbols for completions. See
  |ale-symbols| for more information.

  By default, this mapping only uses built in Vim completion kinds, but it can
  be updated to use any unicode character for the completion kind. For
  example: >
    let g:ale_completion_symbols = {
    \ 'text': '',
    \ 'method': '',
    \ 'function': '',
    \ 'constructor': '',
    \ 'field': '',
    \ 'variable': '',
    \ 'class': '',
    \ 'interface': '',
    \ 'module': '',
    \ 'property': '',
    \ 'unit': 'v',
    \ 'value': 'v',
    \ 'enum': 't',
    \ 'keyword': 'v',
    \ 'snippet': 'v',
    \ 'color': 'v',
    \ 'file': 'v',
    \ 'reference': 'v',
    \ 'folder': 'v',
    \ 'enum_member': 'm',
    \ 'constant': 'm',
    \ 'struct': 't',
    \ 'event': 'v',
    \ 'operator': 'f',
    \ 'type_parameter': 'p',
    \ '<default>': 'v'
    \ })
<

g:ale_completion_max_suggestions             *g:ale_completion_max_suggestions*

  Type: |Number|
  Default: `50`

  The maximum number of items ALE will suggest in completion menus for
  automatic completion.

  Setting this number higher will require more processing time, and may
  suggest too much noise. Setting this number lower will require less
  processing time, but some suggestions will not be included, so you might not
  be able to see the suggestions you want.

  Adjust this option as needed, depending on the complexity of your codebase
  and your available processing power.

g:ale_cursor_detail                                       *g:ale_cursor_detail*

  Type: |Number|
  Default: `0`

  When this option is set to `1`, ALE's |preview-window| will be automatically
  opened when the cursor moves onto lines with problems. ALE will search for
  problems using the same logic that |g:ale_echo_cursor| uses. The preview
  window will be closed automatically when you move away from the line.

  Messages are only displayed after a short delay. See |g:ale_echo_delay|.

  The preview window is opened without stealing focus, which means your cursor
  will stay in the same buffer as it currently is.

  The preview window can be closed automatically upon entering Insert mode
  by setting |g:ale_close_preview_on_insert| to `1`.

  Either this setting or |g:ale_echo_cursor| must be set to `1` before ALE is
  loaded for messages to be displayed. See |ale-lint-settings-on-startup|.


g:ale_default_navigation                             *g:ale_default_navigation*
                                                     *b:ale_default_navigation*

  Type: |String|
  Default: `'buffer'`

  The default method for navigating away from the current buffer to another
  buffer, such as for |ALEFindReferences:|, or |ALEGoToDefinition|.


g:ale_disable_lsp                                           *g:ale_disable_lsp*
                                                            *b:ale_disable_lsp*

  Type: |Number|
  Default: `0`

  When this option is set to `1`, ALE ignores all linters powered by LSP,
  and also `tsserver`.

  Please see also |ale-lsp|.


g:ale_echo_cursor                                           *g:ale_echo_cursor*

  Type: |Number|
  Default: `1`

  When this option is set to `1`, a truncated message will be echoed when a
  cursor is near a warning or error. ALE will attempt to find the warning or
  error at a column nearest to the cursor when the cursor is resting on a line
  which contains a warning or error. This option can be set to `0` to disable
  this behavior.

  Messages are only displayed after a short delay. See |g:ale_echo_delay|.

  The format of the message can be customized with |g:ale_echo_msg_format|.

  Either this setting or |g:ale_cursor_detail| must be set to `1` before ALE
  is loaded for messages to be displayed. See |ale-lint-settings-on-startup|.


g:ale_echo_delay                                             *g:ale_echo_delay*
                                                             *b:ale_echo_delay*
  Type: |Number|
  Default: `10`

  Given any integer, this option controls the number of milliseconds before
  ALE will echo or preview a message for a problem near the cursor.

  The value can be increased to decrease the amount of processing ALE will do
  for files displaying a large number of problems.


g:ale_echo_msg_error_str                             *g:ale_echo_msg_error_str*

  Type: |String|
  Default: `'Error'`

  The string used for `%severity%` for errors. See |g:ale_echo_msg_format|


g:ale_echo_msg_format                                   *g:ale_echo_msg_format*
                                                        *b:ale_echo_msg_format*

  Type: |String|
  Default: `'%code: %%s'`

  This variable defines a message format for echoed messages. The following
  sequences of characters will be replaced.

    `%s`           - replaced with the text for the problem
    `%...code...% `- replaced with the error code
    `%linter%`     - replaced with the name of the linter
    `%severity%`   - replaced with the severity of the problem

  The strings for `%severity%` can be configured with the following options.

    |g:ale_echo_msg_error_str|   - Defaults to `'Error'`
    |g:ale_echo_msg_info_str|    - Defaults to `'Info'`
    |g:ale_echo_msg_warning_str| - Defaults to `'Warning'`

  `%code%` is replaced with the error code, and replaced with an empty string
  when there is no error code. Any extra characters between the percent signs
  will be printed when an error code is present. For example, a message like
  `(error code): message` will be printed for `'%(code): %%s'` and simply the
  message will be printed when there is no code.

  |g:ale_echo_cursor| needs to be set to 1 for messages to be displayed.

  The echo message format can also be configured separately for each buffer,
  so different formats can be used for different languages. (Say in ftplugin
  files.)


g:ale_echo_msg_info_str                               *g:ale_echo_msg_info_str*

  Type: |String|
  Default: `'Info'`

  The string used for `%severity%` for info. See |g:ale_echo_msg_format|


g:ale_echo_msg_log_str                                 *g:ale_echo_msg_log_str*

  Type: |String|
  Default: `'Log'`

  The string used for `%severity%` for log, used only for handling LSP show
  message requests. See |g:ale_lsp_show_message_format|


g:ale_echo_msg_warning_str                         *g:ale_echo_msg_warning_str*

  Type: |String|
  Default: `'Warning'`

  The string used for `%severity%` for warnings. See |g:ale_echo_msg_format|


g:ale_enabled                                                   *g:ale_enabled*
                                                                *b:ale_enabled*

  Type: |Number|
  Default: `1`

  When set to `0`, this option will completely disable ALE, such that no
  error checking will be performed, etc. ALE can be toggled on and off with
  the |ALEToggle| command, which changes this option.

  ALE can be disabled in each buffer by setting `let b:ale_enabled = 0`
  Disabling ALE based on filename patterns can be accomplished by setting
  a regular expression for |g:ale_pattern_options|. For example: >

  " Disable linting for all minified JS files.
  let g:ale_pattern_options = {'\.min.js$': {'ale_enabled': 0}}
<

  See |g:ale_pattern_options| for more information on that option.


g:ale_exclude_highlights                             *g:ale_exclude_highlights*
                                                     *b:ale_exclude_highlights*

  Type: |List|
  Default: `[]`

  A list of regular expressions for matching against highlight messages to
  remove. For example: >

  " Do not highlight messages matching strings like these.
  let b:ale_exclude_highlights = ['line too long', 'foo.*bar']
<
  See also: |g:ale_set_highlights|


g:ale_fixers                                                     *g:ale_fixers*
                                                                 *b:ale_fixers*

  Type: |Dictionary|
  Default: `{}`

  A mapping from filetypes to |List| values for functions for fixing errors.
  See |ale-fix| for more information.

  This variable can be overridden with variables in each buffer.
  `b:ale_fixers` can be set to a |List| of callbacks instead, which can be
  more convenient.

  A special `'*'` key be used as a wildcard filetype for configuring fixers
  for every other type of file. For example: >

    " Fix Python files with 'bar'.
    " Don't fix 'html' files.
    " Fix everything else with 'foo'.
    let g:ale_fixers = {'python': ['bar'], 'html': [], '*': ['foo']}
<

g:ale_fix_on_save                                           *g:ale_fix_on_save*
                                                            *b:ale_fix_on_save*

  Type: |Number|
  Default: `0`

  When set to 1, ALE will fix files when they are saved.

  If |g:ale_lint_on_save| is set to 1, files will be checked with linters
  after files are fixed, only when the buffer is open, or re-opened. Changes
  to the file will be saved to the file on disk.

  Files will not be fixed on `:wq`, so you should check your code before
  closing a buffer.

  Fixing files can be disabled or enabled for individual buffers by setting
  `b:ale_fix_on_save` to `0` or `1`.

  Some fixers can be excluded from being run automatically when you save files
  with the |g:ale_fix_on_save_ignore| setting.


g:ale_fix_on_save_ignore                             *g:ale_fix_on_save_ignore*
                                                     *b:ale_fix_on_save_ignore*

  Type: |Dictionary| or |List|
  Default: `{}`

  Given a |Dictionary| mapping filetypes to |Lists| of fixers to ignore, or
  just a |List| of fixers to ignore, exclude those fixers from being run
  automatically when files are saved.

  You can disable some fixers in your ftplugin file: >

  " Disable fixers 'b' and 'c' when fixing on safe for this buffer.
  let b:ale_fix_on_save_ignore = ['b', 'c']
  " Alternatively, define ignore lists for different filetypes.
  let b:ale_fix_on_save_ignore = {'foo': ['b'], 'bar': ['c']}
<
  You can disable some fixers globally per filetype like so: >

  let g:ale_fixers = {'foo': ['a', 'b'], 'bar': ['c', 'd']}
  let g:ale_fix_on_save = 1
  " For filetype `foo.bar`, only fixers 'b' and 'd' will be run on save.
  let g:ale_fix_on_save_ignore = {'foo': ['a'], 'bar': ['c']}
  " Alternatively, disable these fixers on save for all filetypes.
  let g:ale_fix_on_save_ignore = ['a', 'c']
<
  You can ignore fixers based on matching |Funcref| values too: >

  let g:AddBar = {buffer, lines -> lines + ['bar']}
  let g:ale_fixers = {'foo': g:AddBar}
  " The lambda fixer will be ignored, as it will be found in the ignore list.
  let g:ale_fix_on_save_ignore = [g:AddBar]
<

g:ale_history_enabled                                   *g:ale_history_enabled*

  Type: |Number|
  Default: `1`

  When set to `1`, ALE will remember the last few commands which were run
  for every buffer which is open. This information can be viewed with the
  |ALEInfo| command. The size of the buffer can be controlled with the
  |g:ale_max_buffer_history_size| option.

  This option can be disabled if storing a command history is not desired.


g:ale_history_log_output                             *g:ale_history_log_output*

  Type: |Number|
  Default: `1`

  When set to `1`, ALE will store the output of commands which have completed
  successfully in the command history, and the output will be displayed when
  using |ALEInfo|.

  |g:ale_history_enabled| must be set to `1` for this output to be stored or
  printed.

  Some memory will be consumed by this option. It is very useful for figuring
  out what went wrong with linters, and for bug reports. Turn this option off
  if you want to save on some memory usage.


g:ale_hover_to_preview                                 *g:ale_hover_to_preview*
                                                       *b:ale_hover_to_preview*

  Type: |Number|
  Default: `0`

  If set to `1`, hover messages will be displayed in the preview window,
  instead of in balloons or the message line.


g:ale_keep_list_window_open                       *g:ale_keep_list_window_open*
                                                  *b:ale_keep_list_window_open*
  Type: |Number|
  Default: `0`

  When set to `1`, this option will keep the loclist or quickfix windows event
  after all warnings/errors have been removed for files. By default the
  loclist or quickfix windows will be closed automatically when there are no
  warnings or errors.

  See |g:ale_open_list|


g:ale_list_window_size                                 *g:ale_list_window_size*
                                                       *b:ale_list_window_size*
  Type: |Number|
  Default: `10`

  This number configures the number of lines to set for the height of windows
  opened automatically for ALE problems. The default of `10` matches the Vim
  default height.

  See |g:ale_open_list| for information on automatically opening windows
  for quickfix or the loclist.


g:ale_lint_delay                                             *g:ale_lint_delay*

  Type: |Number|
  Default: `200`

  This variable controls the milliseconds delay after which the linters will
  be run after text is changed. This option is only meaningful with the
  |g:ale_lint_on_text_changed| variable set to `always`, `insert`, or `normal`.


g:ale_lint_on_enter                                       *g:ale_lint_on_enter*

  Type: |Number|
  Default: `1`

  When this option is set to `1`, the |BufWinEnter| event will be used to
  apply linters when buffers are first opened. If this is not desired, this
  variable can be set to `0` in your vimrc file to disable this behavior.

  The |FileChangedShellPost| and |BufEnter| events will be used to check if
  files have been changed outside of Vim. If a file is changed outside of
  Vim, it will be checked when it is next opened.

  You should set this setting once before ALE is loaded, and restart Vim if
  you want to change your preferences. See |ale-lint-settings-on-startup|.


g:ale_lint_on_filetype_changed                 *g:ale_lint_on_filetype_changed*

  Type: |Number|
  Default: `1`

  This option will cause ALE to run when the filetype for a file is changed
  after a buffer has first been loaded. A short delay will be used before
  linting will be done, so the filetype can be changed quickly several times
  in a row, but resulting in only one lint cycle.

  You should set this setting once before ALE is loaded, and restart Vim if
  you want to change your preferences. See |ale-lint-settings-on-startup|.


g:ale_lint_on_save                                         *g:ale_lint_on_save*

  Type: |Number|
  Default: `1`

  This option will make ALE run the linters whenever a file is saved when it
  it set to `1` in your vimrc file. This option can be used in combination
  with the |g:ale_lint_on_enter| and |g:ale_lint_on_text_changed| options to
  make ALE only check files after that have been saved, if that is what is
  desired.


g:ale_lint_on_text_changed                         *g:ale_lint_on_text_changed*

  Type: |String|
  Default: `'normal'`

  This option controls how ALE will check your files as you make changes.
  The following values can be used.

  `'always'`, `'1'`, or `1` - Check buffers on |TextChanged| or |TextChangedI|.
  `'normal'`            - Check buffers only on |TextChanged|.
  `'insert'`            - Check buffers only on |TextChangedI|.
  `'never'`, `'0'`, or `0`  - Never check buffers on changes.

  ALE will check buffers after a short delay, with a timer which resets on
  each change. The delay can be configured by adjusting the |g:ale_lint_delay|
  variable.
                                               *ale-linting-interrupts-mapping*

  Due to a bug in Vim, ALE can interrupt mappings with pending key presses,
  per |timeoutlen|. If this happens, follow the advice for enabling
  |g:ale_lint_on_insert_leave| below, and set this option to `'normal'`, or
  disable it entirely.

  You should set this setting once before ALE is loaded, and restart Vim if
  you want to change your preferences. See |ale-lint-settings-on-startup|.


g:ale_lint_on_insert_leave                         *g:ale_lint_on_insert_leave*
                                                   *b:ale_lint_on_insert_leave*

  Type: |Number|
  Default: `1`

  When set to `1` in your vimrc file, this option will cause ALE to run
  linters when you leave insert mode.

  ALE will not lint files when you escape insert mode with |CTRL-C| by
  default. You can make ALE lint files with this option when you use |CTRL-C|
  with the following mapping. >

    " Make using Ctrl+C do the same as Escape, to trigger autocmd commands
    inoremap <C-c> <Esc>
<
  A buffer-local version of this setting `b:ale_lint_on_insert_leave` can be
  set to `0` to disable linting when leaving insert mode. The setting must
  be enabled globally to be enabled locally.

  You should set this setting once before ALE is loaded, and restart Vim if
  you want to change your preferences. See |ale-lint-settings-on-startup|.


g:ale_linter_aliases                                     *g:ale_linter_aliases*
                                                         *b:ale_linter_aliases*
  Type: |Dictionary|
  Default: `{}`

  The |g:ale_linter_aliases| option can be used to set aliases from one
  filetype to another. A given filetype can be mapped to use the linters
  run for another given filetype.

  This |Dictionary| will be merged with a default dictionary containing the
  following values: >

  {
  \   'Dockerfile': 'dockerfile',
  \   'csh': 'sh',
  \   'javascriptreact': ['javascript', 'jsx'],
  \   'plaintex': 'tex',
  \   'rmarkdown': 'r',
  \   'rmd': 'r',
  \   'systemverilog': 'verilog',
  \   'typescriptreact': ['typescript', 'tsx'],
  \   'verilog_systemverilog': ['verilog_systemverilog', 'verilog'],
  \   'vimwiki': 'markdown',
  \   'vue': ['vue', 'javascript'],
  \   'xsd': ['xsd', 'xml'],
  \   'xslt': ['xslt', 'xml'],
  \   'zsh': 'sh',
  \}
<
  For example, if you wish to map a new filetype `'foobar'` to run the `'php'`
  linters, you could set the following: >

  let g:ale_linter_aliases = {'foobar': 'php'}
<
  When combined with the |g:ale_linters| option, the original filetype
  (`'foobar'`) will be used for determining which linters to run,
  not the aliased type (`'php'`). This allows an aliased type to run a
  different set of linters from the type it is being mapped to.

  Passing a list of filetypes is also supported. Say you want to lint
  javascript and css embedded in HTML (using linters that support that).
  You could alias `html` like so:

  `let g:ale_linter_aliases = {'html': ['html', 'javascript', 'css']}`

  Note that `html` itself was included as an alias. That is because aliases
  will override the original linters for the aliased filetype.

  Linter aliases can be configured in each buffer with buffer-local variables.
  ALE will first look for aliases for filetypes in the `b:ale_linter_aliases`
  variable, then `g:ale_linter_aliases`, and then a default Dictionary.

  `b:ale_linter_aliases` can be set to a |List| or a |String|, to tell ALE to
  load the linters for specific filetypes for a given buffer. >

  let b:ale_linter_aliases = ['html', 'javascript', 'css']
  " OR, Alias a filetype to only a single filetype with a String.
  let b:ale_linter_aliases = 'javascript'
<
  No linters will be loaded when the buffer's filetype is empty.

g:ale_linters                                                   *g:ale_linters*
                                                                *b:ale_linters*
  Type: |Dictionary|
  Default: `{}`

  The |g:ale_linters| option sets a |Dictionary| mapping a filetype to a
  |List| of linter programs to be run when checking particular filetypes.

  This |Dictionary| will be merged with a default dictionary containing the
  following values: >

  {
  \   'csh': ['shell'],
  \   'elixir': ['credo', 'dialyxir', 'dogma'],
  \   'go': ['gofmt', 'golint', 'go vet'],
  \   'hack': ['hack'],
  \   'help': [],
  \   'perl': ['perlcritic'],
  \   'perl6': [],
  \   'python': ['flake8', 'mypy', 'pylint'],
  \   'rust': ['cargo'],
  \   'spec': [],
  \   'text': [],
  \   'vue': ['eslint', 'vls'],
  \   'zsh': ['shell'],
  \}
<
  This option can be used to enable only a particular set of linters for a
  file. For example, you can enable only `eslint` for JavaScript files: >

  let g:ale_linters = {'javascript': ['eslint']}
<
  If you want to disable all linters for a particular filetype, you can pass
  an empty list of linters as the value: >

  let g:ale_linters = {'javascript': []}
<
  All linters will be run for unspecified filetypes. All available linters can
  be enabled explicitly for a given filetype by passing the string `'all'`,
  instead of a List. >

  let g:ale_linters = {'c': 'all'}
<
  Linters can be configured in each buffer with buffer-local variables. ALE
  will first look for linters for filetypes in the `b:ale_linters` variable,
  then `g:ale_linters`, and then the default Dictionary mentioned above.

  `b:ale_linters` can be set to a List, or the string `'all'`. When linters
  for two different filetypes share the same name, the first linter loaded
  will be used. Any ambiguity can be resolved by using a Dictionary specifying
  which linter to run for which filetype instead. >

  " Use ESLint for the buffer if the filetype includes 'javascript'.
  let b:ale_linters = {'javascript': ['eslint'], 'html': ['tidy']}
  " Use a List for the same setting. This will work in most cases.
  let b:ale_linters = ['eslint', 'tidy']
  " Disable all linters for the buffer.
  let b:ale_linters = []
  " Explicitly enable all available linters for the filetype.
  let b:ale_linters = 'all'
<
  ALE can be configured to disable all linters unless otherwise specified with
  `g:ale_enabled` or `b:ale_enabled` with the option |g:ale_linters_explicit|.


g:ale_linters_explicit                                 *g:ale_linters_explicit*

  Type: |Number|
  Default: `0`

  When set to `1`, only the linters from |g:ale_linters| and |b:ale_linters|
  will be enabled. The default behavior for ALE is to enable as many linters
  as possible, unless otherwise specified.


g:ale_linters_ignore                                     *g:ale_linters_ignore*
                                                         *b:ale_linters_ignore*

  Type: |Dictionary| or |List|
  Default: `{}`

  Linters to ignore. Commands for ignored linters will not be run, and
  diagnostics for LSP linters will be ignored. (See |ale-lsp|)

  This setting can be set to a |Dictionary| mapping filetypes to linter names,
  just like |g:ale_linters|, to list linters to ignore. Ignore lists will be
  applied after everything else. >

  " Select flake8 and pylint, and ignore pylint, so only flake8 is run.
  let g:ale_linters = {'python': ['flake8', 'pylint']}
  let g:ale_linters_ignore = {'python': ['pylint']}
<
  This setting can be set to simply a |List| of linter names, which is
  especially more convenient when using the setting in ftplugin files for
  particular buffers. >

  " The same as above, in a ftplugin/python.vim.
  let b:ale_linters = ['flake8', 'pylint']
  let b:ale_linters_ignore = ['pylint']
<

g:ale_list_vertical                                       *g:ale_list_vertical*
                                                          *b:ale_list_vertical*
  Type: |Number|
  Default: `0`

  When set to `1`, this will cause ALE to open any windows (loclist or
  quickfix) vertically instead of horizontally (|vert| |lopen|) or (|vert|
  |copen|)


g:ale_loclist_msg_format                             *g:ale_loclist_msg_format*
                                                     *b:ale_loclist_msg_format*

  Type: |String|
  Default: `g:ale_echo_msg_format`

  This option is the same as |g:ale_echo_msg_format|, but for formatting the
  message used for the loclist and the quickfix list.

  The strings for configuring `%severity%` are also used for this option.


g:ale_lsp_show_message_format                   *g:ale_lsp_show_message_format*

  Type: |String|
  Default: `'%severity%:%linter%: %s'`

  This variable defines the format that messages received from an LSP will
  have when echoed. The following sequences of characters will be replaced.

    `%s`           - replaced with the message text
    `%linter%`     - replaced with the name of the linter
    `%severity%`   - replaced with the severity of the message

  The strings for `%severity%` levels "error", "info" and "warning" are shared
  with |g:ale_echo_msg_format|. Severity "log" is unique to
  |g:ale_lsp_show_message_format| and it can be configured via

    |g:ale_echo_msg_log_str|     - Defaults to `'Log'`

  Please note that |g:ale_lsp_show_message_format| *can not* be configured
  separately for each buffer like |g:ale_echo_msg_format| can.


g:ale_lsp_show_message_severity               *g:ale_lsp_show_message_severity*

  Type: |String|
  Default: `'error'`

  This variable defines the minimum severity level an LSP message needs to be
  displayed. Messages below this level are discarded; please note that
  messages with `Log` severity level are always discarded.

  Possible values follow the LSP spec `MessageType` definition:

  `'error'`       - Displays only errors.
  `'warning'`     - Displays errors and warnings.
  `'information'` - Displays errors, warnings and infos
  `'log'`         - Same as `'information'`
  `'disabled'`    - Doesn't display any information at all.


g:ale_lsp_root                                                 *g:ale_lsp_root*
                                                               *b:ale_lsp_root*

  Type: |Dictionary| or |String|
  Default: {}

  This option is used to determine the project root for the LSP linter. If the
  value is a |Dictionary|, it maps a linter to either a string containing the
  project root or a |Funcref| to call to look up the root. The funcref is
  provided the buffer number as its argument.

  The buffer-specific variable may additionally be a string containing the
  project root itself.

  If neither variable yields a result, a linter-specific function is invoked to
  detect a project root. If this, too, yields no result, the linter is disabled.

g:ale_max_buffer_history_size                   *g:ale_max_buffer_history_size*

  Type: |Number|
  Default: `20`

  This setting controls the maximum number of commands which will be stored in
  the command history used for |ALEInfo|. Command history will be rotated in
  a FIFO manner. If set to a number <= 0, then the history will be
  continuously set to an empty |List|.

  History can be disabled completely with |g:ale_history_enabled|.


g:ale_max_signs                                               *g:ale_max_signs*
                                                              *b:ale_max_signs*
  Type: |Number|
  Default: `-1`

  When set to any positive integer, ALE will not render any more than the
  given number of signs for any one buffer.

  When set to `0`, no signs will be set, but sign processing will still be
  done, so existing signs can be removed.

  When set to any other value, no limit will be imposed on the number of signs
  set.

  For disabling sign processing, see |g:ale_set_signs|.


g:ale_maximum_file_size                               *g:ale_maximum_file_size*
                                                      *b:ale_maximum_file_size*
  Type: |Number|
  Default: undefined

  A maximum file size in bytes for ALE to check. If set to any positive
  number, ALE will skip checking files larger than the given size.


g:ale_open_list                                               *g:ale_open_list*
                                                              *b:ale_open_list*
  Type: |Number| or |String|
  Default: `0`

  When set to `1`, this will cause ALE to automatically open a window for the
  loclist (|lopen|) or for the quickfix list instead if |g:ale_set_quickfix|
  is `1`. (|copen|)

  When set to `'on_save'`, ALE will only open the loclist after buffers have
  been saved. The list will be opened some time after buffers are saved and
  any linter for a buffer returns results.

  The window will be kept open until all warnings or errors are cleared,
  including those not set by ALE, unless |g:ale_keep_list_window_open| is set
  to `1`, in which case the window will be kept open when no problems are
  found.

  The window size can be configured with |g:ale_list_window_size|.

  Windows can be opened vertically with |g:ale_list_vertical|.

  If you want to close the loclist window automatically when the buffer is
  closed, you can set up the following |autocmd| command: >

  augroup CloseLoclistWindowGroup
    autocmd!
    autocmd QuitPre * if empty(&buftype) | lclose | endif
  augroup END
<

g:ale_pattern_options                                   *g:ale_pattern_options*

  Type: |Dictionary|
  Default: undefined

  This option maps regular expression patterns to |Dictionary| values for
  buffer variables. This option can be set to automatically configure
  different settings for different files. For example: >

  " Use just ESLint for linting and fixing files which end in '.foo.js'
  let g:ale_pattern_options = {
  \   '\.foo\.js$': {
  \       'ale_linters': ['eslint'],
  \       'ale_fixers': ['eslint'],
  \   },
  \}
<
  See |b:ale_linters| and |b:ale_fixers| for information for those options.

  Filenames are matched with |match()|, and patterns depend on the |magic|
  setting, unless prefixed with the special escape sequences like `'\v'`, etc.
  The patterns can match any part of a filename. The absolute path of the
  filename will be used for matching, taken from `expand('%:p')`.

  The options for every match for the filename will be applied, with the
  pattern keys sorted in alphabetical order. Options for `'zebra'` will
  override the options for `'alpha'` for a filename `alpha-zebra`.


g:ale_pattern_options_enabled                   *g:ale_pattern_options_enabled*

  Type: |Number|
  Default: undefined

  This option can be used for disabling pattern options. If set to `0`, ALE
  will not set buffer variables per |g:ale_pattern_options|.


g:ale_rename_tsserver_find_in_comments *g:ale_rename_tsserver_find_in_comments*

  Type: |Number|
  Default: `0`

  If enabled, this option will tell tsserver to find and replace text in
  comments when calling |ALERename|. It can be enabled by settings the value
  to `1`.


g:ale_rename_tsserver_find_in_strings   *g:ale_rename_tsserver_find_in_strings*


  Type: |Number|
  Default: `0`

  If enabled, this option will tell tsserver to find and replace text in
  strings when calling |ALERename|. It can be enabled by settings the value to
  `1`.


g:ale_set_balloons                                         *g:ale_set_balloons*
                                                           *b:ale_set_balloons*

  Type: |Number|
  Default: `has('balloon_eval') && has('gui_running')`

  When this option is set to `1`, balloon messages will be displayed for
  problems or hover information if available.

  Problems nearest to the line the mouse cursor is over will be displayed. If
  there are no problems to show, and one of the linters is an LSP linter
  supporting "Hover" information, per |ale-hover|, then brief information
  about the symbol under the cursor will be displayed in a balloon.

  Balloons can be enabled for terminal versions of Vim that support balloons,
  but some versions of Vim will produce strange mouse behavior when balloons
  are enabled. To configure balloons for your terminal, you should first
  configure your |ttymouse| setting, and then consider setting
  `g:ale_set_balloons` to `1` before ALE is loaded.

  `b:ale_set_balloons` can be set to `0` to disable balloons for a buffer.
  Balloons cannot be enabled for a specific buffer when not initially enabled
  globally.

  Balloons will not be shown when |g:ale_enabled| or |b:ale_enabled| is `0`.


g:ale_set_balloons_legacy_echo                 *g:ale_set_balloons_legacy_echo*
                                               *b:ale_set_balloons_legacy_echo*
  Type: |Number|
  Default: undefined

  If set to `1`, moving your mouse over documents in Vim will make ALE ask
  `tsserver` or `LSP` servers for information about the symbol where the mouse
  cursor is, and print that information into Vim's echo line. This is an
  option for supporting older versions of Vim which do not properly support
  balloons in an asynchronous manner.

  If your version of Vim supports the |balloon_show| function, then this
  option does nothing meaningful.


g:ale_set_highlights                                     *g:ale_set_highlights*

  Type: |Number|
  Default: `has('syntax')`

  When this option is set to `1`, highlights will be set for problems.

  ALE will use the following highlight groups for problems:

  |ALEError|        - Items with `'type': 'E'`
  |ALEWarning|      - Items with `'type': 'W'`
  |ALEInfo.|        - Items with `'type': 'I'`
  |ALEStyleError|   - Items with `'type': 'E'` and `'sub_type': 'style'`
  |ALEStyleWarning| - Items with `'type': 'W'` and `'sub_type': 'style'`

  When |g:ale_set_signs| is set to `0`, the following highlights for entire
  lines will be set.

  |ALEErrorLine|   - All items with `'type': 'E'`
  |ALEWarningLine| - All items with `'type': 'W'`
  |ALEInfoLine|    - All items with `'type': 'I'`

  Vim can only highlight the characters up to the last column in a buffer for
  match highlights, whereas the line highlights when signs are enabled will
  run to the edge of the screen.

  Highlights can be excluded with the |g:ale_exclude_highlights| option.


g:ale_set_loclist                                           *g:ale_set_loclist*

  Type: |Number|
  Default: `1`

  When this option is set to `1`, the |loclist| will be populated with any
  warnings and errors which are found by ALE. This feature can be used to
  implement jumping between errors through typical use of |lnext| and |lprev|.


g:ale_set_quickfix                                         *g:ale_set_quickfix*

  Type: |Number|
  Default: `0`

  When this option is set to `1`, the |quickfix| list will be populated with
  any problems which are found by ALE, instead of the |loclist|. The loclist
  will never be populated when this option is on.

  Problems from every buffer ALE has checked will be included in the quickfix
  list, which can be checked with |:copen|. Problems will be de-duplicated.

  This feature should not be used in combination with tools for searching for
  matches and commands like |:cfdo|, as ALE will replace the quickfix list
  pretty frequently. If you wish to use such tools, you should populate the
  loclist instead.


g:ale_set_signs                                               *g:ale_set_signs*

  Type: |Number|
  Default: `has('signs')`

  When this option is set to `1`, the |sign| column will be populated with
  signs marking where problems appear in the file.

  ALE will use the following highlight groups for problems:

  |ALEErrorSign|        - Items with `'type': 'E'`
  |ALEWarningSign|      - Items with `'type': 'W'`
  |ALEInfoSign|         - Items with `'type': 'I'`
  |ALEStyleErrorSign|   - Items with `'type': 'E'` and `'sub_type': 'style'`
  |ALEStyleWarningSign| - Items with `'type': 'W'` and `'sub_type': 'style'`

  In addition to the style of the signs, the style of lines where signs appear
  can be configured with the following highlights:

  |ALEErrorLine|   - All items with `'type': 'E'`
  |ALEWarningLine| - All items with `'type': 'W'`
  |ALEInfoLine|    - All items with `'type': 'I'`

  With Neovim 0.3.2 or higher, ALE can use the `numhl` option to highlight the
  'number' column. It uses the following highlight groups.

  |ALEErrorSignLineNr|        - Items with `'type': 'E'`
  |ALEWarningSignLineNr|      - Items with `'type': 'W'`
  |ALEInfoSignLineNr|         - Items with `'type': 'I'`
  |ALEStyleErrorSignLineNr|   - Items with `'type': 'E'` and `'sub_type': 'style'`
  |ALEStyleWarningSignLineNr| - Items with `'type': 'W'` and `'sub_type': 'style'`

  To enable line number highlighting |g:ale_sign_highlight_linenrs| must be
  set to `1` before ALE is loaded.

  The markers for the highlights can be customized with the following options:

  |g:ale_sign_error|
  |g:ale_sign_warning|
  |g:ale_sign_info|
  |g:ale_sign_style_error|
  |g:ale_sign_style_warning|

  When multiple problems exist on the same line, the signs will take
  precedence in the order above, from highest to lowest.

  To limit the number of signs ALE will set, see |g:ale_max_signs|.


g:ale_sign_priority                                       *g:ale_sign_priority*

  Type: |Number|
  Default: `30`

  From Neovim 0.4.0 and Vim 8.1, ALE can set sign priority to all signs. The
  larger this value is, the higher priority ALE signs have over other plugin
  signs. See |sign-priority| for further details on how priority works.


g:ale_shell                                                       *g:ale_shell*

  Type: |String|
  Default: not set

  Override the shell used by ALE for executing commands. ALE uses 'shell' by
  default, but falls back in `/bin/sh` if the default shell looks like `fish`
  or `pwsh`, which are not compatible with all of the commands run by ALE. The
  shell specified with this option will be used even if it might not work in
  all cases.

  For Windows, ALE uses `cmd` when this option isn't set. Setting this option
  will apply shell escaping to the command string, even on Windows.

  NOTE: Consider setting |g:ale_shell_arguments| if this option is defined.


g:ale_shell_arguments                                   *g:ale_shell_arguments*

  Type: |String|
  Default: not set

  This option specifies the arguments to use for executing a command with a
  custom shell, per |g:ale_shell|. If this option is not set, 'shellcmdflag'
  will be used instead.


g:ale_sign_column_always                             *g:ale_sign_column_always*

  Type: |Number|
  Default: `0`

  By default, the sign gutter will disappear when all warnings and errors have
  been fixed for a file. When this option is set to `1`, the sign column will
  remain open. This can be preferable if you don't want the text in your file
  to move around as you edit a file.


g:ale_sign_error                                             *g:ale_sign_error*

  Type: |String|
  Default: `'>>'`

  The sign for errors in the sign gutter.


g:ale_sign_info                                               *g:ale_sign_info*

  Type: |String|
  Default: `g:ale_sign_warning`

  The sign for "info" markers in the sign gutter.


g:ale_sign_style_error                                 *g:ale_sign_style_error*

  Type: |String|
  Default: `g:ale_sign_error`

  The sign for style errors in the sign gutter.


g:ale_sign_style_warning                             *g:ale_sign_style_warning*

  Type: |String|
  Default: `g:ale_sign_warning`

  The sign for style warnings in the sign gutter.


g:ale_sign_offset                                           *g:ale_sign_offset*

  Type: |Number|
  Default: `1000000`

  This variable controls offset from which numeric IDs will be generated for
  new signs. Signs cannot share the same ID values, so when two Vim plugins
  set signs at the same time, the IDs have to be configured such that they do
  not conflict with one another. If the IDs used by ALE are found to conflict
  with some other plugin, this offset value can be changed, and hopefully both
  plugins will work together. See |sign-place| for more information on how
  signs are set.


g:ale_sign_warning                                         *g:ale_sign_warning*

  Type: |String|
  Default: `'--'`

  The sign for warnings in the sign gutter.


g:ale_sign_highlight_linenrs                     *g:ale_sign_highlight_linenrs*

  Type: |Number|
  Default: `0`

  When set to `1`, this option enables highlighting problems on the 'number'
  column in Vim versions that support `numhl` highlights. This option must be
  configured before ALE is loaded.


g:ale_update_tagstack                                   *g:ale_update_tagstack*
                                                        *b:ale_update_tagstack*
 Type: |Number|
 Default: `1`

 This option can be set to disable updating Vim's |tagstack| automatically.


g:ale_type_map                                                 *g:ale_type_map*
                                                               *b:ale_type_map*
  Type: |Dictionary|
  Default: `{}`

  This option can be set re-map problem types for linters. Each key in the
  |Dictionary| should be the name of a linter, and each value must be a
  |Dictionary| mapping problem types from one type to another. The following
  types are supported:

  `'E'`  - `{'type': 'E'}`
  `'ES'` - `{'type': 'E', 'sub_type': 'style'}`
  `'W'`  - `{'type': 'W'}`
  `'WS'` - `{'type': 'W', 'sub_type': 'style'}`
  `'I'`  - `{'type': 'I'}`

  For example, if you want to turn flake8 errors into warnings, you can write
  the following: >

  let g:ale_type_map = {'flake8': {'ES': 'WS', 'E': 'W'}}
<
  If you wanted to turn style errors and warnings into regular errors and
  warnings, you can write the following: >

  let g:ale_type_map = {'flake8': {'ES': 'E', 'WS': 'W'}}
<
  Type maps can be set per-buffer with `b:ale_type_map`.


g:ale_use_global_executables                     *g:ale_use_global_executables*

  Type: |Number|
  Default: not set

  This option can be set to change the default for all `_use_global` options.
  This option must be set before ALE is loaded, preferably in a vimrc file.

  See |ale-integrations-local-executables| for more information on those
  options.


g:ale_virtualtext_cursor                             *g:ale_virtualtext_cursor*

  Type: |Number|
  Default: `0`

  This option only has any effect in NeoVim.

  When this option is set to `1`, a message will be shown when a cursor is
  near a warning or error. ALE will attempt to find the warning or error at a
  column nearest to the cursor when the cursor is resting on a line which
  contains a warning or error. This option can be set to `0` to disable this
  behavior.

  Messages are only displayed after a short delay. See |g:ale_virtualtext_delay|.

  Messages can be prefixed prefixed with a string. See |g:ale_virtualtext_prefix|.

  ALE will use the following highlight groups for problems:

  |ALEVirtualTextError|        - Items with `'type': 'E'`
  |ALEVirtualTextWarning|      - Items with `'type': 'W'`
  |ALEVirtualTextInfo|         - Items with `'type': 'I'`
  |ALEVirtualTextStyleError|   - Items with `'type': 'E'` and `'sub_type': 'style'`
  |ALEVirtualTextStyleWarning| - Items with `'type': 'W'` and `'sub_type': 'style'`


g:ale_virtualtext_delay                               *g:ale_virtualtext_delay*
                                                      *b:ale_virtualtext_delay*

  Type: |Number|
  Default: `10`

  Given any integer, this option controls the number of milliseconds before
  ALE will show a message for a problem near the cursor.

  The value can be increased to decrease the amount of processing ALE will do
  for files displaying a large number of problems.


g:ale_virtualtext_prefix                             *g:ale_virtualtext_prefix*

  Type: |String|
  Default: `'> '`

  Prefix to be used with |g:ale_virtualtext_cursor|.

g:ale_virtualenv_dir_names                         *g:ale_virtualenv_dir_names*
                                                   *b:ale_virtualenv_dir_names*

  Type: |List|
  Default: `['.env', '.venv', 'env', 've-py3', 've', 'virtualenv', 'venv']`

  A list of directory names to be used when searching upwards from Python
  files to discover virtulenv directories with.

  For directory named `'foo'`, ALE will search for `'foo/bin/activate'`
  (`foo\Scripts\activate\` on Windows) in all directories on and above the
  directory containing the Python file to find virtualenv paths.


g:ale_warn_about_trailing_blank_lines   *g:ale_warn_about_trailing_blank_lines*
                                        *b:ale_warn_about_trailing_blank_lines*

  Type: |Number|
  Default: `1`

  When this option is set to `1`, warnings about trailing blank lines will be
  shown.

  This option behaves similarly to |g:ale_warn_about_trailing_whitespace|.


g:ale_warn_about_trailing_whitespace     *g:ale_warn_about_trailing_whitespace*
                                         *b:ale_warn_about_trailing_whitespace*

  Type: |Number|
  Default: `1`

  When this option is set to `1`, warnings relating to trailing whitespace on
  lines will be shown. If warnings are too irritating while editing buffers,
  and you have configured Vim to automatically remove trailing whitespace,
  you can disable these warnings by setting this option to `0`.

  Not all linters may respect this option. If a linter does not, please file a
  bug report, and it may be possible to add such support.

  This option may be configured on a per buffer basis.


g:ale_windows_node_executable_path         *g:ale_windows_node_executable_path*
                                           *b:ale_windows_node_executable_path*

  Type: |String|
  Default: `'node.exe'`

  This variable is used as the path to the executable to use for executing
  scripts with Node.js on Windows.

  For Windows, any file with a `.js` file extension needs to be executed with
  the node executable explicitly. Otherwise, Windows could try and open the
  scripts with other applications, like a text editor. Therefore, these
  scripts are executed with whatever executable is configured with this
  setting.


-------------------------------------------------------------------------------
6.1. Highlights                                                *ale-highlights*

ALEError                                                             *ALEError*

  Default: `highlight link ALEError SpellBad`

  The highlight for highlighted errors. See |g:ale_set_highlights|.


ALEErrorLine                                                     *ALEErrorLine*

  Default: Undefined

  The highlight for an entire line where errors appear. Only the first
  line for a problem will be highlighted.

  See |g:ale_set_signs| and |g:ale_set_highlights|.


ALEErrorSign                                                     *ALEErrorSign*

  Default: `highlight link ALEErrorSign error`

  The highlight for error signs. See |g:ale_set_signs|.


ALEErrorSignLineNr                                         *ALEErrorSignLineNr*

  Default: `highlight link ALEErrorSignLineNr CursorLineNr`

  The highlight for error signs. See |g:ale_set_signs|.

  NOTE: This highlight is only available on Neovim 0.3.2 or higher.


ALEInfo                                                              *ALEInfo.*
                                                            *ALEInfo-highlight*
  Default: `highlight link ALEInfo ALEWarning`

  The highlight for highlighted info messages. See |g:ale_set_highlights|.


ALEInfoSign                                                       *ALEInfoSign*

  Default: `highlight link ALEInfoSign ALEWarningSign`

  The highlight for info message signs. See |g:ale_set_signs|.


ALEInfoLine                                                       *ALEInfoLine*

  Default: Undefined

  The highlight for entire lines where info messages appear. Only the first
  line for a problem will be highlighted.

  See |g:ale_set_signs| and |g:ale_set_highlights|.


ALEInfoSignLineNr                                           *ALEInfoSignLineNr*

  Default: `highlight link ALEInfoSignLineNr CursorLineNr`

  The highlight for error signs. See |g:ale_set_signs|.

  NOTE: This highlight is only available on Neovim 0.3.2 or higher.


ALEStyleError                                                   *ALEStyleError*

  Default: `highlight link ALEStyleError ALEError`

  The highlight for highlighted style errors. See |g:ale_set_highlights|.


ALEStyleErrorSign                                           *ALEStyleErrorSign*

  Default: `highlight link ALEStyleErrorSign ALEErrorSign`

  The highlight for style error signs. See |g:ale_set_signs|.


ALEStyleErrorSignLineNr                               *ALEStyleErrorSignLineNr*

  Default: `highlight link ALEStyleErrorSignLineNr CursorLineNr`

  The highlight for error signs. See |g:ale_set_signs|.

  NOTE: This highlight is only available on Neovim 0.3.2 or higher.


ALEStyleWarning                                               *ALEStyleWarning*

  Default: `highlight link ALEStyleWarning ALEError`

  The highlight for highlighted style warnings. See |g:ale_set_highlights|.


ALEStyleWarningSign                                       *ALEStyleWarningSign*

  Default: `highlight link ALEStyleWarningSign ALEWarningSign`

  The highlight for style warning signs. See |g:ale_set_signs|.


ALEStyleWarningSignLineNr                           *ALEStyleWarningSignLineNr*

  Default: `highlight link ALEStyleWarningSignLineNr CursorLineNr`

  The highlight for error signs. See |g:ale_set_signs|.

  NOTE: This highlight is only available on Neovim 0.3.2 or higher.


ALEVirtualTextError                                       *ALEVirtualTextError*

  Default: `highlight link ALEVirtualTextError ALEError`

  The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|.


ALEVirtualTextInfo                                         *ALEVirtualTextInfo*

  Default: `highlight link ALEVirtualTextInfo ALEVirtualTextWarning`

  The highlight for virtualtext info. See |g:ale_virtualtext_cursor|.


ALEVirtualTextStyleError                             *ALEVirtualTextStyleError*

  Default: `highlight link ALEVirtualTextStyleError ALEVirtualTextError`

  The highlight for virtualtext style errors. See |g:ale_virtualtext_cursor|.


ALEVirtualTextStyleWarning                         *ALEVirtualTextStyleWarning*

  Default: `highlight link ALEVirtualTextStyleWarning ALEVirtualTextWarning`

  The highlight for virtualtext style warnings. See |g:ale_virtualtext_cursor|.


ALEVirtualTextWarning                                   *ALEVirtualTextWarning*

  Default: `highlight link ALEVirtualTextWarning ALEWarning`

  The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|.


ALEWarning                                                         *ALEWarning*

  Default: `highlight link ALEWarning SpellCap`

  The highlight for highlighted warnings. See |g:ale_set_highlights|.


ALEWarningLine                                                 *ALEWarningLine*

  Default: Undefined

  The highlight for entire lines where warnings appear. Only the first line
  for a problem will be highlighted.

  See |g:ale_set_signs| and |g:ale_set_highlights|.


ALEWarningSign                                                 *ALEWarningSign*

  Default: `highlight link ALEWarningSign todo`

  The highlight for warning signs. See |g:ale_set_signs|.


ALEWarningSignLineNr                                     *ALEWarningSignLineNr*

  Default: `highlight link ALEWarningSignLineNr CursorLineNr`

  The highlight for error signs. See |g:ale_set_signs|.

  NOTE: This highlight is only available on Neovim 0.3.2 or higher.


===============================================================================
7. Linter/Fixer Options                               *ale-integration-options*

Linter and fixer options are documented below and in individual help files.

Every option for programs can be set globally, or individually for each
buffer. For example, `b:ale_python_flake8_executable` will override any
values set for `g:ale_python_flake8_executable`.

                                           *ale-integrations-local-executables*

Some tools will prefer to search for locally-installed executables, unless
configured otherwise. For example, the `eslint` linter will search for
various executable paths in `node_modules`. The `flake8` linter will search
for virtualenv directories.

If you prefer to use global executables for those tools, set the relevant
`_use_global` and `_executable` options for those linters. >

  " Use the global executable with a special name for eslint.
  let g:ale_javascript_eslint_executable = 'special-eslint'
  let g:ale_javascript_eslint_use_global = 1

  " Use the global executable with a special name for flake8.
  let g:ale_python_flake8_executable = '/foo/bar/flake8'
  let g:ale_python_flake8_use_global = 1
<
|g:ale_use_global_executables| can be set to `1` in your vimrc file to make
ALE use global executables for all linters by default.

The option |g:ale_virtualenv_dir_names| controls the local virtualenv paths
ALE will use to search for Python executables.


-------------------------------------------------------------------------------
7.1. Options for alex                                        *ale-alex-options*

The options for `alex` are shared between all filetypes, so options can be
configured once.

g:ale_alex_executable                                   *g:ale_alex_executable*
                                                        *b:ale_alex_executable*
  Type: |String|
  Default: `'alex'`

  See |ale-integrations-local-executables|


g:ale_alex_use_global                                   *g:ale_alex_use_global*
                                                        *b:ale_alex_use_global*
  Type: |Number|
  Default: `get(g:, 'ale_use_global_executables', 0)`

  See |ale-integrations-local-executables|


-------------------------------------------------------------------------------
7.2. Options for languagetool                        *ale-languagetool-options*

g:ale_languagetool_executable                   *g:ale_languagetool_executable*
                                                *b:ale_languagetool_executable*

  Type: |String|
  Default: `'languagetool'`

  The executable to run for languagetool.


g:ale_languagetool_options                         *g:ale_languagetool_options*
                                                   *b:ale_languagetool_options*
  Type: |String|
  Default: `'--autoDetect'`

  This variable can be set to pass additional options to languagetool.


-------------------------------------------------------------------------------
7.3. Options for write-good                            *ale-write-good-options*

The options for `write-good` are shared between all filetypes, so options can
be configured once.

g:ale_writegood_executable                         *g:ale_writegood_executable*
                                                   *b:ale_writegood_executable*
  Type: |String|
  Default: `'writegood'`

  See |ale-integrations-local-executables|


g:ale_writegood_options                               *g:ale_writegood_options*
                                                      *b:ale_writegood_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to writegood.


g:ale_writegood_use_global                         *g:ale_writegood_use_global*
                                                   *b:ale_writegood_use_global*
  Type: |Number|
  Default: `get(g:, 'ale_use_global_executables', 0)`

  See |ale-integrations-local-executables|


-------------------------------------------------------------------------------
7.4. Other Linter/Fixer Options                 *ale-other-integration-options*

ALE supports a very wide variety of tools. Other linter or fixer options are
documented in additional help files.

  ada.....................................|ale-ada-options|
    gcc...................................|ale-ada-gcc|
    gnatpp................................|ale-ada-gnatpp|
  ansible.................................|ale-ansible-options|
    ansible-lint..........................|ale-ansible-ansible-lint|
  asciidoc................................|ale-asciidoc-options|
    write-good............................|ale-asciidoc-write-good|
    textlint..............................|ale-asciidoc-textlint|
  asm.....................................|ale-asm-options|
    gcc...................................|ale-asm-gcc|
  awk.....................................|ale-awk-options|
    gawk..................................|ale-awk-gawk|
  bats....................................|ale-bats-options|
    shellcheck............................|ale-bats-shellcheck|
  bib.....................................|ale-bib-options|
    bibclean..............................|ale-bib-bibclean|
  c.......................................|ale-c-options|
    clang.................................|ale-c-clang|
    clangd................................|ale-c-clangd|
    clang-format..........................|ale-c-clangformat|
    clangtidy.............................|ale-c-clangtidy|
    cppcheck..............................|ale-c-cppcheck|
    cquery................................|ale-c-cquery|
    flawfinder............................|ale-c-flawfinder|
    gcc...................................|ale-c-gcc|
    uncrustify............................|ale-c-uncrustify|
    ccls..................................|ale-c-ccls|
  chef....................................|ale-chef-options|
    cookstyle.............................|ale-chef-cookstyle|
    foodcritic............................|ale-chef-foodcritic|
  clojure.................................|ale-clojure-options|
    clj-kondo.............................|ale-clojure-clj-kondo|
    joker.................................|ale-clojure-joker|
  cloudformation..........................|ale-cloudformation-options|
    cfn-python-lint.......................|ale-cloudformation-cfn-python-lint|
  cmake...................................|ale-cmake-options|
    cmakelint.............................|ale-cmake-cmakelint|
    cmake-format..........................|ale-cmake-cmakeformat|
  cpp.....................................|ale-cpp-options|
    clang.................................|ale-cpp-clang|
    clangd................................|ale-cpp-clangd|
    clangcheck............................|ale-cpp-clangcheck|
    clang-format..........................|ale-cpp-clangformat|
    clangtidy.............................|ale-cpp-clangtidy|
    clazy.................................|ale-cpp-clazy|
    cppcheck..............................|ale-cpp-cppcheck|
    cpplint...............................|ale-cpp-cpplint|
    cquery................................|ale-cpp-cquery|
    flawfinder............................|ale-cpp-flawfinder|
    gcc...................................|ale-cpp-gcc|
    uncrustify............................|ale-cpp-uncrustify|
    ccls..................................|ale-cpp-ccls|
  c#......................................|ale-cs-options|
    csc...................................|ale-cs-csc|
    mcs...................................|ale-cs-mcs|
    mcsc..................................|ale-cs-mcsc|
    uncrustify............................|ale-cs-uncrustify|
  css.....................................|ale-css-options|
    fecs..................................|ale-css-fecs|
    prettier..............................|ale-css-prettier|
    stylelint.............................|ale-css-stylelint|
  cuda....................................|ale-cuda-options|
    nvcc..................................|ale-cuda-nvcc|
    clang-format..........................|ale-cuda-clangformat|
  d.......................................|ale-d-options|
    dfmt..................................|ale-d-dfmt|
    dls...................................|ale-d-dls|
    uncrustify............................|ale-d-uncrustify|
  dart....................................|ale-dart-options|
    dartanalyzer..........................|ale-dart-dartanalyzer|
    dartfmt...............................|ale-dart-dartfmt|
  dockerfile..............................|ale-dockerfile-options|
    dockerfile_lint.......................|ale-dockerfile-dockerfile_lint|
    hadolint..............................|ale-dockerfile-hadolint|
  elixir..................................|ale-elixir-options|
    mix...................................|ale-elixir-mix|
    mix_format............................|ale-elixir-mix-format|
    dialyxir..............................|ale-elixir-dialyxir|
    elixir-ls.............................|ale-elixir-elixir-ls|
    credo.................................|ale-elixir-credo|
  elm.....................................|ale-elm-options|
    elm-format............................|ale-elm-elm-format|
    elm-ls................................|ale-elm-elm-ls|
    elm-make..............................|ale-elm-elm-make|
  erlang..................................|ale-erlang-options|
    dialyzer..............................|ale-erlang-dialyzer|
    erlc..................................|ale-erlang-erlc|
    syntaxerl.............................|ale-erlang-syntaxerl|
  eruby...................................|ale-eruby-options|
    ruumba................................|ale-eruby-ruumba|
  fish....................................|ale-fish-options|
  fortran.................................|ale-fortran-options|
    gcc...................................|ale-fortran-gcc|
    language_server.......................|ale-fortran-language-server|
  fountain................................|ale-fountain-options|
  fusionscript............................|ale-fuse-options|
    fusion-lint...........................|ale-fuse-fusionlint|
  git commit..............................|ale-gitcommit-options|
    gitlint...............................|ale-gitcommit-gitlint|
  glsl....................................|ale-glsl-options|
    glslang...............................|ale-glsl-glslang|
    glslls................................|ale-glsl-glslls|
  go......................................|ale-go-options|
    bingo.................................|ale-go-bingo|
    gobuild...............................|ale-go-gobuild|
    gofmt.................................|ale-go-gofmt|
    golangci-lint.........................|ale-go-golangci-lint|
    golangserver..........................|ale-go-golangserver|
    golint................................|ale-go-golint|
    gometalinter..........................|ale-go-gometalinter|
    gopls.................................|ale-go-gopls|
    govet.................................|ale-go-govet|
    revive................................|ale-go-revive|
    staticcheck...........................|ale-go-staticcheck|
  graphql.................................|ale-graphql-options|
    eslint................................|ale-graphql-eslint|
    gqlint................................|ale-graphql-gqlint|
    prettier..............................|ale-graphql-prettier|
  hack....................................|ale-hack-options|
    hack..................................|ale-hack-hack|
    hackfmt...............................|ale-hack-hackfmt|
    hhast.................................|ale-hack-hhast|
  handlebars..............................|ale-handlebars-options|
    prettier..............................|ale-handlebars-prettier|
    ember-template-lint...................|ale-handlebars-embertemplatelint|
  haskell.................................|ale-haskell-options|
    brittany..............................|ale-haskell-brittany|
    floskell..............................|ale-haskell-floskell|
    ghc...................................|ale-haskell-ghc|
    ghc-mod...............................|ale-haskell-ghc-mod|
    cabal-ghc.............................|ale-haskell-cabal-ghc|
    hdevtools.............................|ale-haskell-hdevtools|
    hfmt..................................|ale-haskell-hfmt|
    hindent...............................|ale-haskell-hindent|
    hlint.................................|ale-haskell-hlint|
    stack-build...........................|ale-haskell-stack-build|
    stack-ghc.............................|ale-haskell-stack-ghc|
    stylish-haskell.......................|ale-haskell-stylish-haskell|
    hie...................................|ale-haskell-hie|
  hcl.....................................|ale-hcl-options|
    terraform-fmt.........................|ale-hcl-terraform-fmt|
  html....................................|ale-html-options|
    fecs..................................|ale-html-fecs|
    html-beautify.........................|ale-html-beautify|
    htmlhint..............................|ale-html-htmlhint|
    tidy..................................|ale-html-tidy|
    prettier..............................|ale-html-prettier|
    stylelint.............................|ale-html-stylelint|
    write-good............................|ale-html-write-good|
  idris...................................|ale-idris-options|
    idris.................................|ale-idris-idris|
  ink.....................................|ale-ink-options|
    ink-language-server...................|ale-ink-language-server|
  ispc....................................|ale-ispc-options|
    ispc..................................|ale-ispc-ispc|
  java....................................|ale-java-options|
    checkstyle............................|ale-java-checkstyle|
    javac.................................|ale-java-javac|
    google-java-format....................|ale-java-google-java-format|
    pmd...................................|ale-java-pmd|
    javalsp...............................|ale-java-javalsp|
    eclipselsp............................|ale-java-eclipselsp|
    uncrustify............................|ale-java-uncrustify|
  javascript..............................|ale-javascript-options|
    eslint................................|ale-javascript-eslint|
    fecs..................................|ale-javascript-fecs|
    flow..................................|ale-javascript-flow|
    importjs..............................|ale-javascript-importjs|
    jscs..................................|ale-javascript-jscs|
    jshint................................|ale-javascript-jshint|
    prettier..............................|ale-javascript-prettier|
    prettier-eslint.......................|ale-javascript-prettier-eslint|
    prettier-standard.....................|ale-javascript-prettier-standard|
    standard..............................|ale-javascript-standard|
    xo....................................|ale-javascript-xo|
  json....................................|ale-json-options|
    fixjson...............................|ale-json-fixjson|
    jsonlint..............................|ale-json-jsonlint|
    jq....................................|ale-json-jq|
    prettier..............................|ale-json-prettier|
  julia...................................|ale-julia-options|
    languageserver........................|ale-julia-languageserver|
  kotlin..................................|ale-kotlin-options|
    kotlinc...............................|ale-kotlin-kotlinc|
    ktlint................................|ale-kotlin-ktlint|
    languageserver........................|ale-kotlin-languageserver|
  latex...................................|ale-latex-options|
    write-good............................|ale-latex-write-good|
    textlint..............................|ale-latex-textlint|
  less....................................|ale-less-options|
    lessc.................................|ale-less-lessc|
    prettier..............................|ale-less-prettier|
    stylelint.............................|ale-less-stylelint|
  llvm....................................|ale-llvm-options|
    llc...................................|ale-llvm-llc|
  lua.....................................|ale-lua-options|
    luac..................................|ale-lua-luac|
    luacheck..............................|ale-lua-luacheck|
  markdown................................|ale-markdown-options|
    mdl...................................|ale-markdown-mdl|
    prettier..............................|ale-markdown-prettier|
    remark-lint...........................|ale-markdown-remark-lint|
    textlint..............................|ale-markdown-textlint|
    write-good............................|ale-markdown-write-good|
  mercury.................................|ale-mercury-options|
    mmc...................................|ale-mercury-mmc|
  nasm....................................|ale-nasm-options|
    nasm..................................|ale-nasm-nasm|
  nim.....................................|ale-nim-options|
    nimcheck..............................|ale-nim-nimcheck|
    nimlsp................................|ale-nim-nimlsp|
    nimpretty.............................|ale-nim-nimpretty|
  nix.....................................|ale-nix-options|
    nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
  nroff...................................|ale-nroff-options|
    write-good............................|ale-nroff-write-good|
  objc....................................|ale-objc-options|
    clang.................................|ale-objc-clang|
    clangd................................|ale-objc-clangd|
    uncrustify............................|ale-objc-uncrustify|
    ccls..................................|ale-objc-ccls|
  objcpp..................................|ale-objcpp-options|
    clang.................................|ale-objcpp-clang|
    clangd................................|ale-objcpp-clangd|
    uncrustify............................|ale-objcpp-uncrustify|
  ocaml...................................|ale-ocaml-options|
    merlin................................|ale-ocaml-merlin|
    ols...................................|ale-ocaml-ols|
    ocamlformat...........................|ale-ocaml-ocamlformat|
    ocp-indent............................|ale-ocaml-ocp-indent|
  pawn....................................|ale-pawn-options|
    uncrustify............................|ale-pawn-uncrustify|
  perl....................................|ale-perl-options|
    perl..................................|ale-perl-perl|
    perlcritic............................|ale-perl-perlcritic|
    perltidy..............................|ale-perl-perltidy|
  perl6...................................|ale-perl6-options|
    perl6.................................|ale-perl6-perl6|
  php.....................................|ale-php-options|
    langserver............................|ale-php-langserver|
    phan..................................|ale-php-phan|
    phpcbf................................|ale-php-phpcbf|
    phpcs.................................|ale-php-phpcs|
    phpmd.................................|ale-php-phpmd|
    phpstan...............................|ale-php-phpstan|
    psalm.................................|ale-php-psalm|
    php-cs-fixer..........................|ale-php-php-cs-fixer|
    php...................................|ale-php-php|
  po......................................|ale-po-options|
    write-good............................|ale-po-write-good|
  pod.....................................|ale-pod-options|
    write-good............................|ale-pod-write-good|
  pony....................................|ale-pony-options|
    ponyc.................................|ale-pony-ponyc|
  powershell............................|ale-powershell-options|
    powershell..........................|ale-powershell-powershell|
    psscriptanalyzer....................|ale-powershell-psscriptanalyzer|
  prolog..................................|ale-prolog-options|
    swipl.................................|ale-prolog-swipl|
  proto...................................|ale-proto-options|
    protoc-gen-lint.......................|ale-proto-protoc-gen-lint|
  pug.....................................|ale-pug-options|
    puglint...............................|ale-pug-puglint|
  puppet..................................|ale-puppet-options|
    puppet................................|ale-puppet-puppet|
    puppetlint............................|ale-puppet-puppetlint|
    puppet-languageserver.................|ale-puppet-languageserver|
  purescript..............................|ale-purescript-options|
    purescript-language-server............|ale-purescript-language-server|
    purty.................................|ale-purescript-purty|
  pyrex (cython)..........................|ale-pyrex-options|
    cython................................|ale-pyrex-cython|
  python..................................|ale-python-options|
    autopep8..............................|ale-python-autopep8|
    bandit................................|ale-python-bandit|
    black.................................|ale-python-black|
    flake8................................|ale-python-flake8|
    isort.................................|ale-python-isort|
    mypy..................................|ale-python-mypy|
    prospector............................|ale-python-prospector|
    pycodestyle...........................|ale-python-pycodestyle|
    pydocstyle............................|ale-python-pydocstyle|
    pyflakes..............................|ale-python-pyflakes|
    pylama................................|ale-python-pylama|
    pylint................................|ale-python-pylint|
    pyls..................................|ale-python-pyls|
    pyre..................................|ale-python-pyre|
    reorder-python-imports................|ale-python-reorder_python_imports|
    vulture...............................|ale-python-vulture|
    yapf..................................|ale-python-yapf|
  qml.....................................|ale-qml-options|
    qmlfmt................................|ale-qml-qmlfmt|
  r.......................................|ale-r-options|
    lintr.................................|ale-r-lintr|
    styler................................|ale-r-styler|
  reasonml................................|ale-reasonml-options|
    merlin................................|ale-reasonml-merlin|
    ols...................................|ale-reasonml-ols|
    reason-language-server................|ale-reasonml-language-server|
    refmt.................................|ale-reasonml-refmt|
  restructuredtext........................|ale-restructuredtext-options|
    textlint..............................|ale-restructuredtext-textlint|
    write-good............................|ale-restructuredtext-write-good|
  ruby....................................|ale-ruby-options|
    brakeman..............................|ale-ruby-brakeman|
    debride...............................|ale-ruby-debride|
    rails_best_practices..................|ale-ruby-rails_best_practices|
    reek..................................|ale-ruby-reek|
    rubocop...............................|ale-ruby-rubocop|
    ruby..................................|ale-ruby-ruby|
    rufo..................................|ale-ruby-rufo|
    solargraph............................|ale-ruby-solargraph|
    sorbet................................|ale-ruby-sorbet|
    standardrb............................|ale-ruby-standardrb|
  rust....................................|ale-rust-options|
    analyzer..............................|ale-rust-analyzer|
    cargo.................................|ale-rust-cargo|
    rls...................................|ale-rust-rls|
    rustc.................................|ale-rust-rustc|
    rustfmt...............................|ale-rust-rustfmt|
  sass....................................|ale-sass-options|
    sasslint..............................|ale-sass-sasslint|
    stylelint.............................|ale-sass-stylelint|
  scala...................................|ale-scala-options|
    metals................................|ale-scala-metals|
    sbtserver.............................|ale-scala-sbtserver|
    scalafmt..............................|ale-scala-scalafmt|
    scalastyle............................|ale-scala-scalastyle|
  scss....................................|ale-scss-options|
    prettier..............................|ale-scss-prettier|
    sasslint..............................|ale-scss-sasslint|
    stylelint.............................|ale-scss-stylelint|
  sh......................................|ale-sh-options|
    bashate...............................|ale-sh-bashate|
    sh-language-server....................|ale-sh-language-server|
    shell.................................|ale-sh-shell|
    shellcheck............................|ale-sh-shellcheck|
    shfmt.................................|ale-sh-shfmt|
  sml.....................................|ale-sml-options|
    smlnj.................................|ale-sml-smlnj|
  solidity................................|ale-solidity-options|
    solc..................................|ale-solidity-solc|
    solhint...............................|ale-solidity-solhint|
    solium................................|ale-solidity-solium|
  spec....................................|ale-spec-options|
    rpmlint...............................|ale-spec-rpmlint|
  sql.....................................|ale-sql-options|
    pgformatter...........................|ale-sql-pgformatter|
    sqlfmt................................|ale-sql-sqlfmt|
    sqlformat.............................|ale-sql-sqlformat|
  stylus..................................|ale-stylus-options|
    stylelint.............................|ale-stylus-stylelint|
  sugarss.................................|ale-sugarss-options|
    stylelint.............................|ale-sugarss-stylelint|
  swift...................................|ale-swift-options|
    sourcekitlsp..........................|ale-swift-sourcekitlsp|
  tcl.....................................|ale-tcl-options|
    nagelfar..............................|ale-tcl-nagelfar|
  terraform...............................|ale-terraform-options|
    terraform-fmt-fixer...................|ale-terraform-fmt-fixer|
    terraform.............................|ale-terraform-terraform|
    terraform-lsp.........................|ale-terraform-terraform-lsp|
    tflint................................|ale-terraform-tflint|
  tex.....................................|ale-tex-options|
    chktex................................|ale-tex-chktex|
    lacheck...............................|ale-tex-lacheck|
    latexindent...........................|ale-tex-latexindent|
    texlab................................|ale-tex-texlab|
  texinfo.................................|ale-texinfo-options|
    write-good............................|ale-texinfo-write-good|
  text....................................|ale-text-options|
    textlint..............................|ale-text-textlint|
    write-good............................|ale-text-write-good|
  thrift..................................|ale-thrift-options|
    thrift................................|ale-thrift-thrift|
  typescript..............................|ale-typescript-options|
    eslint................................|ale-typescript-eslint|
    prettier..............................|ale-typescript-prettier|
    standard..............................|ale-typescript-standard|
    tslint................................|ale-typescript-tslint|
    tsserver..............................|ale-typescript-tsserver|
  vala....................................|ale-vala-options|
    uncrustify............................|ale-vala-uncrustify|
  verilog/systemverilog...................|ale-verilog-options|
    iverilog..............................|ale-verilog-iverilog|
    verilator.............................|ale-verilog-verilator|
    vlog..................................|ale-verilog-vlog|
    xvlog.................................|ale-verilog-xvlog|
  vhdl....................................|ale-vhdl-options|
    ghdl..................................|ale-vhdl-ghdl|
    vcom..................................|ale-vhdl-vcom|
    xvhdl.................................|ale-vhdl-xvhdl|
  vim.....................................|ale-vim-options|
    vimls.................................|ale-vim-vimls|
    vint..................................|ale-vim-vint|
  vim help................................|ale-vim-help-options|
    write-good............................|ale-vim-help-write-good|
  vue.....................................|ale-vue-options|
    prettier..............................|ale-vue-prettier|
    vls...................................|ale-vue-vls|
  xhtml...................................|ale-xhtml-options|
    write-good............................|ale-xhtml-write-good|
  xml.....................................|ale-xml-options|
    xmllint...............................|ale-xml-xmllint|
  yaml....................................|ale-yaml-options|
    prettier..............................|ale-yaml-prettier|
    swaglint..............................|ale-yaml-swaglint|
    yamllint..............................|ale-yaml-yamllint|
  yang....................................|ale-yang-options|
    yang-lsp..............................|ale-yang-lsp|
  zig.....................................|ale-zig-options|
    zls...................................|ale-zig-zls|


===============================================================================
8. Commands/Keybinds                                             *ale-commands*

ALEComplete                                                       *ALEComplete*

  Manually trigger LSP autocomplete and show the menu. Works only when called
  from insert mode. >

    inoremap <silent> <C-Space> <C-\><C-O>:AleComplete<CR>
<
  A plug mapping `<Plug>(ale_complete)` is defined for this command. >

    imap <C-Space> <Plug>(ale_complete)
<
ALEDocumentation                                             *ALEDocumentation*

  Similar to the |ALEHover| command, retrieve documentation information for
  the symbol at the cursor. Documentation data will always be shown in a
  preview window, no matter how small the documentation content is.

  NOTE: This command is only available for `tsserver`.

  A plug mapping `<Plug>(ale_documentation)` is defined for this command.


ALEFindReferences                                           *ALEFindReferences*

  Find references in the codebase for the symbol under the cursor using the
  enabled LSP linters for the buffer. ALE will display a preview window
  containing the results if some references are found.

  The window can be navigated using the usual Vim navigation commands. The
  Enter key (`<CR>`) can be used to jump to a referencing location, or the `t`
  key can be used to jump to the location in a new tab.

  The locations opened in different ways using the following variations.

  `:ALEFindReferences -tab`    - Open the location in a new tab.
  `:ALEFindReferences -split`  - Open the location in a horizontal split.
  `:ALEFindReferences -vsplit` - Open the location in a vertical split.

  The default method used for navigating to a new location can be changed
  by modifying |g:ale_default_navigation|.

  The selection can be opened again with the |ALERepeatSelection| command.

  You can jump back to the position you were at before going to a reference of
  something with jump motions like CTRL-O. See |jump-motions|.

  A plug mapping `<Plug>(ale_find_references)` is defined for this command.


ALEFix                                                                 *ALEFix*

  Fix problems with the current buffer. See |ale-fix| for more information.

  A plug mapping `<Plug>(ale_fix)` is defined for this command.


ALEFixSuggest                                                   *ALEFixSuggest*

  Suggest tools that can be used to fix problems in the current buffer.

  See |ale-fix| for more information.


ALEGoToDefinition `<options>`                               *ALEGoToDefinition*

  Jump to the definition of a symbol under the cursor using the enabled LSP
  linters for the buffer. ALE will jump to a definition if an LSP server
  provides a location to jump to. Otherwise, ALE will do nothing.

  The locations opened in different ways using the following variations.

  `:ALEGoToDefinition -tab`    - Open the location in a new tab.
  `:ALEGoToDefinition -split`  - Open the location in a horizontal split.
  `:ALEGoToDefinition -vsplit` - Open the location in a vertical split.

  The default method used for navigating to a new location can be changed
  by modifying |g:ale_default_navigation|.

  You can jump back to the position you were at before going to the definition
  of something with jump motions like CTRL-O. See |jump-motions|.

  You should consider using the 'hidden' option in combination with this
  command. Otherwise, Vim will refuse to leave the buffer you're jumping from
  unless you have saved your edits.

  A plug mapping `<Plug>(ale_go_to_definition)` is defined for this command.


ALEGoToTypeDefinition                                   *ALEGoToTypeDefinition*

  This works similar to |ALEGoToDefinition| but instead jumps to the
  definition of a type of a symbol under the cursor. ALE will jump to a
  definition if an LSP server provides a location to jump to. Otherwise, ALE
  will do nothing.

  The locations opened in different ways using the following variations.

  `:ALEGoToTypeDefinition -tab`    - Open the location in a new tab.
  `:ALEGoToTypeDefinition -split`  - Open the location in a horizontal split.
  `:ALEGoToTypeDefinition -vsplit` - Open the location in a vertical split.

  The default method used for navigating to a new location can be changed
  by modifying |g:ale_default_navigation|.

  You can jump back to the position you were at before going to the definition
  of something with jump motions like CTRL-O. See |jump-motions|.

  A plug mapping `<Plug>(ale_go_to_type_definition)` is defined for this
  command.


ALEHover                                                             *ALEHover*

  Print brief information about the symbol under the cursor, taken from any
  available LSP linters. There may be a small non-blocking delay before
  information is printed.

  NOTE: In Vim 8, long messages will be shown in a preview window, as Vim 8
  does not support showing a prompt to press enter to continue for long
  messages from asynchronous callbacks.

  A plug mapping `<Plug>(ale_hover)` is defined for this command.


ALEOrganizeImports                                         *ALEOrganizeImports*

  Organize imports using tsserver. Currently not implemented for LSPs.


ALERename                                                           *ALERename*

  Rename a symbol using TypeScript server or Language Server.

  The user will be prompted for a new name.


ALERepeatSelection                                         *ALERepeatSelection*

  Repeat the last selection displayed in the preview window.


ALESymbolSearch `<query>`                                     *ALESymbolSearch*

  Search for symbols in the workspace, taken from any available LSP linters.

  The arguments provided to this command will be used as a search query for
  finding symbols in the workspace, such as functions, types, etc.

                                                                     *:ALELint*
ALELint                                                               *ALELint*

  Run ALE once for the current buffer. This command can be used to run ALE
  manually, instead of automatically, if desired.

  This command will also run linters where `lint_file` is set to `1`, or in
  other words linters which check the file instead of the Vim buffer.

  A plug mapping `<Plug>(ale_lint)` is defined for this command.


ALEPrevious                                                       *ALEPrevious*
ALEPreviousWrap                                               *ALEPreviousWrap*
ALENext                                                               *ALENext*
ALENextWrap                                                       *ALENextWrap*
ALEFirst                                                             *ALEFirst*
ALELast                                                               *ALELast*
                                                      *ale-navigation-commands*

  Move between warnings or errors in a buffer. ALE will only navigate between
  the errors or warnings it generated, even if both |g:ale_set_quickfix|
  and |g:ale_set_loclist| are set to `0`.

  `ALEPrevious` and `ALENext` will stop at the top and bottom of a file, while
  `ALEPreviousWrap` and `ALENextWrap` will wrap around the file to find
  the last or first warning or error in the file, respectively.

  `ALEPrevious` and `ALENext` take optional flags arguments to custom their
  behaviour :
  `-wrap` enable wrapping around the file
  `-error`, `-warning` and `-info` enable jumping to errors, warnings or infos
    respectively, ignoring anything else. They are mutually exclusive and if
    several are provided the priority is the following: error > warning > info.
  `-style` and `-nostyle` allow you to jump respectively to style error or
    warning and to not style error or warning. They also are mutually
    exclusive and nostyle has priority over style.

  Flags can be combined to create create custom jumping. Thus you can use
  ":ALENext -wrap -error -nosyle" to jump to the next error which is not a
  style error while going back to the beginning of the file if needed.

  `ALEFirst` goes to the first error or warning in the buffer, while `ALELast`
  goes to the last one.

  The following |<Plug>| mappings are defined for the commands: >
  <Plug>(ale_previous) - ALEPrevious
  <Plug>(ale_previous_wrap) - ALEPreviousWrap
  <Plug>(ale_previous_error) - ALEPrevious -error
  <Plug>(ale_previous_wrap_error) - ALEPrevious -wrap -error
  <Plug>(ale_previous_warning) - ALEPrevious -warning
  <Plug>(ale_previous_wrap_warning) - ALEPrevious -wrap -warning
  <Plug>(ale_next) - ALENext
  <Plug>(ale_next_wrap) - ALENextWrap
  <Plug>(ale_next_error) - ALENext -error
  <Plug>(ale_next_wrap_error) - ALENext -wrap -error
  <Plug>(ale_next_warning) - ALENext -warning
  <Plug>(ale_next_wrap_warning) - ALENext -wrap -warning
  <Plug>(ale_first) - ALEFirst
  <Plug>(ale_last) - ALELast
<
  For example, these commands could be bound to the keys Ctrl + j
  and Ctrl + k: >

  " Map movement through errors without wrapping.
  nmap <silent> <C-k> <Plug>(ale_previous)
  nmap <silent> <C-j> <Plug>(ale_next)
  " OR map keys to use wrapping.
  nmap <silent> <C-k> <Plug>(ale_previous_wrap)
  nmap <silent> <C-j> <Plug>(ale_next_wrap)
<

ALEToggle                                                           *ALEToggle*
ALEEnable                                                           *ALEEnable*
ALEDisable                                                         *ALEDisable*
ALEToggleBuffer                                               *ALEToggleBuffer*
ALEEnableBuffer                                               *ALEEnableBuffer*
ALEDisableBuffer                                             *ALEDisableBuffer*

  `ALEToggle`, `ALEEnable`, and `ALEDisable` enable or disable ALE linting,
  including all of its autocmd events, loclist items, quickfix items, signs,
  current jobs, etc., globally. Executing any of these commands will change
  the |g:ale_enabled| variable.

  ALE can be disabled or enabled for only a single buffer with
  `ALEToggleBuffer`, `ALEEnableBuffer`, and `ALEDisableBuffer`. Disabling ALE
  for a buffer will not remove autocmd events, but will prevent ALE from
  checking for problems and reporting problems for whatever buffer the
  `ALEDisableBuffer` or `ALEToggleBuffer` command is executed from. These
  commands can be used for temporarily disabling ALE for a buffer. These
  commands will modify the |b:ale_enabled| variable.

  ALE linting cannot be enabled for a single buffer when it is disabled
  globally, as disabling ALE globally removes the autocmd events needed to
  perform linting with.

  The following plug mappings are defined, for conveniently defining keybinds:

  |ALEToggle|        - `<Plug>(ale_toggle)`
  |ALEEnable|        - `<Plug>(ale_enable)`
  |ALEDisable|       - `<Plug>(ale_disable)`
  |ALEToggleBuffer|  - `<Plug>(ale_toggle_buffer)`
  |ALEEnableBuffer|  - `<Plug>(ale_enable_buffer)`
  |ALEDisableBuffer| - `<Plug>(ale_disable_buffer)`

  For removing problems reported by ALE, but leaving ALE enabled, see
  |ALEReset| and |ALEResetBuffer|.

                                                                   *:ALEDetail*
ALEDetail                                                           *ALEDetail*

  Show the full linter message for the problem nearest to the cursor on the
  given line in the preview window. The preview window can be easily closed
  with the `q` key. If there is no message to show, the window will not be
  opened.

  If a loclist item has a `detail` key set, the message for that key will be
  preferred over `text`. See |ale-loclist-format|.

  A plug mapping `<Plug>(ale_detail)` is defined for this command.


                                                                     *:ALEInfo*
ALEInfo                                                               *ALEInfo*
ALEInfoToClipboard                                         *ALEInfoToClipboard*

  Print runtime information about ALE, including the values of global and
  buffer-local settings for ALE, the linters that are enabled, the commands
  that have been run, and the output of commands.

  ALE will log the commands that are run by default. If you wish to disable
  this, set |g:ale_history_enabled| to `0`. Because it could be expensive, ALE
  does not remember the output of recent commands by default. Set
  |g:ale_history_log_output| to `1` to enable logging of output for commands.
  ALE will only log the output captured for parsing problems, etc.

  The command `:ALEInfoToClipboard` can be used to output ALEInfo directly to
  your clipboard. This might not work on every machine.

  `:ALEInfoToFile` will write the ALE runtime information to a given filename.
  The filename works just like |:w|.


ALEReset                                                             *ALEReset*
ALEResetBuffer                                                 *ALEResetBuffer*

  `ALEReset` will remove all problems reported by ALE for all buffers.
  `ALEResetBuffer` will remove all problems reported for a single buffer.

  Either command will leave ALE linting enabled, so ALE will report problems
  when linting is performed again. See |ale-lint| for more information.

  The following plug mappings are defined, for conveniently defining keybinds:

  |ALEReset|       - `<Plug>(ale_reset)`
  |ALEResetBuffer| - `<Plug>(ale_reset_buffer)`

  ALE can be disabled globally or for a buffer with |ALEDisable| or
  |ALEDisableBuffer|.


ALEStopAllLSPs                                                 *ALEStopAllLSPs*

  `ALEStopAllLSPs` will close and stop all channels and jobs for all LSP-like
  clients, including tsserver, remove all of the data stored for them, and
  delete all of the problems found for them, updating every linted buffer.

  This command can be used when LSP clients mess up and need to be restarted.


===============================================================================
9. API                                                                *ale-api*

ALE offers a number of functions for running linters or fixers, or defining
them. The following functions are part of the publicly documented part of that
API, and should be expected to continue to work.


ale#Env(variable_name, value)                                       *ale#Env()*

  Given a variable name and a string value, produce a string for including in
  a command for setting environment variables. This function can be used for
  building a command like so. >

    :echo string(ale#Env('VAR', 'some value') . 'command')
    'VAR=''some value'' command'      # On Linux or Mac OSX
    'set VAR="some value" && command' # On Windows


ale#Has(feature)                                                    *ale#Has()*

  Return `1` if ALE supports a given feature, like |has()| for Vim features.

  ALE versions can be checked with version strings in the format
  `ale#Has('ale-x.y.z')`, such as `ale#Has('ale-2.4.0')`.


ale#Pad(string)                                                     *ale#Pad()*

  Given a string or any |empty()| value, return either the string prefixed
  with a single space, or an empty string. This function can be used to build
  parts of a command from variables.


ale#Queue(delay, [linting_flag, buffer_number])                   *ale#Queue()*

  Run linters for the current buffer, based on the filetype of the buffer,
  with a given `delay`. A `delay` of `0` will run the linters immediately.
  The linters will always be run in the background. Calling this function
  again from the same buffer

  An optional `linting_flag` argument can be given. If `linting_flag`
  is `'lint_file'`, then linters where the `lint_file` option is set to `1` will be
  run. Linters with `lint_file` set to `1` are not run by default.

  An optional `buffer_number` argument can be given for specifying the buffer
  to check. The active buffer (`bufnr('')`) will be checked by default.

                                                                *ale-cool-down*
  If an exception is thrown when queuing/running ALE linters, ALE will enter
  a cool down period where it will stop checking anything for a short period
  of time. This is to prevent ALE from seriously annoying users if a linter
  is broken, or when developing ALE itself.


ale#command#CreateDirectory(buffer)             *ale#command#CreateDirectory()*

  Create a new temporary directory with a unique name, and manage that
  directory with |ale#command#ManageDirectory()|, so it will be removed as soon
  as possible.

  It is advised to only call this function from a callback function for
  returning a linter command to run.


ale#command#CreateFile(buffer)                       *ale#command#CreateFile()*

  Create a new temporary file with a unique name, and manage that file with
  |ale#command#ManageFile()|, so it will be removed as soon as possible.

  It is advised to only call this function from a callback function for
  returning a linter command to run.


ale#command#Run(buffer, command, callback, [options])       *ale#command#Run()*

  Start running a job in the background, and pass the results to the given
  callback later.

  This function can be used for computing the results of ALE linter or fixer
  functions asynchronously with jobs. `buffer` must match the buffer being
  linted or fixed, `command` must be a |String| for a shell command to
  execute, `callback` must be defined as a |Funcref| to call later with the
  results, and an optional |Dictionary| of `options` can be provided.

  The `callback` will receive the arguments `(buffer, output, metadata)`,
  where the `buffer` will match the buffer given to the function, the `output`
  will be a `List` of lines of output from the job that was run, and the
  `metadata` will be a |Dictionary| with additional information about the job
  that was run, including:

    `exit_code` - A |Number| with the exit code for the program that was run.

  The result of this function is either a special |Dictionary| ALE will use
  for waiting for the command to finish, or `0` if the job is not started. The
  The return value of the `callback` will be used as the eventual result for
  whatever value is being given to ALE. For example: >

    function! s:GetCommand(buffer, output, meta) abort
        " Do something with a:output here, from the foo command.

        " This is used as the command to run for linting.
        return 'final command'
    endfunction

    " ...

    'command': {b -> ale#command#Run(b, 'foo', function('s:GetCommand'))}
<
  The result of a callback can also be the result of another call to this
  function, so that several commands can be arbitrarily chained together. For
  example: >

    function! s:GetAnotherCommand(buffer, output, meta) abort
        " We can finally return this command.
        return 'last command'
    endfunction

    function! s:GetCommand(buffer, output, meta) abort
        " We can return another deferred result.
        return ale#command#Run(
        \   a:buffer,
        \   'second command',
        \   function('s:GetAnotherCommand')
        \)
    endfunction

    " ...

    'command': {b -> ale#command#Run(b, 'foo', function('s:GetCommand'))}
<
  The following `options` can be provided.

    `output_stream` - Either `'stdout'`, `'stderr'`, `'both'`, or `'none`' for
                    selecting which output streams to read lines from.

                    The default is `'stdout'`

    `executable`    - An executable for formatting into `%e` in the command.
                    If this option is not provided, formatting commands with
                    `%e` will not work.

    `read_buffer`   - If set to `1`, the buffer will be piped into the
                    command.

                    The default is `0`.

    `input`         - When creating temporary files with `%t` or piping text
                    into a command `input` can be set to a |List| of text to
                    use instead of the buffer's text.


ale#command#EscapeCommandPart(command_part)   *ale#command#EscapeCommandPart()*

  Given a |String|, return a |String| with all `%` characters replaced with
  `%%` instead. This function can be used to escape strings which are
  dynamically generated for commands before handing them over to ALE,
  so that ALE doesn't treat any strings with `%` formatting sequences
  specially.


ale#command#ManageDirectory(buffer, directory)  *ale#command#ManageDirectory()*

  Like |ale#command#ManageFile()|, but directories and all of their contents
  will be deleted, akin to `rm -rf directory`, which could lead to loss of
  data if mistakes are made. This command will also delete any temporary
  filenames given to it.

  It is advised to use |ale#command#ManageFile()| instead for deleting single
  files.


ale#command#ManageFile(buffer, filename)             *ale#command#ManageFile()*

  Given a buffer number for a buffer currently running some linting or fixing
  tasks and a filename, register a filename with ALE for automatic deletion
  after linting or fixing is complete, or when Vim exits.

  If Vim exits suddenly, ALE will try its best to remove temporary files, but
  ALE cannot guarantee with absolute certainty that the files will be removed.
  It is advised to create temporary files in the operating system's managed
  temporary file directory, such as with |tempname()|.

  Directory names should not be given to this function. ALE will only delete
  files and symlinks given to this function. This is to prevent entire
  directories from being accidentally deleted, say in cases of writing
  `dir . '/' . filename` where `filename` is actually `''`, etc. ALE instead
  manages directories separately with the |ale#command#ManageDirectory| function.


ale#completion#OmniFunc(findstart, base)            *ale#completion#OmniFunc()*

  A completion function to use with 'omnifunc'.

  See |ale-completion|.


ale#engine#GetLoclist(buffer)                         *ale#engine#GetLoclist()*

  Given a buffer number, this function will return the list of problems
  reported by ALE for a given buffer in the format accepted by |setqflist()|.

  A reference to the buffer's list of problems will be returned. The list must
  be copied before applying |map()| or |filter()|.


ale#engine#IsCheckingBuffer(buffer)             *ale#engine#IsCheckingBuffer()*

  Given a buffer number, returns `1` when ALE is busy checking that buffer.

  This function can be used for status lines, tab names, etc.


ale#fix#registry#Add(name, func, filetypes, desc, [aliases])
                                                       *ale#fix#registry#Add()*

  Given a |String| `name` for a name to add to the registry, a |String| `func`
  for a function name, a |List| `filetypes` for a list of filetypes to
  set for suggestions, and a |String| `desc` for a short description of
  the fixer, register a fixer in the registry.

  The `name` can then be used for |g:ale_fixers| in place of the function
  name, and suggested for fixing files.

  An optional |List| of |String|s for aliases can be passed as the `aliases`
  argument. These aliases can also be used for looking up a fixer function.
  ALE will search for fixers in the registry first by `name`, then by their
  `aliases`.


ale#linter#Define(filetype, linter)                       *ale#linter#Define()*

  Given a |String| for a filetype and a |Dictionary| Describing a linter
  configuration, add a linter for the given filetype. The dictionaries each
  offer the following options:

  `name`                   The name of the linter. These names will be used by
                         |g:ale_linters| option for enabling/disabling
                         particular linters.

                         This argument is required.

  `callback`               A |String| or |Funcref| for a callback function
                         accepting two arguments (buffer, lines), for a
                         buffer number the output is for, and the lines of
                         output from a linter.

                         This callback function should return a |List| of
                         |Dictionary| objects in the format accepted by
                         |setqflist()|. The |List| will be sorted by line and
                         then column order so it can be searched with a binary
                         search by in future before being passed on to the
                         |loclist|, etc.

                         This argument is required, unless the linter is an
                         LSP linter. In which case, this argument must not be
                         defined, as LSP linters handle diagnostics
                         automatically. See |ale-lsp-linters|.

                         If the function named does not exist, including if
                         the function is later deleted, ALE will behave as if
                         the callback returned an empty list.

                         The keys for each item in the List will be handled in
                         the following manner:
                                                           *ale-loclist-format*
                         `text` - This error message is required.
                         `detail` - An optional, more descriptive message.
                           This message can be displayed with the |ALEDetail|
                           command instead of the message for `text`, if set.
                         `lnum` - The line number is required. Any strings
                           will be automatically converted to numbers by
                           using `str2nr()`.

                           Line 0 will be moved to line 1, and lines beyond
                           the end of the file will be moved to the end.
                         `col` - The column number is optional and will
                           default to `0`. Any strings will be automatically
                           converted to number using `str2nr()`.
                         `end_col` - An optional end column number.
                           This key can be set to specify the column problems
                           end on, for improved highlighting.
                         `end_lnum` - An optional end line number.
                           This key can set along with `end_col` for
                           highlighting multi-line problems.
                         `bufnr` - This key represents the buffer number the
                           problems are for. This value will default to
                           the buffer number being checked.

                           The `filename` key can be set instead of this key,
                           and then the eventual `bufnr` value in the final
                           list will either represent the number for an open
                           buffer or `-1` for a file not open in any buffer.
                         `filename` - An optional filename for the file the
                           problems are for. This should be an absolute path to
                           a file.

                           Problems for files which have not yet been opened
                           will be set in those files after they are opened
                           and have been checked at least once.

                           Temporary files in directories used for Vim
                           temporary files with `tempname()` will be assumed
                           to be the buffer being checked, unless the `bufnr`
                           key is also set with a valid number for some other
                           buffer.
                         `vcol` - Defaults to `0`.

                           If set to `1`, ALE will convert virtual column
                           positions for `col` and `end_col` to byte column
                           positions. If the buffer is changed in-between
                           checking it and displaying the results, the
                           calculated byte column positions will probably be
                           wrong.
                         `type` - Defaults to `'E'`.
                         `nr` - Defaults to `-1`.

                           Numeric error code. If `nr` is not `-1`, `code`
                           likely should contain the string representation of
                           the same value.
                         `code` - No default; may be unset.

                           Human-readable |String| error code.

  `executable`             A |String| naming the executable itself which
                         will be run, or a |Funcref| for a function to call
                         for computing the executable, accepting a buffer
                         number.

                         The result can be computed with |ale#command#Run()|.

                         This value will be used to check if the program
                         requested is installed or not.

                         If an `executable` is not defined, the command will
                         be run without checking if a program is executable
                         first. Defining an executable path is recommended to
                         avoid starting too many processes.

  `command`                A |String| for a command to run asynchronously, or a
                         |Funcref| for a function to call for computing the
                         command, accepting a buffer number.

                         The result can be computed with |ale#command#Run()|.

                         This command will be fed the lines from the buffer to
                         check, and will produce the lines of output given to
                         the `callback`.

  `output_stream`          A |String| for the output stream the lines of output
                         should be read from for the command which is run. The
                         accepted values are `'stdout'`, `'stderr'`, and
                         `'both'`. This argument defaults to `'stdout'`. This
                         argument can be set for linter programs which output
                         their errors and warnings to the stderr stream
                         instead of stdout. The option `'both'` will read
                         from both stder and stdout at the same time.

  `read_buffer`            A |Number| (`0` or `1`) indicating whether a command
                         should read the Vim buffer as input via stdin. This
                         option is set to `1` by default, and can be disabled
                         if a command manually reads from a temporary file
                         instead, etc.

                                                                *ale-lint-file*
  `lint_file`              A |Number| (`0` or `1`) indicating whether a command
                         should read the file instead of the Vim buffer. This
                         option can be used for linters which must check the
                         file on disk, and which cannot check a Vim buffer
                         instead.

                         Linters set with this option will not be run as a
                         user types, per |g:ale_lint_on_text_changed|. Linters
                         will instead be run only when events occur against
                         the file on disk, including |g:ale_lint_on_enter|
                         and |g:ale_lint_on_save|. Linters with this option
                         set to `1` will also be run when linters are run
                         manually, per |ALELintPost-autocmd|.

                         When this option is set to `1`, `read_buffer` will
                         be set automatically to `0`. The two options cannot
                         be used together.

                                                              *ale-lsp-linters*
  `lsp`                    A |String| for defining LSP (Language Server Protocol)
                         linters.

                         This argument may be omitted or `''` when a linter
                         does not represent an LSP linter.

                         When this argument is set to `'stdio'`, then the
                         linter will be defined as an LSP linter which keeps a
                         process for a language server running, and
                         communicates with it directly via a |channel|.
                         `executable` and `command` must be set.

                         When this argument is set to `'socket'`, then the
                         linter will be defined as an LSP linter via a TCP
                         socket connection. `address` must be set.

                         ALE will not start a server automatically.

                         When this argument is not empty `project_root` must
                         be defined.

                         `language` can be defined to describe the language
                         for a file. The filetype will be used as the language
                         by default.

                         LSP linters handle diagnostics automatically, so
                         the `callback` argument must not be defined.

                         An optional `completion_filter` callback may be
                         defined for filtering completion results.

                         `initialization_options` may be defined to pass
                         initialization options to the LSP.

                         `lsp_config` may be defined to pass configuration
                         settings to the LSP.

  `address`                A |String| representing an address to connect to,
                         or a |Funcref| accepting a buffer number and
                         returning the |String|.

                         The result can be computed with |ale#command#Run()|.

                         This argument must only be set if the `lsp` argument
                         is set to `'socket'`.

  `project_root`           A |String| representing a path to the project for
                         the file being checked with the language server, or
                         a |Funcref| accepting a buffer number and returning
                         the |String|.

                         If an empty string is returned, the file will not be
                         checked at all.

                         This argument must only be set if the `lsp` argument
                         is also set to a non-empty string.

  `language`               A |String| representing the name of the language
                         being checked, or a |Funcref| accepting a buffer
                         number and returning the |String|. This string will
                         be sent to the LSP to tell it what type of language
                         is being checked.

                         If a language isn't provided, the language will
                         default to the value of the filetype given to
                         |ale#linter#Define|.

  `completion_filter`      A |String| or |Funcref| for a callback function
                         accepting a buffer number and a completion item.

                         The completion item will be a |Dictionary| following
                         the Language Server Protocol `CompletionItem`
                         interface as described in the specification,
                         available online here:
                         https://microsoft.github.io/language-server-protocol

  `aliases`                A |List| of aliases for the linter name.

                         This argument can be set with alternative names for
                         selecting the linter with |g:ale_linters|. This
                         setting can make it easier to guess the linter name
                         by offering a few alternatives.

  `initialization_options` A |Dictionary| of initialization options for LSPs,
                         or a |Funcref| for a callback function accepting
                         a buffer number and returning the |Dictionary|.

                         This will be fed (as JSON) to the LSP in the
                         initialize command.

  `lsp_config`             A |Dictionary| for configuring a language server,
                         or a |Funcref| for a callback function accepting
                         a buffer number and returning the |Dictionary|.

                         This will be fed (as JSON) to the LSP in the
                         workspace/didChangeConfiguration command.

  If temporary files or directories are created for commands run with
  `command`, then these temporary files or directories can be managed by ALE,
  for automatic deletion. See |ale#command#ManageFile()| and
  |ale#command#ManageDirectory| for more information.

                                                   *ale-command-format-strings*

  All command strings will be formatted for special character sequences.
  Any substring `%s` will be replaced with the full path to the current file
  being edited. This format option can be used to pass the exact filename
  being edited to a program.

  For example: >
  'command': 'eslint -f unix --stdin --stdin-filename %s'
<
  Any substring `%t` will be replaced with a path to a temporary file. Merely
  adding `%t` will cause ALE to create a temporary file containing the
  contents of the buffer being checked. All occurrences of `%t` in command
  strings will reference the one temporary file. The temporary file will be
  created inside a temporary directory, and the entire temporary directory
  will be automatically deleted, following the behaviour of
  |ale#command#ManageDirectory|. This option can be used for some linters which
  do not support reading from stdin.

  For example: >
  'command': 'ghc -fno-code -v0 %t',
<
  Any substring `%e` will be replaced with the escaped executable supplied
  with `executable`. This provides a convenient way to define a command string
  which needs to include a dynamic executable name, but which is otherwise
  static.

  For example: >
  'command': '%e --some-argument',
<
  The character sequence `%%` can be used to emit a literal `%` into a
  command, so literal character sequences `%s` and `%t` can be escaped by
  using `%%s` and `%%t` instead, etc.

  If a callback for a command generates part of a command string which might
  possibly contain `%%`, `%s`, `%t`, or `%e`, where the special formatting
  behavior is not desired, the |ale#command#EscapeCommandPart()| function can
  be used to replace those characters to avoid formatting issues.

                                                  *ale-linter-loading-behavior*
                                                 *ale-linter-loading-behaviour*

  Linters for ALE will be loaded by searching |runtimepath| in the following
  format: >

  ale_linters/<filetype>/<linter_name>.vim
<
  Any linters which exist anywhere in |runtimepath| with that directory
  structure will be automatically loaded for the matching |filetype|. Filetypes
  containing `.` characters will be split into individual parts, and files
  will be loaded for each filetype between the `.` characters.

  Linters can be defined from vimrc and other files as long as this function
  is loaded first. For example, the following code will define a Hello World
  linter in vimrc in Vim 8: >

  " Plugins have to be loaded first.
  " If you are using a plugin manager, run that first.
  packloadall

  call ale#linter#Define('vim', {
  \   'name': 'echo-test',
  \   'executable': 'echo',
  \   'command': 'echo hello world',
  \   'callback': {buffer, lines -> map(lines, '{"text": v:val, "lnum": 1}')},
  \})
<

ale#linter#Get(filetype)                                     *ale#linter#Get()*

  Return all of linters configured for a given filetype as a |List| of
  |Dictionary| values in the format specified by |ale#linter#Define()|.

  Filetypes may be dot-separated to invoke linters for multiple filetypes:
  for instance, the filetype `javascript.jsx` will return linters for both the
  `javascript` and `jsx` filetype.

  Aliases may be defined in as described in |g:ale_linter_aliases|. Aliases
  are applied after dot-separated filetypes are broken up into their
  components.


ale#linter#PreventLoading(filetype)               *ale#linter#PreventLoading()*

  Given a `filetype`, prevent any more linters from being loaded from
  |runtimepath| for that filetype. This function can be called from vimrc or
  similar to prevent ALE from loading linters.


ale#lsp_linter#SendRequest(buffer, linter_name, message, [Handler])
                                                 *ale#lsp_linter#SendRequest()*

  Send a custom request to an LSP linter. The arguments are defined as
  follows:

  `buffer`       A valid buffer number.

  `linter_name`  A |String| identifying an LSP linter that is available and
                 enabled for the |filetype| of `buffer`.

  `message`      A |List| in the form `[is_notification, method, parameters]`,
                 containing three elements:
                 `is_notification` - an |Integer| that has value 1 if the
                   request is a notification, 0 otherwise;
                 `method` - a |String|, identifying an LSP method supported
                   by `linter`;
                 `parameters` - a |dictionary| of LSP parameters that are
                   applicable to `method`.

  `Handler`      Optional argument, meaningful only when `message[0]` is 0.
                 A |Funcref| that is called when a response to the request is
                 received, and takes as unique argument a dictionary
                 representing the response obtained from the server.


ale#other_source#ShowResults(buffer, linter_name, loclist)
                                               *ale#other_source#ShowResults()*

  Show results from another source of information.

  `buffer` must be a valid buffer number, and `linter_name` must be a unique
  name for identifying another source of information. The `loclist` given
  where the problems in a buffer are, and should be provided in the format ALE
  uses for regular linter results. See |ale-loclist-format|.


ale#other_source#StartChecking(buffer, linter_name)
                                             *ale#other_source#StartChecking()*

  Tell ALE that another source of information has started checking a buffer.

  `buffer` must be a valid buffer number, and `linter_name` must be a unique
  name for identifying another source of information.


ale#statusline#Count(buffer)                           *ale#statusline#Count()*

  Given the number of a buffer which may have problems, return a |Dictionary|
  containing information about the number of problems detected by ALE. The
  following keys are supported:

  `error`         -> The number of problems with type `E` and `sub_type != 'style'`
  `warning`       -> The number of problems with type `W` and `sub_type != 'style'`
  `info`          -> The number of problems with type `I`
  `style_error`   -> The number of problems with type `E` and `sub_type == 'style'`
  `style_warning` -> The number of problems with type `W` and `sub_type == 'style'`
  `total`         -> The total number of problems.


ale#statusline#FirstProblem(buffer, type)       *ale#statusline#FirstProblem()*

  Returns a copy of the first entry in the `loclist` that matches the supplied
  buffer number and problem type. If there is no such entry, an empty dictionary
  is returned.
  Problem type should be one of the strings listed below:

  `error`         -> Returns the first `loclist` item with type `E` and
                     `sub_type != 'style'`
  `warning`       -> First item with type `W` and `sub_type != 'style'`
  `info`          -> First item with type `I`
  `style_error`   -> First item with type `E` and `sub_type == 'style'`
  `style_warning` -> First item with type `W` and `sub_type == 'style'`


b:ale_linted                                                     *b:ale_linted*

  `b:ale_linted` is set to the number of times a buffer has been checked by
  ALE after all linters for one lint cycle have finished checking a buffer.
  This variable may not be defined until ALE first checks a buffer, so it
  should be accessed with |get()| or |getbufvar()|. For example: >

    " Print a message indicating how many times ALE has checked this buffer.
    echo 'ALE has checked this buffer ' . get(b:, 'ale_linted') . ' time(s).'
    " Print 'checked' using getbufvar() if a buffer has been checked.
    echo getbufvar(bufnr(''), 'ale_linted', 0) > 0 ? 'checked' : 'not checked'
<

g:ale_want_results_buffer                           *g:ale_want_results_buffer*

  `g:ale_want_results_buffer` is set to the number of the buffer being checked
  when the |ALEWantResults| event is signaled. This variable should be read to
  figure out which buffer other sources should lint.


ALELintPre                                                 *ALELintPre-autocmd*
                                                                   *ALELintPre*
ALELintPost                                               *ALELintPost-autocmd*
                                                                  *ALELintPost*
ALEFixPre                                                   *ALEFixPre-autocmd*
                                                                    *ALEFixPre*
ALEFixPost                                                 *ALEFixPost-autocmd*
                                                                   *ALEFixPost*

  These |User| autocommands are triggered before and after every lint or fix
  cycle. They can be used to update statuslines, send notifications, etc.
  The autocmd commands are run with |:silent|, so |:unsilent| is required for
  echoing messges.

  For example to change the color of the statusline while the linter is
  running:
>
    augroup ALEProgress
        autocmd!
        autocmd User ALELintPre  hi Statusline ctermfg=darkgrey
        autocmd User ALELintPost hi Statusline ctermfg=NONE
    augroup END
<
  Or to display the progress in the statusline:
>
    let s:ale_running = 0
    let l:stl .= '%{s:ale_running ? "[linting]" : ""}'
    augroup ALEProgress
        autocmd!
        autocmd User ALELintPre  let s:ale_running = 1 | redrawstatus
        autocmd User ALELintPost let s:ale_running = 0 | redrawstatus
    augroup END

<
ALEJobStarted                                           *ALEJobStarted-autocmd*
                                                                *ALEJobStarted*

  This |User| autocommand is triggered immediately after a job is successfully
  run. This provides better accuracy for checking linter status with
  |ale#engine#IsCheckingBuffer()| over |ALELintPre-autocmd|, which is actually
  triggered before any linters are executed.


ALEWantResults                                         *ALEWantResults-autocmd*
                                                               *ALEWantResults*

  This |User| autocommand is triggered before ALE begins a lint cycle. Another
  source can respond by calling |ale#other_source#StartChecking()|, and
  |ALELintPre| will be signaled thereafter, to allow other plugins to know
  that another source is checking the buffer.

  |g:ale_want_results_buffer| will be set to the number for a buffer being
  checked when the event is signaled, and deleted after the event is done.
  This variable should be read to know which buffer to check.

  Other plugins can use this event to start checking buffers when ALE events
  for checking buffers are triggered.


===============================================================================
10. Special Thanks                                         *ale-special-thanks*

Special thanks to Mark Grealish (https://www.bhalash.com/) for providing ALE's
snazzy looking ale glass logo. Cheers, Mark!

===============================================================================
11. Contact                                                       *ale-contact*

If you like this plugin, and wish to get in touch, check out the GitHub
page for issues and more at https://github.com/dense-analysis/ale

If you wish to contact the author of this plugin directly, please feel
free to send an email to devw0rp@gmail.com.

Please drink responsibly, or not at all, which is ironically the preference
of w0rp, who is teetotal.

===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: