Complete the path instead just names for include and require statements

server/src/__tests__/completions.test.ts

@@ -404,22 +404,41 @@ describe('On Completion', () => {
   })
 
   it('provides suggestions for direcitive statement after keywords "include", "inherit" and "requrie" are typed', async () => {
-    jest.spyOn(bitBakeProjectScanner, 'includes', 'get').mockReturnValue([{
-      name: 'init-manager-none',
-      path: {
-        root: '/',
-        dir: '/home/projects/poky/meta/conf/distro/include',
-        base: 'init-manager-none.inc',
-        ext: '.inc',
-        name: 'init-manager-none'
+    const documentUri = 'file:///home/projects/poky/meta/conf-2/path/to/dummy.bb'
+    jest.spyOn(bitBakeProjectScanner, 'includes', 'get').mockReturnValue([
+      {
+        name: 'init-manager-none',
+        path: {
+          root: '/',
+          dir: '/home/projects/poky/meta/conf/distro/include',
+          base: 'init-manager-none.inc',
+          ext: '.inc',
+          name: 'init-manager-none'
+        },
+        extraInfo: 'layer: core',
+        layerInfo: {
+          name: 'core',
+          path: '/home/projects/poky/meta',
+          priority: 5
+        }
       },
-      extraInfo: 'layer: core',
-      layerInfo: {
-        name: 'core',
-        path: '/home/projects/poky/meta',
-        priority: 5
+      {
+        name: 'init-manager-none-2',
+        path: {
+          root: '/',
+          dir: '/home/projects/poky/meta/conf-2/distro/include', // Note that this fake path is under the same "conf-2" folder as the documentUri
+          base: 'init-manager-none-2.inc',
+          ext: '.inc',
+          name: 'init-manager-none-2'
+        },
+        extraInfo: 'layer: core',
+        layerInfo: {
+          name: 'core',
+          path: '/home/projects/poky/meta',
+          priority: 5
+        }
       }
-    }])
+    ])
 
     jest.spyOn(bitBakeProjectScanner, 'classes', 'get').mockReturnValue([{
       name: 'copyleft_filter',
@@ -439,13 +458,13 @@ describe('On Completion', () => {
     }])
 
     await analyzer.analyze({
-      uri: DUMMY_URI,
+      uri: documentUri,
       document: FIXTURE_DOCUMENT.COMPLETION
     })
 
     const resultForInclude = onCompletionHandler({
       textDocument: {
-        uri: DUMMY_URI
+        uri: documentUri
       },
       position: {
         line: 10,
@@ -455,7 +474,7 @@ describe('On Completion', () => {
 
     const resultForRequire = onCompletionHandler({
       textDocument: {
-        uri: DUMMY_URI
+        uri: documentUri
       },
       position: {
         line: 11,
@@ -465,7 +484,7 @@ describe('On Completion', () => {
 
     const resultForInherit = onCompletionHandler({
       textDocument: {
-        uri: DUMMY_URI
+        uri: documentUri
       },
       position: {
         line: 12,
@@ -477,19 +496,26 @@ describe('On Completion', () => {
       expect.arrayContaining([
         expect.objectContaining(
           {
-            label: 'init-manager-none',
-            kind: 8
+            label: 'init-manager-none.inc',
+            kind: 8,
+            insertText: 'conf/distro/include/init-manager-none.inc'
           }
         )
       ])
     )
 
+    const index1 = resultForInclude.findIndex((item) => item.label === 'init-manager-none.inc')
+    const index2 = resultForInclude.findIndex((item) => item.label === 'init-manager-none-2.inc')
+    // Since the path of "init-manager-none-2.inc" is under the same "conf-2" folder as the documentUri, it should be suggested first
+    expect(index2).toBeLessThan(index1)
+
     expect(resultForRequire).toEqual(
       expect.arrayContaining([
         expect.objectContaining(
           {
-            label: 'init-manager-none',
-            kind: 8
+            label: 'init-manager-none.inc',
+            kind: 8,
+            insertText: 'conf/distro/include/init-manager-none.inc'
           }
         )
       ])
@@ -500,7 +526,8 @@ describe('On Completion', () => {
         expect.objectContaining(
           {
             label: 'copyleft_filter',
-            kind: 7
+            kind: 7,
+            insertText: 'copyleft_filter'
           }
         )
       ])

server/src/__tests__/semanticTokens.test.ts

@@ -5,7 +5,7 @@
 
 import { analyzer } from '../tree-sitter/analyzer'
 import { generateParser } from '../tree-sitter/parser'
-import { getParsedTokens, TOKEN_LEGEND } from '../semanticTokensProvider'
+import { getParsedTokens, TOKEN_LEGEND } from '../semanticTokens'
 import { FIXTURE_DOCUMENT } from './fixtures/fixtures'
 
 const DUMMY_URI = 'dummy_uri'

server/src/connectionHandlers/onCompletion.ts

@@ -21,14 +21,16 @@ import { VARIABLE_FLAGS } from '../completions/variable-flags'
 import { bitBakeProjectScanner } from '../BitBakeProjectScanner'
 import type { ElementInfo } from '../lib/src/types/BitbakeScanResult'
 
+let documentUri = ''
+
 export function onCompletionHandler (textDocumentPositionParams: TextDocumentPositionParams): CompletionItem[] {
   const wordPosition = {
     line: textDocumentPositionParams.position.line,
     // Go one character back to get completion on the current word. This is used as a parameter in descendantForPosition()
     character: Math.max(textDocumentPositionParams.position.character - 1, 0)
   }
 
-  const documentUri = textDocumentPositionParams.textDocument.uri
+  documentUri = textDocumentPositionParams.textDocument.uri
 
   const word = analyzer.wordAtPointFromTextPosition({
     ...textDocumentPositionParams,
@@ -222,32 +224,46 @@ function convertElementInfoListToCompletionItemList (elementInfoList: ElementInf
   for (const element of elementInfoList) {
     const filePath = getFilePath(element, fileType)
     const completionItem: CompletionItem = {
-      label: element.name,
+      label: element.name + (element.path?.ext === '.inc' ? '.inc' : ''),
       labelDetails: {
         description: filePath ?? fileType
       },
-      // TODO1: Construct the file path which should be relative to the current document for insertText.
-      // TODO2: Limit what should be shown in the completion list for directive statment?
-      // insertText: filePath ?? element.name,
+      insertText: filePath ?? element.name,
       documentation: element.extraInfo,
       data: element,
       kind: completionItemKind
     }
     completionItems.push(completionItem)
   }
 
+  if (completionItems.length > 0) {
+    const docUriSplit = documentUri.replace('file://', '').split('/')
+    const condition = (item: CompletionItem): boolean => {
+      if (item.insertText === undefined || item.insertText.split('.')[0] === item.label.split('.')[0]) {
+        return false
+      } else {
+        return docUriSplit.includes(item.insertText.split('/')[0])
+      }
+    }
+
+    completionItems.sort((a, b) => Number(condition(b)) - Number(condition(a)))
+  }
+
   return completionItems
 }
 
 function getFilePath (elementInfo: ElementInfo, fileType: string): string | undefined {
-  if (fileType === 'inc' || fileType === 'bbclass') {
+  if (fileType === 'inc') {
     const path = elementInfo.path
-    let pathAsString = path?.dir.replace(elementInfo.layerInfo?.path as string, '')
-    if (pathAsString !== undefined && pathAsString.startsWith('/')) {
+    if (path === undefined) {
+      return undefined
+    }
+    let pathAsString = path.dir.replace(elementInfo.layerInfo?.path ?? '', '')
+    if (pathAsString.startsWith('/')) {
       pathAsString = pathAsString.slice(1)
     }
 
-    return pathAsString + '/' + elementInfo?.path?.base
+    return pathAsString + '/' + path.base
   }
   return undefined
 }

server/src/server.ts

@@ -31,7 +31,7 @@ import { generateEmbeddedLanguageDocs, getEmbeddedLanguageDocInfosOnPosition } f
 import { embeddedLanguageDocsManager } from './embedded-languages/documents-manager'
 import { RequestMethod, type RequestParams, type RequestResult } from './lib/src/types/requests'
 import { NotificationMethod, type NotificationParams } from './lib/src/types/notifications'
-import { getSemanticTokens, legend } from './semanticTokensProvider'
+import { getSemanticTokens, legend } from './semanticTokens'
 // Create a connection for the server. The connection uses Node's IPC as a transport
 const connection: Connection = createConnection(ProposedFeatures.all)
 const documents = new TextDocuments<TextDocument>(TextDocument)