Correct documentation path

Author: skovhus

server/src/__tests__/analyzer.test.ts

@@ -1,6 +1,9 @@
-import * as path from 'path'
-
-import { FIXTURE_DOCUMENT, FIXTURE_FOLDER, FIXTURE_URI } from '../../../testing/fixtures'
+import {
+  FIXTURE_DOCUMENT,
+  FIXTURE_FOLDER,
+  FIXTURE_URI,
+  REPO_ROOT_FOLDER,
+} from '../../../testing/fixtures'
 import { getMockConnection } from '../../../testing/mocks'
 import Analyzer from '../analyser'
 import { getDefaultConfiguration } from '../config'
@@ -10,7 +13,6 @@ import * as fsUtil from '../util/fs'
 let analyzer: Analyzer
 
 const CURRENT_URI = 'dummy-uri.sh'
-const REPO_ROOT_FOLDER = path.resolve(path.join(FIXTURE_FOLDER, '../..'))
 const mockConsole = getMockConnection().console
 
 // if you add a .sh file to testing/fixtures, update this value

server/src/__tests__/server.test.ts

@@ -3,18 +3,25 @@ import * as Path from 'path'
 import * as LSP from 'vscode-languageserver/node'
 import { CodeAction } from 'vscode-languageserver/node'
 
-import FIXTURE_DOCUMENT, { FIXTURE_FOLDER, FIXTURE_URI } from '../../../testing/fixtures'
+import {
+  FIXTURE_DOCUMENT,
+  FIXTURE_FOLDER,
+  FIXTURE_URI,
+  REPO_ROOT_FOLDER,
+} from '../../../testing/fixtures'
 import { getMockConnection } from '../../../testing/mocks'
 import LspServer from '../server'
 import { CompletionItemDataType } from '../types'
 
