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
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2023-07-20 Thu 06:39 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Surgot's Emacs Config</title>
<meta name="author" content="Biswakalyan Bhuyan" />
<meta name="generator" content="Org Mode" />
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
</head>
<body>
<div id="content" class="content">
<h1 class="title">Surgot's Emacs Config</h1>
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orgf6dcdf8">1. Introduction</a></li>
<li><a href="#org59da744">2. Installation</a></li>
<li><a href="#org5b90f55">3. Package Management</a>
<ul>
<li><a href="#orgd2b8c09">3.1. Melpa</a></li>
<li><a href="#orgc5932a3">3.2. Package Manager</a></li>
</ul>
</li>
<li><a href="#org9ca53b4">4. Better Appearance</a>
<ul>
<li><a href="#org3920b51">4.1. Basic Interface Settings</a></li>
<li><a href="#orge47d4fe">4.2. Theme</a></li>
<li><a href="#orgc2e6f21">4.3. Font</a></li>
</ul>
</li>
<li><a href="#org4746cb6">5. Editing Features</a>
<ul>
<li><a href="#orga8def4a">5.1. Hungry Delete</a></li>
</ul>
</li>
<li><a href="#org87e08c7">6. Better Emacs</a>
<ul>
<li><a href="#orgc6d4c4d">6.1. Startup Screen (dashboard)</a></li>
<li><a href="#org3a4395e">6.2. Modeline (moodline)</a></li>
<li><a href="#org5ea4599">6.3. Command Menu</a>
<ul>
<li><a href="#org1edd4b9">6.3.1. Ido Mode</a></li>
<li><a href="#orgca8da2c">6.3.2. Smex</a></li>
</ul>
</li>
<li><a href="#orgb12bb91">6.4. Emacs Config</a>
<ul>
<li><a href="#orga22fc13">6.4.1. Custom Variables File</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org2e2f83e">7. IDE Features</a>
<ul>
<li><a href="#orgb654a69">7.1. Centaur Tabs</a></li>
<li><a href="#org4063589">7.2. Treemacs</a></li>
<li><a href="#org6d2ae3e">7.3. Highlight Indent Guides</a></li>
<li><a href="#org71f7a6f">7.4. Format all</a></li>
<li><a href="#orgfbf9523">7.5. Company</a></li>
<li><a href="#org23157df">7.6. Projectile</a></li>
</ul>
</li>
<li><a href="#org96b7de7">8. Advance IDE Features</a>
<ul>
<li><a href="#org56c5931">8.1. Emacs LSP</a>
<ul>
<li><a href="#org11b9e95">8.1.1. LSP Mode</a></li>
<li><a href="#orgdd531e6">8.1.2. LSP UI</a></li>
<li><a href="#orgd65d4a2">8.1.3. DAP mode</a></li>
</ul>
</li>
<li><a href="#org82f44b6">8.2. Languages</a>
<ul>
<li><a href="#orgea358ff">8.2.1. Web (html/css/js)</a></li>
<li><a href="#org4578442">8.2.2. Typescript</a></li>
<li><a href="#org0cac140">8.2.3. Python</a></li>
</ul>
</li>
<li><a href="#orgc6c236b">8.3. Git Integration</a></li>
</ul>
</li>
<li><a href="#org24d470b">9. Org Mode</a>
<ul>
<li><a href="#orgae6824e">9.1. Org Bullet</a></li>
<li><a href="#orgeb651ed">9.2. Org Agenda</a></li>
</ul>
</li>
<li><a href="#orge1abd94">10. Misc</a>
<ul>
<li><a href="#orgfadb0c8">10.1. Locales</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgf6dcdf8" class="outline-2">
<h2 id="orgf6dcdf8"><span class="section-number-2">1.</span> Introduction</h2>
<div class="outline-text-2" id="text-1">
<p>
This is an Elisp program that runs every time I start my Emacs editor. Some people also call it an <b>emacs config</b>. Why am I writing it under Org mode? <i>Literate Programming, Bitch</i>!
</p>
<ul class="org-ul">
<li><b>Author</b>: Biswakalyan Bhuyan</li>
<li><b>Created</b>: 26-10-2022</li>
<li><b>License</b>: <a href="./LICENSE">GNU General Public License (GPL)</a></li>
</ul>
<div id="orgc8bd451" class="figure">
<p><img src="https://imgs.xkcd.com/comics/real_programmers.png" alt="real_programmers.png" />
</p>
<p><span class="figure-number">Figure 1: </span>XKCD Emacs Comic</p>
</div>
</div>
</div>
<div id="outline-container-org59da744" class="outline-2">
<h2 id="org59da744"><span class="section-number-2">2.</span> Installation</h2>
<div class="outline-text-2" id="text-2">
<p>
You can use my Emacs config anytime; the installation is pretty simple.
</p>
<p class="verse">
<b>Note</b>: I won't suggest you use it without understanding the code.<br />
</p>
<ul class="org-ul">
<li>First, get rid of your <code>~/.emacs.d</code> and <code>~/.emacs</code>.</li>
<li>Run <code>git clone git@surgot.tech:emacs.d ~/.emacs.d</code></li>
<li>Open Emacs with fingers crossed!</li>
</ul>
</div>
</div>
<div id="outline-container-org5b90f55" class="outline-2">
<h2 id="org5b90f55"><span class="section-number-2">3.</span> Package Management</h2>
<div class="outline-text-2" id="text-3">
<p>
Emacs is like an operating system; it is highly extensible. You can install new functionality by just installing a package, similar to how you do it in an OS. You can also configure these programs by changing some Elisp variables.
</p>
<p class="verse">
An average Emacs user can easily end up installing 100+ packages.<br />
</p>
</div>
<div id="outline-container-orgd2b8c09" class="outline-3">
<h3 id="orgd2b8c09"><span class="section-number-3">3.1.</span> Melpa</h3>
<div class="outline-text-3" id="text-3-1">
<ul class="org-ul">
<li><b>Reference</b>: <a href="https://www.melpa.org/">https://www.melpa.org/</a></li>
</ul>
<p>
By default, Emacs contains a limited number of package choices. This is why we need Melpa. It's a package repository for Emacs.
</p>
<p class="verse">
MELPA is an ELPA-compatible package repository that contains an enormous number of useful Emacs packages.<br />
</p>
<p>
Think of it like the VSCode Plugin Marketplace (eww).
</p>
<div class="org-src-container">
<pre class="src src-elisp">(require 'package)
(setq package-enable-at-startup nil)
(add-to-list 'package-archives
'("melpa" . "https://melpa.org/packages/"))
(package-initialize)
</pre>
</div>
</div>
</div>
<div id="outline-container-orgc5932a3" class="outline-3">
<h3 id="orgc5932a3"><span class="section-number-3">3.2.</span> Package Manager</h3>
<div class="outline-text-3" id="text-3-2">
<ul class="org-ul">
<li><i>Reference: <a href="https://jwiegley.github.io/use-package">https://jwiegley.github.io/use-package</a></i></li>
</ul>
<p>
The use-package macro allows you to isolate package configuration in your .emacs file in a way that is both performance-oriented and, well, tidy.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(unless (package-installed-p 'use-package)
(package-refresh-contents)
(package-install 'use-package))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org9ca53b4" class="outline-2">
<h2 id="org9ca53b4"><span class="section-number-2">4.</span> Better Appearance</h2>
<div class="outline-text-2" id="text-4">
</div>
<div id="outline-container-org3920b51" class="outline-3">
<h3 id="org3920b51"><span class="section-number-3">4.1.</span> Basic Interface Settings</h3>
<div class="outline-text-3" id="text-4-1">
<ul class="org-ul">
<li><p>
Disable dialog boxes:
This setting disables the display of dialog boxes, such as confirmation or warning pop-ups, in Emacs. It allows for a smoother and uninterrupted workflow.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(setq use-dialog-box nil)
</pre>
</div></li>
<li><p>
Disable file dialogs:
This setting disables the use of file selection dialogs in Emacs. Instead, Emacs will rely on command-line or programmatic methods for file operations.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(setq use-file-dialog nil)
</pre>
</div></li>
<li><p>
Disable backup files:
By setting this variable to `nil`, Emacs will not create backup files. This helps to avoid cluttering the file system with unnecessary backup copies.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(setq make-backup-files nil)
</pre>
</div></li>
<li><p>
Disable auto-save:
Auto-save automatically saves buffer contents periodically in case of unexpected Emacs or system crashes. However, if you prefer to disable this feature, you can set this variable to `nil`.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(setq auto-save-default nil)
</pre>
</div></li>
<li><p>
Hide menu bar:
This setting hides the menu bar in Emacs, providing more vertical space for your text and reducing visual distractions.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(menu-bar-mode -1)
</pre>
</div></li>
<li><p>
Hide tool bar:
This setting hides the tool bar, which contains various icons and shortcuts, in Emacs. It further maximizes the available space for editing and reduces clutter.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(tool-bar-mode -1)
</pre>
</div></li>
<li><p>
Hide fringes:
Fringes are the narrow areas on the left and right sides of the Emacs window. By disabling them, you can utilize the full width of the window for your text.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(fringe-mode -1)
</pre>
</div></li>
<li><p>
Hide scroll bar:
Emacs provides a scroll bar for navigating through the buffer. If you prefer a more minimalistic interface, you can hide the scroll bar with this setting.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(scroll-bar-mode -1)
</pre>
</div></li>
<li><p>
Enable subword navigation:
Subword navigation allows moving the cursor through CamelCase or snake<sub>case</sub> words more intelligently. This setting enables subword navigation globally in Emacs.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(global-subword-mode 1)
</pre>
</div></li>
<li><p>
Use y-or-n-p for prompts:
By default, Emacs prompts for user confirmation using 'yes' or 'no.' This setting changes it to use 'y' or 'n' for shorter and faster responses.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(defalias 'yes-or-no-p 'y-or-n-p)
</pre>
</div></li>
</ul>
</div>
</div>
<div id="outline-container-orge47d4fe" class="outline-3">
<h3 id="orge47d4fe"><span class="section-number-3">4.2.</span> Theme</h3>
<div class="outline-text-3" id="text-4-2">
<p>
The <code>ef-themes</code> package is an Emacs package that provides a collection of visually appealing themes for Emacs. It enhances the visual experience of Emacs by offering different color schemes and styles that can be applied to the editor.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp">(use-package ef-themes
:if window-system
:ensure t
:config
;; Enable the theme
(load-theme 'ef-winter t))
</pre>
</div>
</div>
</div>
<div id="outline-container-orgc2e6f21" class="outline-3">
<h3 id="orgc2e6f21"><span class="section-number-3">4.3.</span> Font</h3>
<div class="outline-text-3" id="text-4-3">
<p>
I love <code>JetBrains Mono</code>. Best for programming. Using it since 2018. Make sure to install it in your system. I use Arch, so I run <code>sudo pacman -S ttf-jetbrains-mono</code>.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(add-to-list 'default-frame-alist
'(font . "JetBrains Mono-14"))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org4746cb6" class="outline-2">
<h2 id="org4746cb6"><span class="section-number-2">5.</span> Editing Features</h2>
<div class="outline-text-2" id="text-5">
</div>
<div id="outline-container-orga8def4a" class="outline-3">
<h3 id="orga8def4a"><span class="section-number-3">5.1.</span> Hungry Delete</h3>
<div class="outline-text-3" id="text-5-1">
<ul class="org-ul">
<li><i>Reference: <a href="https://github.com/nflath/hungry-delete">https://github.com/nflath/hungry-delete</a></i></li>
</ul>
<p>
Hungry Delete is a minor-mode that causes deletion to delete all whitespace in the direction you are deleting. Works exactly like c-hungry-delete-mode, which is where the code was from. This just packages it up to be easier to use in other modes.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(use-package hungry-delete
:ensure t
:defer t
:config (global-hungry-delete-mode))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org87e08c7" class="outline-2">
<h2 id="org87e08c7"><span class="section-number-2">6.</span> Better Emacs</h2>
<div class="outline-text-2" id="text-6">
</div>
<div id="outline-container-orgc6d4c4d" class="outline-3">
<h3 id="orgc6d4c4d"><span class="section-number-3">6.1.</span> Startup Screen (dashboard)</h3>
<div class="outline-text-3" id="text-6-1">
<p>
The "emacs-dashboard" package elevates your Emacs startup experience by providing an extensible and customizable startup screen. It presents you with important information, such as recent files, project directories, and agenda items, in a visually appealing layout. With "emacs-dashboard," you can quickly access frequently used commands, navigate to recent projects, and stay organized, all while setting the right mood for your Emacs sessions.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/emacs-dashboard/emacs-dashboard">https://github.com/emacs-dashboard/emacs-dashboard</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package dashboard
:ensure t
:config
(dashboard-setup-startup-hook)
(setq dashboard-startup-banner "~/.emacs.d/avatar.png")
(setq dashboard-banner-logo-title "I am just a coder for fun"))
(setq inhibit-startup-screen t)
</pre>
</div>
</div>
</div>
<div id="outline-container-org3a4395e" class="outline-3">
<h3 id="org3a4395e"><span class="section-number-3">6.2.</span> Modeline (moodline)</h3>
<div class="outline-text-3" id="text-6-2">
<p>
"Mood-line" is an Emacs package that enhances the mode line, providing a visually appealing and informative display. It enriches your editing experience by showing essential details about the buffer, active modes, and other relevant information, all in a sleek and elegant format.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/jessiehildebrandt/mood-line">https://github.com/jessiehildebrandt/mood-line</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package mood-line
:ensure t
:if window-system
:init
(mood-line-mode))
</pre>
</div>
</div>
</div>
<div id="outline-container-org5ea4599" class="outline-3">
<h3 id="org5ea4599"><span class="section-number-3">6.3.</span> Command Menu</h3>
<div class="outline-text-3" id="text-6-3">
<p>
After pressing <code>M-x</code>, Emacs users see a prompt below; this prompt allows us to run any command within Emacs. This is what I loved about Emacs when I was learning it first. Almost anything, any functionality, any program, everything is a function, and I can access that function by just pressing <code>M-x</code>. But memorizing all these commands is hard, also typing it. Emacs does provide tab completion, but it sucks. So we are gonna pull up the Emacs magic and install some packages to make it better.
</p>
</div>
<div id="outline-container-org1edd4b9" class="outline-4">
<h4 id="org1edd4b9"><span class="section-number-4">6.3.1.</span> Ido Mode</h4>
<div class="outline-text-4" id="text-6-3-1">
<p>
The Ido package lets you switch between buffers and visit files and directories with a minimum of keystrokes. It is a superset of Iswitchb, the interactive buffer switching package by Stephen Eglen.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://www.emacswiki.org/emacs/InteractivelyDoThings">https://www.emacswiki.org/emacs/InteractivelyDoThings</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package ido-vertical-mode
:ensure t
:config
(setq ido-enable-flex-matching t)
(setq ido-everywhere t)
(setq ido-vertical-define-keys 'C-n-and-C-p-only)
:init
(ido-mode 1)
(ido-vertical-mode 1))
</pre>
</div>
</div>
</div>
<div id="outline-container-orgca8da2c" class="outline-4">
<h4 id="orgca8da2c"><span class="section-number-4">6.3.2.</span> Smex</h4>
<div class="outline-text-4" id="text-6-3-2">
<p>
Smex is an M-x enhancement for Emacs. Built on top of Ido, it provides a convenient interface to your recently and most frequently used commands. And to all the other commands, too.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/nonsequitur/smex">https://github.com/nonsequitur/smex</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package smex
:ensure t
:init (smex-initialize)
:bind
("M-x" . smex))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-orgb12bb91" class="outline-3">
<h3 id="orgb12bb91"><span class="section-number-3">6.4.</span> Emacs Config</h3>
<div class="outline-text-3" id="text-6-4">
</div>
<div id="outline-container-orga22fc13" class="outline-4">
<h4 id="orga22fc13"><span class="section-number-4">6.4.1.</span> Custom Variables File</h4>
<div class="outline-text-4" id="text-6-4-1">
<div class="org-src-container">
<pre class="src src-elisp">(setq custom-file (expand-file-name "custom.el" user-emacs-directory))
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="outline-container-org2e2f83e" class="outline-2">
<h2 id="org2e2f83e"><span class="section-number-2">7.</span> IDE Features</h2>
<div class="outline-text-2" id="text-7">
</div>
<div id="outline-container-orgb654a69" class="outline-3">
<h3 id="orgb654a69"><span class="section-number-3">7.1.</span> Centaur Tabs</h3>
<div class="outline-text-3" id="text-7-1">
<p>
Centaur Tabs is an Emacs package that enhances the tab bar functionality, providing a more visually appealing and user-friendly way to manage multiple open buffers (files) within the editor. It may offer features such as clickable tabs, grouping tabs based on projects or file types, tab previews, and convenient tab navigation options. For more detailed information about Centaur Tabs and its specific functionalities, it is recommended to refer to its documentation or source code repository.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/ema2159/centaur-tabs">https://github.com/ema2159/centaur-tabs</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package centaur-tabs
:if window-system
:demand
:init
;; Set the style to rounded with icons
(setq centaur-tabs-style "bar")
(setq centaur-tabs-set-icons t)
:config
;; Enable centaur-tabs
(centaur-tabs-mode t))
</pre>
</div>
</div>
</div>
<div id="outline-container-org4063589" class="outline-3">
<h3 id="org4063589"><span class="section-number-3">7.2.</span> Treemacs</h3>
<div class="outline-text-3" id="text-7-2">
<p>
"Treemacs" is an Emacs package that brings a tree-style file explorer directly into your Emacs workspace. With its intuitive and organized display, Treemacs allows you to navigate and manage files and directories effortlessly. It provides a visual representation of your project's structure, making it easy to switch between different files, directories, and buffers. Treemacs supports various project management features and integrates seamlessly with popular version control systems like Git. This powerful package enhances your Emacs workflow, making file management and project navigation a breeze.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/Alexander-Miller/treemacs">https://github.com/Alexander-Miller/treemacs</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package treemacs
:ensure t
:defer t
:bind
(("C-c t" . treemacs))
:config
(setq treemacs-width 30)
(setq-local mode-line-format nil))
</pre>
</div>
</div>
</div>
<div id="outline-container-org6d2ae3e" class="outline-3">
<h3 id="org6d2ae3e"><span class="section-number-3">7.3.</span> Highlight Indent Guides</h3>
<div class="outline-text-3" id="text-7-3">
<p>
The "highlight-indent-guides" package is an Emacs extension that enhances code readability by providing visual indent guides. As you work with code, it displays vertical lines at each level of indentation, making it easier to distinguish different blocks and understand the code's structure. This feature is particularly useful for languages with significant indentation, such as Python. "highlight-indent-guides" helps maintain consistent and well-organized code, ensuring a more pleasant coding experience in Emacs.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/DarthFennec/highlight-indent-guides">https://github.com/DarthFennec/highlight-indent-guides</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package highlight-indent-guides
:ensure t
:defer t
:hook (prog-mode . highlight-indent-guides-mode)
:config
(setq highlight-indent-guides-method 'character)
(setq highlight-indent-guides-character ?\|)
(setq highlight-indent-guides-responsive 'top))
</pre>
</div>
</div>
</div>
<div id="outline-container-org71f7a6f" class="outline-3">
<h3 id="org71f7a6f"><span class="section-number-3">7.4.</span> Format all</h3>
<div class="outline-text-3" id="text-7-4">
<p>
A "format all" package in Emacs typically aims to automate and simplify the process of formatting code in various programming languages. It offers a unified command to apply code formatting rules across the entire buffer or project, ensuring consistent code style. Such packages may support multiple programming languages and use popular code formatters (e.g., Prettier, Black, clang-format) to automatically reformat code according to predefined configurations. By using the "format all" package, Emacs users can save time and effort in maintaining clean and well-formatted code. For specific details on a particular "format all" package, users should refer to its documentation or repository.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/lassik/emacs-format-all-the-code">https://github.com/lassik/emacs-format-all-the-code</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package format-all
:ensure t)
</pre>
</div>
</div>
</div>
<div id="outline-container-orgfbf9523" class="outline-3">
<h3 id="orgfbf9523"><span class="section-number-3">7.5.</span> Company</h3>
<div class="outline-text-3" id="text-7-5">
<p>
Company mode in Emacs is a versatile and intelligent completion framework that enhances coding productivity by providing context-aware code suggestions. As you type, Company mode offers a list of potential completions based on the current context, language, and installed backends. It supports various programming languages and can integrate with external completion tools like LSP (Language Server Protocol) servers. With its seamless and customizable integration, Company mode enables faster and more accurate code writing, streamlining the coding process and making Emacs an efficient and powerful text editor for developers.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/company-mode/company-mode">https://github.com/company-mode/company-mode</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package company
:ensure t
:defer t
:config
(add-hook 'after-init-hook 'global-company-mode))
</pre>
</div>
</div>
</div>
<div id="outline-container-org23157df" class="outline-3">
<h3 id="org23157df"><span class="section-number-3">7.6.</span> Projectile</h3>
<div class="outline-text-3" id="text-7-6">
<p>
Projectile is a powerful project interaction library for Emacs that enhances project management and navigation. It provides a unified interface to work with multiple projects, enabling developers to switch between projects effortlessly, find files quickly, and execute project-specific commands with ease. Projectile indexes project files for speedy searches and supports various version control systems. With its intuitive keybindings and customizable behavior, Projectile simplifies project-related tasks and significantly improves productivity, making Emacs a more efficient and developer-friendly text editor for managing and working with projects of all sizes.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/bbatsov/projectile">https://github.com/bbatsov/projectile</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package projectile
:ensure t
:defer t
:config
;; Enable Projectile globally
(setq projectile-completion-system 'ido)
(setq ido-enable-flex-matching t)
(projectile-mode 1))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org96b7de7" class="outline-2">
<h2 id="org96b7de7"><span class="section-number-2">8.</span> Advance IDE Features</h2>
<div class="outline-text-2" id="text-8">
<p>
Emacs is a versatile tool that can serve as a writer's machine, enabling tasks like writing books, creating spreadsheets, and crafting theses, among other uses. Personally, I primarily utilize Emacs for programming, blogging, and journaling.
</p>
<p>
While I prefer a minimalist text editor with fewer distractions, I recognize the need for more robust IDE features, especially for larger projects involving frameworks. Auto-completion and type checking are indispensable in such scenarios. Therefore, I appreciate the flexibility of Emacs, as it allows me to tailor the environment to suit my various programming needs.
</p>
</div>
<div id="outline-container-org56c5931" class="outline-3">
<h3 id="org56c5931"><span class="section-number-3">8.1.</span> Emacs LSP</h3>
<div class="outline-text-3" id="text-8-1">
<p>
The "emacs-lsp" project is a collection of Emacs packages and tools that implement the Language Server Protocol (LSP) in Emacs. LSP is a standardized communication protocol that enables integration with language servers, which are external programs providing advanced code analysis and language-specific features.
</p>
<p>
The goal of the "emacs-lsp" project is to enhance the Emacs text editor and turn it into a powerful Integrated Development Environment (IDE) by leveraging the capabilities of language servers. These packages provide language-specific features such as autocompletion, real-time error checking, code navigation, and more. By adhering to the LSP, developers can use a consistent approach across various programming languages, streamlining their workflow and improving productivity.
</p>
<p>
The project offers a diverse range of packages, each tailored to specific programming languages and their corresponding language servers. This initiative fosters an integrated and standardized environment for Emacs users, enabling them to efficiently code in different languages and benefit from advanced language-specific tooling within their favorite text editor. The "emacs-lsp" project is a valuable resource for developers seeking a robust and unified coding experience in Emacs.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://emacs-lsp.github.io">https://emacs-lsp.github.io</a></i></li>
</ul>
</div>
<div id="outline-container-org11b9e95" class="outline-4">
<h4 id="org11b9e95"><span class="section-number-4">8.1.1.</span> LSP Mode</h4>
<div class="outline-text-4" id="text-8-1-1">
<p>
LSP mode (Language Server Protocol mode) in Emacs is a powerful extension that brings IDE-like capabilities to various programming languages. It provides integration with language servers, which are separate programs that offer advanced code analysis, autocompletion, and other language-specific features. LSP mode allows developers to benefit from a consistent development experience across different programming languages, eliminating the need for language-specific configurations and setups. With LSP mode, Emacs users can enjoy enhanced code navigation, error checking, and automatic code formatting, significantly improving their productivity and coding efficiency.
</p>
<div id="org42d6a90" class="figure">
<p><img src="https://emacs-lsp.github.io/lsp-mode/examples/completion.gif" alt="completion.gif" />
</p>
<p><span class="figure-number">Figure 2: </span>LSP mode completion</p>
</div>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/emacs-lsp/lsp-mode">https://github.com/emacs-lsp/lsp-mode</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package lsp-mode
:ensure t
:defer t
:init
(setq lsp-keymap-prefix "C-c l")
:config
(setq lsp-headerline-breadcrumb-enable nil))
</pre>
</div>
</div>
</div>
<div id="outline-container-orgdd531e6" class="outline-4">
<h4 id="orgdd531e6"><span class="section-number-4">8.1.2.</span> LSP UI</h4>
<div class="outline-text-4" id="text-8-1-2">
<p>
In Emacs, lsp-ui is a complementary extension to lsp-mode (Language Server Protocol mode). It enhances the Language Server Protocol experience by offering a user-friendly interface with features like real-time error checking, code actions, and code lenses. lsp-ui also enables convenient peeking into definitions and references. With lsp-ui, Emacs users can enjoy a more interactive and productive coding experience with language servers.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/emacs-lsp/lsp-ui">https://github.com/emacs-lsp/lsp-ui</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package lsp-ui
:ensure t
:defer t)
</pre>
</div>
</div>
</div>
<div id="outline-container-orgd65d4a2" class="outline-4">
<h4 id="orgd65d4a2"><span class="section-number-4">8.1.3.</span> DAP mode</h4>
<div class="outline-text-4" id="text-8-1-3">
<p>
DAP mode (Debug Adapter Protocol mode) in Emacs is an extension that provides a powerful debugging experience within the text editor. By leveraging the Debug Adapter Protocol, DAP mode enables seamless integration with debug servers, allowing developers to debug their programs efficiently. With DAP mode, users gain access to essential debugging features such as breakpoints, stepping through code, inspecting variables, and evaluating expressions. This extension facilitates a smooth and consistent debugging process across various programming languages, empowering developers to identify and resolve issues with ease, all within the familiar environment of Emacs.
</p>
<ul class="org-ul">
<li><i>Reference: <a href="https://github.com/emacs-lsp/dap-mode">https://github.com/emacs-lsp/dap-mode</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package dap-mode
:after lsp-mode
:ensure t
:defer t)
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org82f44b6" class="outline-3">
<h3 id="org82f44b6"><span class="section-number-3">8.2.</span> Languages</h3>
<div class="outline-text-3" id="text-8-2">
<p>
Now, we will configure language server protocol and other settings for each,
languages I work on, one by one.
</p>
</div>
<div id="outline-container-orgea358ff" class="outline-4">
<h4 id="orgea358ff"><span class="section-number-4">8.2.1.</span> Web (html/css/js)</h4>
<div class="outline-text-4" id="text-8-2-1">
</div>
<ol class="org-ol">
<li><a id="org3bf2a6c"></a>Web Mode<br />
<div class="outline-text-5" id="text-8-2-1-1">
<p>
Web Mode in Emacs is a major mode that enhances web development by providing specialized editing features for working with HTML, CSS, JavaScript, and other web-related languages. It intelligently handles nested tags, auto-closes HTML tags, and offers indentation and syntax highlighting tailored for web development. Web Mode also supports embedded templates and server-side code, making it a versatile tool for web developers to efficiently create and edit web pages and applications within the Emacs text editor.
</p>
<ul class="org-ul">
<li><i>Reference: <a href="https://web-mode.org">https://web-mode.org</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package web-mode
:ensure t
:defer t
:config
(setq
web-mode-markup-indent-offset 2
web-mode-css-indent-offset 2
web-mode-code-indent-offset 2
web-mode-style-padding 2
web-mode-script-padding 2
web-mode-enable-auto-closing t
web-mode-enable-auto-opening t
web-mode-enable-auto-pairing t
web-mode-enable-auto-indentation t)
:mode
(".html$" "*.php$" "*.tsx"))
</pre>
</div>
</div>
</li>
<li><a id="orgcb934cf"></a>Emmet-mode<br />
<div class="outline-text-5" id="text-8-2-1-2">
<p>
Emmet Mode in Emacs is an extension that significantly boosts web development productivity by enabling advanced HTML and CSS abbreviations. Originally inspired by the Emmet toolkit, this mode allows developers to write complex markup with ease using intuitive shortcuts and expand them into full HTML or CSS code. It supports dynamic placeholders, numeric repetition, and custom abbreviation expansion, making it a powerful tool for rapidly generating and editing HTML and CSS structures. With Emmet Mode, Emacs users can streamline their web development workflow, saving time and effort while maintaining clean and well-structured code.
</p>
<ul class="org-ul">
<li><i>Reference: <a href="https://https//github.com/smihica/emmet-mode">https://https//github.com/smihica/emmet-mode</a></i></li>
</ul>
<div id="orgfabacb1" class="figure">
<p><img src="https://www.philnewton.net/assets/blog/2015/08/emmet.gif" alt="emmet.gif" />
</p>
<p><span class="figure-number">Figure 3: </span>Emmet Mode Demo</p>
</div>
<div class="org-src-container">
<pre class="src src-elisp">(use-package emmet-mode
:ensure t
:defer t)
</pre>
</div>
</div>
</li>
</ol>
</div>
<div id="outline-container-org4578442" class="outline-4">
<h4 id="org4578442"><span class="section-number-4">8.2.2.</span> Typescript</h4>
<div class="outline-text-4" id="text-8-2-2">
</div>
<ol class="org-ol">
<li><a id="orgad86659"></a>Tide Mode<br />
<div class="outline-text-5" id="text-8-2-2-1">
<ul class="org-ul">
<li><i>Reference: <a href="https://github.com/ananthakumaran/tide">https://github.com/ananthakumaran/tide</a></i></li>
</ul>
<p>
TypeScript Interactive Development Environment for Emacs.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(use-package tide
:ensure t
:defer t
:config
(setq company-tooltip-align-annotations t)
(add-hook 'before-save-hook 'tide-format-before-save))
(add-hook 'typescript-mode-hook #'setup-tide-mode)
(defun setup-tide-mode ()
"Set up Tide mode."
(interactive)
(tide-setup)
(flycheck-mode +1)
(setq flycheck-check-syntax-automatically '(save-mode-enabled))
(eldoc-mode +1)
(tide-hl-identifier-mode +1)
(company-mode +1))
</pre>
</div>
</div>
</li>
<li><a id="orga22804d"></a>TSX<br />
<div class="outline-text-5" id="text-8-2-2-2">
<p>
Tide also support TSX, just need to enable web-mode with tsx files.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(add-hook 'web-mode-hook
(lambda ()
(when (string-equal "tsx" (file-name-extension buffer-file-name))
(setup-tide-mode))))
</pre>
</div>
</div>
</li>
</ol>
</div>
<div id="outline-container-org0cac140" class="outline-4">
<h4 id="org0cac140"><span class="section-number-4">8.2.3.</span> Python</h4>
<div class="outline-text-4" id="text-8-2-3">
</div>
<ol class="org-ol">
<li><a id="org82d77bf"></a>Language Server Protocol<br />
<div class="outline-text-6" id="text-8-2-3-0-1">
<ul class="org-ul">
<li><i>Reference: <a href="https://github.com/emacs-lsp/lsp-pyright">https://github.com/emacs-lsp/lsp-pyright</a></i></li>
</ul>
<p>
Pyright is a fast type checker meant for large Python source bases. It can run
in a “watch” mode and performs fast incremental updates when files are modified.
For python I decided to use pyright language server protocol.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(use-package lsp-pyright
:ensure t
:defer t
:hook (python-mode . (lambda ()
(setq indent-tabs-mode t)
(setq tab-width 4)
(setq python-indent-offset 4)
(company-mode 1)
(require 'lsp-pyright)
(pyvenv-autoload)
(lsp))))
</pre>
</div>
</div>
</li>
<li><a id="org457667b"></a>Virutal Environment<br />
<div class="outline-text-6" id="text-8-2-3-0-2">
<ul class="org-ul">
<li><i>Reference: <a href="https://github.com/jorgenschaefer/pyvenv">https://github.com/jorgenschaefer/pyvenv</a></i></li>
</ul>
<p>
This is a simple global minor mode which will replicate the changes done by
virtualenv activation inside Emacs, basically it helps me loading my python
virtualenv for IDE features like autocompletion.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(use-package pyvenv
:ensure t
:defer t)
</pre>
</div>
<p>
I use my self made elisp function, for automatically load python virtualenv,
I always use <code>env</code> dir as virtualenv inside project root. So everytime I open
<code>python-mode</code> (aka python file), it looks for any <code>env</code> dir and load the env.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(defun pyvenv-autoload ()
(require 'pyvenv)
(require 'projectile)
(interactive)
"auto activate venv directory if exists"
(f-traverse-upwards (lambda (path)
(let ((venv-path (f-expand "env" path)))
(when (f-exists? venv-path)
(pyvenv-activate venv-path))))))
(add-hook 'python-mode 'pyvenv-autoload)
</pre>
</div>
</div>
</li>
</ol>
</div>
</div>
<div id="outline-container-orgc6c236b" class="outline-3">
<h3 id="orgc6c236b"><span class="section-number-3">8.3.</span> Git Integration</h3>
<div class="outline-text-3" id="text-8-3">
<p>
I can't use git without <i>Magit</i>.
Magit is a complete text-based user interface to Git. It fills the glaring gap
between the Git command-line interface and various GUIs, letting you perform
trivial as well as elaborate version control tasks with just a couple of
mnemonic key presses. Magit looks like a prettified version of what you get
after running a few Git commands but in Magit every bit of visible information
is also actionable to an extent that goes far beyond what any Git GUI provides
and it takes care of automatically refreshing this output when it becomes
outdated. In the background Magit just runs Git commands and if you wish you
can see what exactly is being run, making it possible for you to learn the git
command-line by using Magit.
I ❤ Magit.
</p>
<ul class="org-ul">
<li><i>Reference: <a href="https://magit.vc">https://magit.vc</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package magit
:ensure t
:defer t)
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org24d470b" class="outline-2">
<h2 id="org24d470b"><span class="section-number-2">9.</span> Org Mode</h2>
<div class="outline-text-2" id="text-9">
<p>
Org Mode in Emacs is a powerful and versatile outlining and organizing tool that extends the text editor's capabilities beyond simple plain text. It provides a structured and hierarchical format for creating notes, to-do lists, project plans, and more. Org Mode offers features such as headings, lists, tables, tags, and timestamps, enabling users to manage complex information with ease. It supports exporting to various formats like HTML, PDF, and LaTeX, making it suitable for both personal organization and professional document preparation. With its extensive functionality and seamless integration with Emacs, Org Mode empowers users to efficiently manage tasks, maintain documentation, and stay organized in a clutter-free and efficient environment.
</p>
</div>
<div id="outline-container-orgae6824e" class="outline-3">
<h3 id="orgae6824e"><span class="section-number-3">9.1.</span> Org Bullet</h3>
<div class="outline-text-3" id="text-9-1">
<p>
Org Bullet is an Emacs package that enhances the visual appearance of Org Mode outlines by replacing plain text bullet points with custom symbols. It offers a variety of stylish bullets to represent different outline levels, making the organization of tasks and information more visually appealing and easier to comprehend. Org Bullet is highly configurable, allowing users to customize the bullet symbols to their preference and create a more visually pleasing and organized presentation of hierarchical data within Org Mode documents.
</p>
<ul class="org-ul">
<li><i>Reference - <a href="https://github.com/sabof/org-bullets">https://github.com/sabof/org-bullets</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(use-package org-bullets
:ensure t
:defer t
:config
(add-hook 'org-mode-hook (lambda () (org-bullets-mode 1))))
</pre>
</div>
</div>
</div>
<div id="outline-container-orgeb651ed" class="outline-3">
<h3 id="orgeb651ed"><span class="section-number-3">9.2.</span> Org Agenda</h3>
<div class="outline-text-3" id="text-9-2">
<p>
Org Agenda in Emacs is a powerful and flexible tool for managing tasks, appointments, and notes. It provides a dynamic view of scheduled events, deadlines, and TODO items from various Org Mode files, enabling users to organize and prioritize their work effectively. With its customizable views, filters, and sorting options, Org Agenda offers a comprehensive overview of upcoming events and pending tasks, making it an essential feature for staying organized and productive in Emacs.
</p>
<div class="org-src-container">
<pre class="src src-elisp">(setq org-agenda-files (append
(file-expand-wildcards "~/dox/org/*.org")))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-orge1abd94" class="outline-2">
<h2 id="orge1abd94"><span class="section-number-2">10.</span> Misc</h2>
<div class="outline-text-2" id="text-10">
<p>
Some extra setting, which doesn't fall in any category above.
</p>
</div>
<div id="outline-container-orgfadb0c8" class="outline-3">
<h3 id="orgfadb0c8"><span class="section-number-3">10.1.</span> Locales</h3>
<div class="outline-text-3" id="text-10-1">
<ul class="org-ul">
<li><i>Reference: <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Locales.html">https://www.gnu.org/software/emacs/manual/html_node/elisp/Locales.html</a></i></li>
</ul>
<div class="org-src-container">
<pre class="src src-elisp">(setq locale-coding-system 'utf-8)
(set-terminal-coding-system 'utf-8)
(set-keyboard-coding-system 'utf-8)
(set-selection-coding-system 'utf-8)
(prefer-coding-system 'utf-8)
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Biswakalyan Bhuyan</p>
<p class="date">Created: 2023-07-20 Thu 06:39</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>
|
