Refactor

client/src/lib/src/types/directiveKeywords.ts

@@ -0,0 +1,8 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2023 Savoir-faire Linux. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+export const DIRECTIVE_STATEMENT_KEYWORDS = ['require', 'inherit', 'include']
+
+export type DirectiveStatementKeyword = 'require' | 'inherit' | 'include'

server/src/DefinitionProvider.ts

@@ -15,7 +15,7 @@ import {
 } from './lib/src/types/BitbakeScanResult'
 
 import {
-  type BitBakeProjectScanner
+  bitBakeProjectScanner
 } from './BitBakeProjectScanner'
 
 import {
@@ -28,13 +28,8 @@ import { logger } from './lib/src/utils/OutputLogger'
 import path from 'path'
 
 export class DefinitionProvider {
-  private readonly _projectScanner: BitBakeProjectScanner
   private _symbolScanner: SymbolScanner | null = null
 
-  constructor (projectScanner: BitBakeProjectScanner) {
-    this._projectScanner = projectScanner
-  }
-
   // eslint-disable-next-line accessor-pairs
   set symbolScanner (symbolScanner: SymbolScanner | null) {
     this._symbolScanner = symbolScanner
@@ -54,7 +49,7 @@ export class DefinitionProvider {
             searchString = selectedSympbol
           }
 
-          const elementInfos: ElementInfo[] = this._projectScanner.classes.filter((obj: ElementInfo): boolean => {
+          const elementInfos: ElementInfo[] = bitBakeProjectScanner.classes.filter((obj: ElementInfo): boolean => {
             return obj.name === searchString
           })
           definition = this.createDefinitionForElementInfo(elementInfos)
@@ -65,12 +60,12 @@ export class DefinitionProvider {
       case 'include':
         {
           const includeFile: PathInfo = path.parse(restOfLine)
-          let elementInfos: ElementInfo[] = this._projectScanner.includes.filter((obj: ElementInfo): boolean => {
+          let elementInfos: ElementInfo[] = bitBakeProjectScanner.includes.filter((obj: ElementInfo): boolean => {
             return obj.name === includeFile.name
           })
 
           if (elementInfos.length === 0) {
-            elementInfos = this._projectScanner.recipes.filter((obj: ElementInfo): boolean => {
+            elementInfos = bitBakeProjectScanner.recipes.filter((obj: ElementInfo): boolean => {
               return obj.name === includeFile.name
             })
           }
@@ -97,7 +92,7 @@ export class DefinitionProvider {
   private createDefinitionForSymbolRecipes (symbol: string): Definition {
     let definitions: Definition = []
 
-    const recipe: ElementInfo | undefined = this._projectScanner.recipes.find((obj: ElementInfo): boolean => {
+    const recipe: ElementInfo | undefined = bitBakeProjectScanner.recipes.find((obj: ElementInfo): boolean => {
       return obj.name === symbol
     })
 
@@ -196,3 +191,5 @@ export class DefinitionProvider {
     return Location.create(encodeURI(url), range)
   }
 }
+
+export const definitionProvider = new DefinitionProvider()

server/src/SymbolScanner.ts

@@ -5,12 +5,7 @@
 
 import fs from 'fs'
 
-import {
-  BasicKeywordMap
-} from './BasicKeywordMap'
-
 import type {
-  CompletionItem,
   Definition,
   Location
 } from 'vscode-languageserver'
@@ -20,6 +15,7 @@ import type {
 } from './DefinitionProvider'
 
 import { logger } from './lib/src/utils/OutputLogger'
+import { DIRECTIVE_STATEMENT_KEYWORDS } from './lib/src/types/directiveKeywords'
 
 interface FileContent {
   filePath: string
@@ -65,11 +61,11 @@ export class SymbolScanner {
       })
 
       for (const line of file) {
-        const keyword = this.lineContainsKeyword(line)
+        const words = line.split(' ')
 
-        if (keyword !== undefined) {
-          logger.debug(`keyword found: ${keyword}`)
-          this.handleKeyword(keyword, line)
+        if (new Set(DIRECTIVE_STATEMENT_KEYWORDS).has(words[0])) {
+          logger.debug(`Directive statement keyword found: ${words[0]}`)
+          this.handleKeyword(words[0], line)
         }
       }
     } catch (error) {
@@ -83,20 +79,6 @@ export class SymbolScanner {
     }
   }
 
-  private lineContainsKeyword (line: string): string | undefined {
-    const keywords: CompletionItem[] = BasicKeywordMap
-
-    const trimedLine = line.trim()
-
-    for (const keyword of keywords) {
-      if (trimedLine.startsWith(keyword.label)) {
-        return keyword.label
-      }
-    }
-
-    return undefined
-  }
-
   private handleKeyword (keyword: string, line: string): void {
     const restOfLine: string[] = line.split(keyword).filter(String)
 

server/src/__tests__/completions.test.ts

@@ -31,6 +31,10 @@ describe('On Completion', () => {
     bitBakeDocScanner.clearScannedDocs()
   })
 
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
+
   it('expects reserved variables, keywords and snippets in completion item lists', async () => {
     // nothing is analyzed yet, and docs are not scanned. Only the static and fallback completion items are provided
     const result = onCompletionHandler({

server/src/__tests__/definition.test.ts

@@ -7,17 +7,16 @@ import { analyzer } from '../tree-sitter/analyzer'
 import { generateParser } from '../tree-sitter/parser'
 import { onDefinitionHandler } from '../connectionHandlers/onDefinition'
 import { FIXTURE_DOCUMENT } from './fixtures/fixtures'
-import contextHandler from '../ContextHandler'
 import { type Location } from 'vscode-languageserver'
-
+import { definitionProvider } from '../DefinitionProvider'
 // TODO: Current implementation of the definitionProvider needs to be improved, this test suite should be modified accordingly after
 const mockDefinition = (path: string | undefined): void => {
   if (path !== undefined) {
     const location: Location = { uri: 'file://' + path, range: { start: { line: 0, character: 0 }, end: { line: 0, character: 0 } } }
 
-    jest.spyOn(contextHandler, 'getDefinitionForDirectives').mockReturnValueOnce(location)
+    jest.spyOn(definitionProvider, 'createDefinitionForKeyword').mockReturnValue(location)
   } else {
-    jest.spyOn(contextHandler, 'getDefinitionForDirectives').mockReturnValueOnce([])
+    jest.spyOn(definitionProvider, 'createDefinitionForKeyword').mockReturnValue([])
   }
 }
 
@@ -35,6 +34,10 @@ describe('on definition', () => {
     analyzer.resetAnalyzedDocuments()
   })
 
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
   it('provides definition to directive statement', async () => {
     await analyzer.analyze({
       uri: DUMMY_URI,