forked from Iron-E/nvim-highlite
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhighlite.vim
880 lines (746 loc) · 27.6 KB
/
highlite.vim
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
lua << EOF
-- This file should be edited by the user. Read the instructions of each section and then edit them as desired.
--[[ Highlite, a Neovim colorscheme template.
* Author: Iron-E (https://github.com/Iron-E)
* Repository: https://github.com/nvim-highlite
Initially forked from vim-rnb, a Vim colorsheme template:
* Author: Romain Lafourcade (https://github.com/romainl)
* Canonical URL: https://github.com/romainl/vim-rnb
]]
--[[ Introduction
This template is designed to help Neovim users create their own colorschemes without much effort.
You will not need any additional tooling to run this file. Just open it in Neovim and follow the instructions.
The process is divided in five steps:
1. Rename the template,
2. Edit your colorscheme's information,
3. Define your colors,
4. Define your highlight groups and links, and
5. Sourcing your colorscheme.
]]
--[[ Step 1: Renaming
* If this file is distributed with a colorscheme it's probably already named correctly
and you can skip this step.
* If you forked/cloned/copied this repository to create your own colorscheme, you will have to
rename this template to match the name of your colorscheme.
NOTE: Neovim doesn't really care about whitespace in the name of the colorscheme but it does for
filenames so make sure your filename doesn't have any whitespace character.
| colorscheme name | module name | template filename |
|:-----------------:|:-----------:|:-----------------:|
| foobar | foobar | foobar.lua |
| foo-bar | foo_bar | foo_bar.lua |
| foo bar | foo_bar | foo_bar.lua |
| foo_bar | foo_bar | foo_bar.lua |
Rename the following files:
* `colors/highlite.vim`
* `lua/highlite.lua`
Where 'highlite' is the name of your colorscheme.
TIP: If you are on a Unix-based system (or have WSL on Windows) you can use the setup script at the root of this repo.
See the README for more details.
]]
--[[ Step 2: Information
In this step you will define information that helps Neovim process:
1. How users access your colorscheme;
2. How your colorscheme should be rendered.
]]
-- This is the name of your colorscheme which will be used as per |g:colors_name|.
vim.g.colors_name = 'highlite'
--[[ Step 3: Colors
Next you will define all of the colors that you will use for the color scheme.
Each one should be made up of three parts:
```lua
<color name> = { -- Give each color a distinctive name.
'#<hex color code>', -- Hexadecimal color used in GVim/MacVim or 'NONE'.
<16-bit color code>, -- Integer 0–255 used by terminals supporting 256 colors or 'NONE'.
'<ANSI color name>' -- color name used by less capable color terminals, can be 'darkred',
'red', 'darkgreen', 'green', 'darkyellow', 'yellow', 'darkblue',
'blue', 'darkmagenta', 'magenta', 'black', 'darkgrey', 'grey',
'white', or 'NONE'
}
```
If your colors are defined correctly, the resulting colorscheme is guaranteed
to work in GVim (Windows/Linux), MacVim (MacOS), and any properly set up terminal emulator.
NOTE: |Replace-mode| will probably be useful here.
]]
local black = {'#202020', 0, 'black'}
local gray = {'#808080', 244, 'gray'}
local gray_dark = {'#353535', 236, 'darkgrey'}
local gray_darker = {'#505050', 244, 'gray'}
local gray_light = {'#c0c0c0', 251, 'gray'}
local white = {'#ffffff', 15, 'white'}
local tan = {'#f4c069', 180, 'darkyellow'}
local red = {'#ee4a59', 196, 'red'}
local red_dark = {'#a80000', 124, 'darkred'}
local red_light = {'#ff4090', 203, 'red'}
local orange = {'#ff8900', 208, 'darkyellow'}
local orange_light = {'#f0af00', 214, 'yellow'}
local yellow = {'#f0df33', 220, 'yellow'}
local green_dark = {'#50de60', 83, 'darkgreen'}
local green = {'#77ff00', 72, 'green'}
local green_light = {'#a0ff70', 72, 'green'}
local blue = {'#7090ff', 63, 'darkblue'}
local cyan = {'#33efff', 87, 'cyan'}
local ice = {'#49a0f0', 63, 'cyan'}
local teal = {'#00d0c0', 38, 'cyan'}
local turqoise = {'#2bff99', 33, 'blue'}
local magenta = {'#d5508f', 126, 'magenta'}
local magenta_dark = {'#bb0099', 126, 'darkmagenta'}
local pink = {'#ffa6ff', 162, 'magenta'}
local pink_light = {'#ffb7b7', 38, 'white'}
local purple = {'#cf55f0', 129, 'magenta'}
local purple_light = {'#af60af', 63, 'magenta'}
--[[ Step 4: highlights
You can define highlight groups like this:
```lua
<highlight group name> = {
-- The color for the background, `NONE`, `FG` or `BG`
bg = <color>,
-- The color for the foreground, `NONE`, `FG` or `BG`
fg = <color>
-- The |highlight-blend| value, if one is desired.
[, blend = <integer>]
-- Style can be 'bold', 'italic', and more. See |attr-list| for more information.
-- It can also have a color, and/or multiple <cterm>s.
[, style = <cterm>|{<cterm> (, <cterm>) [color=<color>]} ]
}
```
You can also link one highlight group to another:
```lua
<highlight group name> = '<highlight group name>'
```
____________________________________________________________________________
Here is an example to define `SpellBad` and then link some new group
`SpellWorse` to it:
```lua
SpellBad = { -- ← name of the highlight group
bg=NONE, -- background color
fg=red, -- foureground color
style={ -- the style
'undercurl', -- undercurl (squiggly line)
color=red -- the color of the undercurl
}
},
SpellWorse = 'SpellBad'
```
If you weren't satisfied with undercurl, and also wanted another effect, you can
add another one below 'undercurl' and it will be applied as well:
```lua
SpellBad = { -- ← name of the highlight group
bg=NONE, -- background color
fg=red, -- foureground color
style={ -- the style
'undercurl', -- undercurl (squiggly line)
'standout'
color=red -- the color of the undercurl
}
}
```
____________________________________________________________________________
If you want to create a colorscheme that is responsive to the user's
'background' setting, you can specify special `light` and `dark` keys to
define how each group should be highlighted in each case.
```lua
SpellBad = {
bg=NONE,
dark={fg=white},
light={fg=black},
style={'undercurl', color=red}
}
```
Whenever the user changes their 'background' setting, the settings inside of
whichever key is relevant will be loaded.
____________________________________________________________________________
You can add any custom highlight group to the standard list below but you
shouldn't remove any if you want a working colorscheme. Most of them are
described under |highlight-default|, some from |group-name|, and others from
common syntax groups. Both help sections are good reads.
____________________________________________________________________________
If you want to inherit a specific attribute of another highlight group, you
can do the following:
```lua
SpellBad = function(self)
local inherited_style = self.SpellRare.style
inherited_style.color = red
return {
bg=NONE,
fg=NONE,
style=inherited_style
}
end
```
The function will be executed by |highlite| and transformed into the
expected result.
____________________________________________________________________________
NOTE: |Replace-mode| will probably be useful here.
NOTE: /As long as you do not remove any highlight groups or colors/, you can
safely ignore any highlight groups that are `link`ed to others.
For example, programming languages almost exclusively link to the 1st
and 2nd sections, so as long as you define everything there you will
automatically be defining the rest of the highlights, which is one of
the benefits of using this template.
]]
--[[ DO NOT EDIT `BG` NOR `FG`. ]]
local BG = 'bg'
local FG = 'fg'
--[[ These are the ones you should edit. ]]
-- This is the only highlight that must be defined separately.
local highlight_group_normal = {fg=gray_light, bg=black}
-- This is where the rest of your highlights should go.
local highlight_groups = {
--[[ 4.1. Text Analysis ]]
Comment = {fg=gray, style='italic'},
NonText = {fg=gray_darker},
EndOfBuffer = 'NonText',
Whitespace = 'NonText',
--[[ 4.1.1. Literals]]
Constant = {fg=orange_light},
String = {fg=green},
Character = {fg=red_light},
Number = {fg=pink_light},
Boolean = {fg=yellow},
Float = 'Number',
--[[ 4.1.2. Identifiers]]
Identifier = {fg=FG},
Function = {fg=purple},
--[[ 4.1.3. Syntax]]
Statement = {fg=ice},
Conditional = {fg=ice, style='italic'},
Repeat = {fg=turqoise, style='bold'},
Label = {fg=pink, style='italic'},
Operator = {fg=green_dark},
Keyword = {fg=teal},
Exception = {fg=red_light, style='bold'},
Noise = 'Delimiter',
--[[ 4.1.4. Metatextual Information]]
PreProc = {fg=tan},
Include = {fg=green_light, style='nocombine'},
Define = {fg=blue, style='nocombine'},
Macro = {fg=blue, style='italic'},
PreCondit = {fg=tan, style='italic'},
--[[ 4.1.5. Semantics]]
Type = {fg=cyan},
StorageClass = {fg=orange_light, style='bold'},
Structure = {fg=blue, style='bold'},
Typedef = {fg=cyan, style='italic'},
--[[ 4.1.6. Edge Cases]]
Special = {fg=magenta, style='bold'},
SpecialChar = {fg=red_light, style='italic'},
SpecialKey = 'Character',
Tag = 'Underlined',
Delimiter = {fg=white},
SpecialComment = {fg=gray, style={'bold', 'nocombine'}},
Debug = 'WarningMsg',
--[[ 4.1.7. Help Syntax]]
Underlined = {fg=turqoise, style='underline'},
Ignore = {fg=gray},
Error = {fg=white, bg=red_dark, style='bold'},
Todo = {fg=yellow, style={'bold', 'underline'}},
helpHyperTextJump = 'Underlined',
helpSpecial = 'Function',
Hint = {fg=black, bg=magenta, style='bold'},
Info = function(self) return {fg=self.Hint.fg, bg=pink_light, style=self.Hint.style} end,
Warning = function(self) return {fg=self.Hint.fg, bg=orange, style=self.Hint.style} end,
--[[ 4.2... Editor UI ]]
--[[ 4.2.1. Status Line]]
StatusLine = {fg=green_light, bg=gray_darker},
StatusLineNC = function(self) return {fg=gray, bg=self.StatusLine.bg} end,
StatusLineTerm = 'StatusLine',
StatusLineTermNC = 'StatusLineNC',
--[[ 4.2.2. Separators]]
VertSplit = {fg=white},
TabLine = {fg=FG, bg=gray_darker},
TabLineFill = {fg=gray_darker, bg=black},
TabLineSel = {fg=FG, bg=BG},
Title = {style='bold'},
--[[ 4.2.3. Conditional Line Highlighting]]
Conceal = 'NonText',
CursorLine = {bg=gray_dark},
CursorLineNr = function(self) return {fg=pink, bg=self.CursorLine.bg} end,
debugBreakpoint = 'ErrorMsg',
debugPC = 'ColorColumn',
LineNr = {fg=gray},
QuickFixLine = {bg=gray_darker},
Visual = {style='inverse'},
VisualNOS = {bg=gray_darker},
--[[ 4.2.4. Popup Menu]]
Pmenu = {fg=FG, bg=gray_dark},
PmenuSbar = {bg=black},
PmenuSel = {fg=FG},
PmenuThumb = {bg=white},
WildMenu = 'PmenuSel',
--[[ 4.2.5. Folds]]
FoldColumn = {bg=gray_darker, style='bold'},
Folded = {fg=black, bg=purple_light, style='italic'},
--[[ 4.2.6. Diffs]]
DiffAdd = {fg=black, bg=green_dark},
DiffChange = {},
DiffDelete = function(self) return {fg=self.DiffAdd.fg, bg=red} end,
DiffText = function(self) return {fg=self.DiffAdd.fg, bg=yellow} end,
--[[ 4.2.7. Searching]]
IncSearch = {style='inverse'},
Search = {style={'underline', color=white}},
MatchParen = {fg=green, style={'bold', 'underline'}},
--[[ 4.2.8. Spelling]]
SpellBad = {style={'undercurl', color=red}},
SpellCap = {style={'undercurl', color=yellow}},
SpellLocal = {style={'undercurl', color=green}},
SpellRare = {style={'undercurl', color=orange}},
--[[ 4.2.9. Conditional Column Highlighting]]
ColorColumn = {style='inverse'},
SignColumn = {},
--[[ 4.2.10. Messages]]
ErrorMsg = {fg=red, style='bold'},
HintMsg = {fg=magenta, style='bold'},
InfoMsg = {fg=pink_light, style='bold'},
ModeMsg = {fg=yellow},
WarningMsg = {fg=orange, style='bold'},
Question = {fg=orange_light, style='underline'},
--[[ 4.2.11. LSP ]]
LspDiagnosticsDefaultError = 'Error',
LspDiagnosticsFloatingError = 'ErrorMsg',
LspDiagnosticsSignError = 'LspDiagnosticsFloatingError',
LspDiagnosticsDefaultWarning = 'Warning',
LspDiagnosticsFloatingWarning = 'WarningMsg',
LspDiagnosticsSignWarning = 'LspDiagnosticsFloatingWarning',
LspDiagnosticsDefaultHint = 'Hint',
LspDiagnosticsFloatingHint = 'HintMsg',
LspDiagnosticsSignHint = 'LspDiagnosticsFloatingHint',
LspDiagnosticsDefaultInformation = 'Info',
LspDiagnosticsFloatingInformation = 'InfoMsg',
LspDiagnosticsSignInformation = 'LspDiagnosticsFloatingInformation',
LspDiagnosticsUnderlineError = 'CocErrorHighlight',
LspDiagnosticsUnderlineHint = 'CocHintHighlight',
LspDiagnosticsUnderlineInfo = 'CocInfoHighlight',
LspDiagnosticsUnderlineWarning = 'CocWarningHighlight',
--[[ 4.2.12. Cursor ]]
Cursor = {style='inverse'},
CursorIM = 'Cursor',
CursorColumn = {bg=gray_dark},
--[[ 4.2.13. Misc ]]
Directory = {fg=ice, style='bold'},
--[[ 4.3. Programming Languages
Everything in this section is OPTIONAL. Feel free to remove everything
here if you don't want to define it, or add more if there's something
missing.
]]
--[[ 4.3.1. C ]]
cConstant = 'Constant',
cCustomClass = 'Type',
--[[ 4.3.2. C++ ]]
cppSTLexception = 'Exception',
cppSTLnamespace = 'String',
--[[ 4.3.3 C# ]]
csBraces = 'Delimiter',
csClass = 'Structure',
csClassType = 'Type',
csContextualStatement = 'Conditional',
csEndColon = 'Delimiter',
csGeneric = 'Typedef',
csInterpolation = 'Include',
csInterpolationDelimiter = 'SpecialChar',
csLogicSymbols = 'Operator',
csModifier = 'Keyword',
csNew = 'Operator',
csNewType = 'Type',
csParens = 'Delimiter',
csPreCondit = 'PreProc',
csRepeat = 'Repeat',
csStorage = 'StorageClass',
csUnspecifiedStatement = 'Statement',
csXmlTag = 'Define',
csXmlTagName = 'Define',
--[[ 4.3.4. CSS ]]
cssBraces = 'Delimiter',
cssProp = 'Keyword',
cssSelectorOp = 'Operator',
cssTagName = 'Type',
cssTagName = 'htmlTagName',
scssAmpersand = 'Special',
scssAttribute = 'Label',
scssBoolean = 'Boolean',
scssDefault = 'Keyword',
scssElse = 'PreCondit',
scssIf = 'PreCondit',
scssInclude = 'Include',
scssSelectorChar = 'Operator',
scssSelectorName = 'Identifier',
scssVariable = 'Define',
scssVariableAssignment = 'Operator',
--[[ 4.3.5. Dart ]]
dartLibrary = 'Statement',
--[[ 4.3.6. dot ]]
dotKeyChar = 'Character',
dotType = 'Type',
--[[ 4.3.7. Go ]]
goBlock = 'Delimiter',
goBoolean = 'Boolean',
goBuiltins = 'Operator',
goField = 'Identifier',
goFloat = 'Float',
goFormatSpecifier = 'Character',
goFunction = 'Function',
goFunctionCall = 'goFunction',
goFunctionReturn = {},
goMethodCall = 'goFunctionCall',
goParamType = 'goReceiverType',
goPointerOperator = 'SpecialChar',
goPredefinedIdentifiers = 'Constant',
goReceiver = 'goBlock',
goReceiverType = 'goTypeName',
goSimpleParams = 'goBlock',
goType = 'Type',
goTypeConstructor = 'goFunction',
goTypeName = 'Type',
goVarAssign = 'Identifier',
goVarDefs = 'goVarAssign',
--[[ 4.3.8. HTML ]]
htmlArg = 'Label',
htmlBold = {fg=gray_light, style='bold'},
htmlTitle = 'htmlBold',
htmlEndTag = 'htmlTag',
htmlH1 = 'markdownH1',
htmlH2 = 'markdownH2',
htmlH3 = 'markdownH3',
htmlH4 = 'markdownH4',
htmlH5 = 'markdownH5',
htmlH6 = 'markdownH6',
htmlItalic = {style='italic'},
htmlSpecialTagName = 'Keyword',
htmlTag = 'Special',
htmlTagN = 'Typedef',
htmlTagName = 'Type',
--[[ 4.3.9. Java ]]
javaClassDecl = 'Structure',
--[[ 4.3.10. JavaScript ]]
jsFuncBlock = 'Function',
jsObjectKey = 'Type',
jsReturn = 'Keyword',
jsVariableDef = 'Identifier',
--[[ 4.3.11. JSON ]]
jsonBraces = 'luaBraces',
jsonKeywordMatch = 'Operator',
jsonNull = 'Constant',
jsonQuote = 'Delimiter',
jsonString = 'String',
jsonStringSQError = 'Exception',
--[[ 4.3.12. Lua ]]
luaBraces = 'Structure',
luaBrackets = 'Delimiter',
luaBuiltin = 'Keyword',
luaComma = 'Delimiter',
luaFuncArgName = 'Identifier',
luaFuncCall = 'Function',
luaFuncId = 'luaNoise',
luaFuncKeyword = 'Type',
luaFuncName = 'Function',
luaFuncParens = 'Delimiter',
luaFuncTable = 'Structure',
luaLocal = 'Type',
luaNoise = 'Operator',
luaParens = 'Delimiter',
luaSpecialTable = 'StorageClass',
luaSpecialValue = 'Function',
--[[ 4.3.12. Make ]]
makeCommands = 'Statment',
makeSpecTarget = 'Type',
--[[ 4.3.13. Markdown ]]
markdownH1 = {fg=red, style='bold'},
markdownH2 = {fg=orange, style='bold'},
markdownH3 = {fg=yellow, style='bold'},
markdownH4 = {fg=green_dark, style='bold'},
markdownH5 = {fg=cyan, style='bold'},
markdownH6 = {fg=purple_light, style='bold'},
mkdBold = 'SpecialComment',
mkdCode = 'Keyword',
mkdCodeDelimiter = 'mkdBold',
mkdCodeStart = 'mkdCodeDelimiter',
mkdCodeEnd = 'mkdCodeStart',
mkdHeading = 'Delimiter',
mkdItalic = 'mkdBold',
mkdListItem = 'Special',
mkdRule = 'Underlined',
--[[ 4.3.20. Python ]]
pythonBrackets = 'Delimiter',
pythonBuiltinFunc = 'Operator',
pythonBuiltinObj = 'Type',
pythonBuiltinType = 'Type',
pythonClass = 'Structure',
pythonClassParameters = 'pythonParameters',
pythonDecorator = 'PreProc',
pythonDottedName = 'Identifier',
pythonError = 'Error',
pythonException = 'Exception',
pythonInclude = 'Include',
pythonIndentError = 'pythonError',
pythonLambdaExpr = 'pythonOperator',
pythonOperator = 'Operator',
pythonParam = 'Identifier',
pythonParameters = 'Delimiter',
pythonSelf = 'Statement',
pythonSpaceError = 'pythonError',
pythonStatement = 'Statement',
--[[ 4.3.21. Ruby ]]
rubyClass = 'Structure',
rubyDefine = 'Define',
rubyInterpolationDelimiter = 'Delimiter',
--[[ 4.3.22. Rust ]]
rustKeyword = 'Keyword',
rustModPath = 'Include',
rustScopeDecl = 'Delimiter',
rustTrait = 'StorageClass',
--[[ 4.3.23. Scala ]]
scalaKeyword = 'Keyword',
scalaNameDefinition = 'Identifier',
--[[ 4.3.24. shell ]]
shDerefSimple = 'SpecialChar',
shFunctionKey = 'Function',
shLoop = 'Repeat',
shParen = 'Delimiter',
shQuote = 'Delimiter',
shSet = 'Statement',
shTestOpr = 'Debug',
--[[ 4.3.25. Solidity ]]
solBuiltinType = 'Type',
solContract = 'Typedef',
solContractName = 'Function',
--[[ 4.3.26. TOML ]]
tomlComment = 'Comment',
tomlKey = 'Label',
tomlTable = 'StorageClass',
--[[ 4.3.27. VimScript ]]
helpSpecial = 'Special',
vimFgBgAttrib = 'Constant',
vimHiCterm = 'Label',
vimHiCtermFgBg = 'vimHiCterm',
vimHiGroup = 'Typedef',
vimHiGui = 'vimHiCterm',
vimHiGuiFgBg = 'vimHiGui',
vimHiKeyList = 'Operator',
vimOption = 'Keyword',
vimScriptDelim = 'Ignore',
vimSet = 'String',
vimSetEqual = 'Operator',
vimSetSep = 'Delimiter',
--[[ 4.3.28. XML ]]
xmlAttrib = 'htmlArg',
xmlEndTag = 'xmlTag',
xmlEqual = 'Operator',
xmlTag = 'htmlTag',
xmlTagName = 'htmlTagName',
--[[ 4.3.29. SQL ]]
sqlKeyword = 'Keyword',
sqlParen = 'Delimiter',
sqlSpecial = 'Constant',
sqlStatement = 'Statement',
sqlParenFunc = 'Function',
--[[ 4.3.30. dos INI ]]
dosiniHeader = 'Title',
--[[ 4.3.31. Crontab ]]
crontabDay = 'StorageClass',
crontabDow = 'String',
crontabHr = 'Number',
crontabMin = 'Float',
crontabMnth = 'Structure',
--[[ 4.3.32. PlantUML ]]
plantumlColonLine = {},
--[[ 4.3.33. YAML ]]
yamlKey = 'Label',
--[[ 4.3.34. Git ]]
gitrebaseBreak = 'Keyword',
gitrebaseCommit = 'Tag',
gitrebaseDrop = 'Exception',
gitrebaseEdit = 'Define',
gitrebaseExec = 'PreProc',
gitrebaseFixup = 'gitrebaseSquash',
gitrebaseMerge = 'PreProc',
gitrebasePick = 'Include',
gitrebaseReset = 'gitrebaseLabel',
gitrebaseReword = 'gitrebasePick',
gitrebaseSquash = 'Macro',
gitrebaseSummary = 'Normal',
--[[ 4.3.35. Vimtex ]]
texMathGroup = 'Number',
texMathSub = 'Number',
texMathRegionX = 'Number',
texMathRegionY = 'Number',
--[[ 4.4. Plugins
Everything in this section is OPTIONAL. Feel free to remove everything
here if you don't want to define it, or add more if there's something
missing.
]]
--[[ 4.4.1. ALE ]]
ALEErrorSign = 'ErrorMsg',
ALEWarningSign = 'WarningMsg',
--[[ 4.4.2. coc.nvim ]]
CocErrorHighlight = {style={'undercurl', color='red'}},
CocHintHighlight = {style={'undercurl', color='magenta'}},
CocInfoHighlight = {style={'undercurl', color='pink_light'}},
CocWarningHighlight = {style={'undercurl', color='orange'}},
CocErrorSign = 'ALEErrorSign',
CocHintSign = 'HintMsg',
CocInfoSign = 'InfoMsg',
CocWarningSign = 'ALEWarningSign',
--[[ 4.4.2. vim-jumpmotion / vim-easymotion ]]
EasyMotion = 'IncSearch',
JumpMotion = 'EasyMotion',
--[[ 4.4.4. vim-gitgutter / vim-signify ]]
GitGutterAdd = {fg=green},
GitGutterChange = {fg=yellow},
GitGutterDelete = {fg=red},
GitGutterChangeDelete = {fg=orange},
SignifySignAdd = 'GitGutterAdd',
SignifySignChange = 'GitGutterChange',
SignifySignDelete = 'GitGutterDelete',
SignifySignChangeDelete = 'GitGutterChangeDelete',
--[[ 4.4.5. vim-indent-guides ]]
IndentGuidesOdd = {bg=gray_darker},
IndentGuidesEven = {bg=gray},
--[[ 4.4.7. NERDTree ]]
NERDTreeCWD = 'Label',
NERDTreeUp = 'Operator',
NERDTreeDir = 'Directory',
NERDTreeDirSlash = 'Delimiter',
NERDTreeOpenable = 'NERDTreeDir',
NERDTreeClosable = 'NERDTreeOpenable',
NERDTreeExecFile = 'Function',
NERDTreeLinkTarget = 'Tag',
--[[ 4.4.8. nvim-treesitter ]]
TSConstBuiltin = 'Constant',
TSConstructor = 'Typedef',
TSFuncBuiltin = 'Function',
TSStringEscape = 'Character',
TSStringRegex = 'SpecialChar',
TSURI = 'Tag',
TSVariableBuiltin = 'Identifier',
--[[ 4.4.9. barbar.nvim ]]
BufferCurrent = 'TabLineSel',
BufferCurrentMod = {fg=tan, bg=black, style='bold'},
BufferCurrentSign = 'HintMsg',
BufferCurrentTarget = 'BufferCurrentSign',
BufferInactive = 'BufferVisible',
BufferInactiveMod = 'BufferVisibleMod',
BufferInactiveSign = 'BufferVisibleSign',
BufferInactiveTarget = 'BufferVisibleTarget',
BufferTabpages = {fg=BG, bg=FG, style='bold'},
BufferTabpageFill = 'TabLineFill',
BufferVisible = 'TabLine',
BufferVisibleMod = {fg=white, bg=gray_darker, style='italic'},
BufferVisibleSign = 'BufferVisible',
BufferVisibleTarget = function(self)
local parent = self.BufferVisibleMod
return {fg=parent.fg, bg=parent.bg, style='bold'}
end,
--[[ 4.4.10. vim-sandwhich ]]
OperatorSandwichChange = 'DiffText',
}
--[[ Step 5: Terminal Colors
Define the color palette used by :terminal when in GUI Vim
or in TUI Vim when 'termguicolors' is enabled. If this list
is empty or if it doesn't contain exactly 16 items, the corresponding
Vim variable won't be set.
The expected values are colors defined in step 3.
Terminal emulators use a basic palette of 16 colors that can be
addressed by CLI and TUI tools via their name or their index, from
0 to 15. The list is not really standardized but it is generally
assumed to look like this:
| Index | Name |
|:------:|:-------------:|
| 1 | black |
| 2 | darkred |
| 3 | darkgreen |
| 4 | darkyellow |
| 5 | darkblue |
| 6 | darkmagenta |
| 7 | darkcyan |
| 8 | gray |
| 9 | darkgray |
| 10 | red |
| 11 | green |
| 12 | yellow |
| 13 | blue |
| 14 | magenta |
| 15 | cyan |
| 16 | white |
While you are certainly free to make colors 0 to 7 shades of blue,
this will inevitably cause usability issues so… be careful.
]]
local terminal_ansi_colors = {
[1] = black,
[2] = red_dark,
[3] = green_dark,
[4] = orange,
[5] = blue,
[6] = magenta_dark,
[7] = teal,
[8] = gray,
[9] = gray_dark,
[10] = red,
[11] = green,
[12] = yellow,
[13] = turqoise,
[14] = purple,
[15] = cyan,
[16] = gray_light
}
--[[ Step 5: Sourcing
When you wish to load your colorscheme, simply add this folder with a plugin manager
and then use `colorscheme <your colorscheme name>`. For example, in my configuration,
I source highlite by using `colorscheme highlite`.
These online resources can help you design your colorscheme:
1. the xterm palette.
* http://upload.wikimedia.org/wikipedia/en/1/15/Xterm_256color_chart.svg
2. play with hexadecimal colors right in the address bar (currently down).
* http://whatcolor.herokuapp.com/
3. similar concept, fuzzier implementation.
* http://color.hailpixel.com/
4. similar concept, fancier implementation.
* http://colourco.de/
5. extract a palette from an image.
* http://www.colr.org/
6. search for 'word', get images and color palettes.
* http://colores.manugarri.com/
7. user-created palettes.
* http://www.colourlovers.com/palettes
8. a no-nonsense colorscheme generator.
* http://www.pluaang.dk/color+scheme/
9. Adobe's fancy colorscheme generator.
* https://color.adobe.com/
10. The classic 'Color Scheme Designer', rebranded.
* http://paletton.com/
11. A very smart palette generator.
* http://vrl.cs.brown.edu/color
12. 'I Made My Own Colour Scheme and You Can Too!'.
* https://cmcenroe.me/2018/04/03/colour-scheme.html
A few things to note:
* The Windows console (`cmd`) is limited to the 16 so-called 'ANSI' colors but it used to
have a few of them interverted which makes numbers impractical. Use color names
instead of numbers: :help cterm-colors
* The Windows console doesn't do italics, underlines or bolded text;
it is limited to normal and reverse. Keep that in mind if you want
your colorscheme to be usable in as many environments as possible by as many
people as possible.
* The Windows TERMINAL, however, is capable of more.
* All of the terminal emulators in use these days allow their users to
change the 16 so-called 'ANSI' colors. It is also possible on some platforms
to change some or all of the 256 colors in the xterm palette. Don't take
anything for granted.
* When used against a light background, strong colors work better than muted
ones. Light or dark doesn't really matters. Also, it is harder to discriminate
between two similar colors on a light background.
* Both strong and muted colors work well against a dark background. It is also
easier to work with similar colors, but dark colors don't work at all.
* Use as many text samples as possible. String-heavy languages may look completely
different than keyword-heavy ones. This can have an impact on the usability
of your colorscheme.
* Most terminal emulators and terminal multiplexers currently in use on unix-like
systems support 256 colors but they almost always default to a '$TERM' that tells
Vim otherwise. Your users will need to make sure their terminal emulator/multiplexer
is correctly set up if they want to enjoy the best possible experience.
]]
require(vim.g.colors_name)(
highlight_group_normal,
highlight_groups,
terminal_ansi_colors
)
-- Thanks to Romain Lafourcade (https://github.com/romainl) for the original template (romainl/vim-rnb).
-- vim: ft=lua
EOF