-async function initializeServer() {
+async function initializeServer(
+  { rootPath }: { rootPath?: string } = { rootPath: FIXTURE_FOLDER },
+) {
   const diagnostics: Array<LSP.PublishDiagnosticsParams | undefined> = []
 
   const connection = getMockConnection()
 
   const server = await LspServer.initialize(connection, {
-    rootPath: FIXTURE_FOLDER,
+    rootPath,
     rootUri: null,
     processId: 42,
     capabilities: {} as any,
@@ -484,7 +491,7 @@ describe('server', () => {
             "name": "BLUE",
             "type": 3,
           },
-          "documentation": "### Variable: **BLUE** - *defined in ../extension.inc*",
+          "documentation": "### Variable: **BLUE** - *defined in extension.inc*",
           "kind": 6,
           "label": "BLUE",
         },
@@ -513,7 +520,7 @@ describe('server', () => {
             "name": "add_a_user",
             "type": 3,
           },
-          "documentation": "### Function: **add_a_user** - *defined in ../issue101.sh*
+          "documentation": "### Function: **add_a_user** - *defined in issue101.sh*
 
       \`\`\`txt
       Helper function to add a user
@@ -561,7 +568,7 @@ describe('server', () => {
   })
 
   it('responds to onCompletion with all variables when starting to expand parameters', async () => {
-    const { connection } = await initializeServer()
+    const { connection } = await initializeServer({ rootPath: REPO_ROOT_FOLDER })
 
     const onCompletion = connection.onCompletion.mock.calls[0][0]
 
@@ -600,7 +607,7 @@ describe('server', () => {
             "name": "RED",
             "type": 3,
           },
-          "documentation": "### Variable: **RED** - *defined in ../extension.inc*",
+          "documentation": "### Variable: **RED** - *defined in extension.inc*",
           "kind": 6,
           "label": "RED",
         },
@@ -609,7 +616,7 @@ describe('server', () => {
             "name": "GREEN",
             "type": 3,
           },
-          "documentation": "### Variable: **GREEN** - *defined in ../extension.inc*",
+          "documentation": "### Variable: **GREEN** - *defined in extension.inc*",
           "kind": 6,
           "label": "GREEN",
         },
@@ -618,7 +625,7 @@ describe('server', () => {
             "name": "BLUE",
             "type": 3,
           },
-          "documentation": "### Variable: **BLUE** - *defined in ../extension.inc*",
+          "documentation": "### Variable: **BLUE** - *defined in extension.inc*",
           "kind": 6,
           "label": "BLUE",
         },
@@ -627,7 +634,7 @@ describe('server', () => {
             "name": "RESET",
             "type": 3,
           },
-          "documentation": "### Variable: **RESET** - *defined in ../extension.inc*",
+          "documentation": "### Variable: **RESET** - *defined in extension.inc*",
           "kind": 6,
           "label": "RESET",
         },
@@ -636,7 +643,7 @@ describe('server', () => {
             "name": "USER",
             "type": 3,
           },
-          "documentation": "### Variable: **USER** - *defined in ../issue101.sh*",
+          "documentation": "### Variable: **USER** - *defined in issue101.sh*",
           "kind": 6,
           "label": "USER",
         },
@@ -645,7 +652,7 @@ describe('server', () => {
             "name": "PASSWORD",
             "type": 3,
           },
-          "documentation": "### Variable: **PASSWORD** - *defined in ../issue101.sh*",
+          "documentation": "### Variable: **PASSWORD** - *defined in issue101.sh*",
           "kind": 6,
           "label": "PASSWORD",
         },
@@ -654,14 +661,23 @@ describe('server', () => {
             "name": "COMMENTS",
             "type": 3,
           },
-          "documentation": "### Variable: **COMMENTS** - *defined in ../issue101.sh*
+          "documentation": "### Variable: **COMMENTS** - *defined in issue101.sh*
 
       \`\`\`txt
       Having shifted twice, the rest is now comments ...
       \`\`\`",
           "kind": 6,
           "label": "COMMENTS",
         },
+        Object {
+          "data": Object {
+            "name": "tag",
+            "type": 3,
+          },
+          "documentation": "### Variable: **tag** - *defined in ../../scripts/tag-release.inc*",
+          "kind": 6,
+          "label": "tag",
+        },
       ]
     `)
   })

server/src/server.ts

@@ -1,5 +1,5 @@
-import * as Process from 'child_process'
-import * as Path from 'path'
+import { spawnSync } from 'child_process'
+import * as path from 'path'
 import * as TurndownService from 'turndown'
 import { isDeepStrictEqual } from 'util'
 import * as LSP from 'vscode-languageserver/node'
@@ -352,7 +352,7 @@ export default class BashServer {
     const hoverHeader = `### ${symbolKindToDescription(symbol.kind)}: **${symbol.name}**`
     const symbolLocation =
       symbolUri !== currentUri
-        ? `in ${Path.relative(currentUri, symbolUri)}`
+        ? `in ${path.relative(path.dirname(currentUri), symbolUri)}`
         : `on line ${symbolStarLine + 1}`
 
     return `${hoverHeader} - *defined ${symbolLocation}*${symbolDocumentation}`
@@ -799,10 +799,7 @@ const getMarkdownContent = (documentation: string): LSP.MarkupContent => ({
 
 function getCommandOptions(name: string, word: string): string[] {
   // TODO: The options could be cached.
-  const options = Process.spawnSync(Path.join(__dirname, '../src/get-options.sh'), [
-    name,
-    word,
-  ])
+  const options = spawnSync(path.join(__dirname, '../src/get-options.sh'), [name, word])
 
   if (options.status !== 0) {
     return []

testing/fixtures.ts

@@ -35,4 +35,4 @@ export const FIXTURE_DOCUMENT: Record<FIXTURE_KEY, TextDocument> = (
   return acc
 }, {} as any)
 
-export default FIXTURE_DOCUMENT
+export const REPO_ROOT_FOLDER = path.resolve(path.join(FIXTURE_FOLDER, '../..'))