feat(semanticTokens)!: token highlight groups

CocSemType + type
CocSemTypeMod + type + modifier

doc/coc.txt

@@ -3353,7 +3353,6 @@ disable creation of these highlight groups.
 The highlight groups rules:
 >
 `CocSemType + type` for types
-`CocSemMod + modifier` for modifiers
 `CocSemTypeMode + type + modifier` for modifier with type
 <
 
@@ -3364,7 +3363,6 @@ You need create highlight groups for highlight other modifiers and/or specific
 modifier with type, for example:
 >
 	" Add highlights for declaration modifier
-	hi link CocSemModDeclaration Declaration
 	hi link CocSemTypeModClassDeclaration ClassDeclaration
 <
 The modifier highlight groups have higher priority.

history.md

@@ -2,7 +2,6 @@
 
 - Break change: semanticTokens highlight groups changed:
   - `CocSem + type` to `CocSemType + type`
-  - `CocSem + modifier` to `CocSemMod + modifier`
   - `CocSem + modifier + type` to `CocSemTypeMod + type + modifier`
 
 # 2023-09-02

plugin/coc.vim

@@ -588,7 +588,7 @@ function! s:Highlight() abort
         \ 'TypeDecorator': ['@symbol', 'Identifier'],
         \ 'ModDeprecated': ['@text.strike', 'CocDeprecatedHighlight']
         \ }
-    " TODO: add CocSemModXXX and CocSemTypeModeXXX
+    " TODO: add CocSemTypeModeXXX
     for [key, value] in items(hlMap)
       let ts = get(value, 0, '')
       let fallback = get(value, 1, '')

src/__tests__/handler/semanticTokens.test.ts

@@ -338,7 +338,7 @@ describe('semanticTokens', () => {
       let buf = await win.buffer
       let lines = await buf.lines
       let content = lines.join('\n')
-      expect(content).toMatch('CocSemTypeFunction')
+      expect(content).toMatch('Type: function\nModifiers: declaration\nHighlight group: CocSemTypeModFunctionDeclaration')
       await window.moveTo({ line: 1, character: 0 })
       await commandManager.executeCommand('semanticTokens.inspect')
       win = await helper.getFloat()

src/handler/semanticTokens/buffer.ts

@@ -232,39 +232,28 @@ export default class SemanticTokensBuffer implements SyncItem {
   private addHighlightItems(highlights: SemanticTokenRange[], range: [number, number, number], tokenType: string, tokenModifiers: string[]): void {
     // highlight groups:
     // CocSem + Type + type
-    // CocSem + Mod + modifier
     // CocSem + TypeMod + type + modifier
 
     let { combinedModifiers } = this.config
     let combine = false
+    let hlGroup: string
+
+    if (tokenModifiers.length) {
+      // only use first modifier to avoid highlight flicking
+      const modifier = tokenModifiers[0]
+      combine = combinedModifiers.includes(modifier)
+      hlGroup = HLGROUP_PREFIX + 'TypeMod' + toHighlightPart(tokenType) + toHighlightPart(modifier)
+    } else {
+      hlGroup = HLGROUP_PREFIX + 'Type' + toHighlightPart(tokenType)
+    }
 
     highlights.push({
       range,
       tokenType,
       combine,
-      hlGroup: HLGROUP_PREFIX + 'Type' + toHighlightPart(tokenType),
+      hlGroup,
       tokenModifiers,
     })
-
-    for (let modifier of tokenModifiers) {
-      combine = combinedModifiers.includes(modifier)
-
-      highlights.push({
-        range,
-        tokenType,
-        combine,
-        hlGroup: HLGROUP_PREFIX + 'Mode' + toHighlightPart(modifier),
-        tokenModifiers,
-      })
-
-      highlights.push({
-        range,
-        tokenType,
-        combine,
-        hlGroup: HLGROUP_PREFIX + 'TypeMod' + toHighlightPart(tokenType) + toHighlightPart(modifier),
-        tokenModifiers,
-      })
-    }
   }
 
   private toHighlightItems(highlights: ReadonlyArray<SemanticTokenRange>, startLine?: number, endLine?: number): HighlightItem[] {