Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Add comment with original uri on embedded language documents #279

Merged
merged 1 commit into from
Jul 8, 2024
Merged

Chore: Add comment with original uri on embedded language documents #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions client/src/language/middlewareDefinition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ const redirectDefinition = async <DefinitionType extends Location | LocationLink
return redirectedResult.map((redirectedDefinition) => convertToSameDefinitionType(initialDefinition, redirectedDefinition))
}

export const dRange = new Range(2, 0, 2, 1) // Where `d` is located in the embedded language document
export const dataSmartPosition = new Position(2, 19) // Where `DataSmart` (data_smart.DataSmart()) is reachable in the embedded language document
export const dRange = new Range(3, 0, 3, 1) // Where `d` is located in the embedded language document
export const dataSmartPosition = new Position(3, 19) // Where `DataSmart` (data_smart.DataSmart()) is reachable in the embedded language document

// Handle `d` in `d.getVar('')`
const getDefinitionOfD = async <DefinitionType extends Location | LocationLink>(
Expand All @@ -146,8 +146,8 @@ const getDefinitionOfD = async <DefinitionType extends Location | LocationLink>(
return await redirectDefinition(definition, dRange, dataSmartPosition)
}

export const eRange = new Range(3, 0, 3, 1) // Where `e` is located in the embedded language document
export const eventPosition = new Position(3, 14) // Where `Event` (event.Event()) is reachable in the embedded language document
export const eRange = new Range(4, 0, 4, 1) // Where `e` is located in the embedded language document
export const eventPosition = new Position(4, 14) // Where `Event` (event.Event()) is reachable in the embedded language document

// Handle `e` in `e.data.getVar('')`
const getDefinitionOfE = async <DefinitionType extends Location | LocationLink>(
Expand Down
48 changes: 30 additions & 18 deletions server/src/__tests__/embedded-languages.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ import { analyzer } from '../tree-sitter/analyzer'
import { generateBashParser, generateBitBakeParser } from '../tree-sitter/parser'
import { TextDocument } from 'vscode-languageserver-textdocument'
import { type EmbeddedLanguageType } from '../lib/src/types/embedded-languages'
import { imports } from '../embedded-languages/python-support'
import { bashHeader } from '../embedded-languages/bash-support'
import { getPythonHeader } from '../embedded-languages/python-support'
import { getBashHeader } from '../embedded-languages/bash-support'

describe('Create basic embedded bash documents', () => {
const uri = randomUUID()
const bashHeader = getBashHeader(uri)

beforeAll(async () => {
if (!analyzer.hasParsers()) {
const bitBakeParser = await generateBitBakeParser()
Expand Down Expand Up @@ -46,12 +49,15 @@ describe('Create basic embedded bash documents', () => {
`${bashHeader} foo(){\nBAR=""\n}`
]
])('%s', async (description, input, result) => {
const embeddedContent = await createEmbeddedContent(input, 'bash')
const embeddedContent = await createEmbeddedContent(input, 'bash', uri)
expect(embeddedContent).toEqual(result)
})
})

describe('Create various basic embedded python documents', () => {
const uri = randomUUID()
const pythonHeader = getPythonHeader(uri)

beforeAll(async () => {
if (!analyzer.hasParsers()) {
const bitBakeParser = await generateBitBakeParser()
Expand All @@ -65,35 +71,38 @@ describe('Create various basic embedded python documents', () => {
[
'anonymous',
'python(){\n pass\n}',
`${imports}def _ ():\n pass\n `
`${pythonHeader}def _ ():\n pass\n `
],
[
'named with python keyword',
'python foo (){\n pass\n}',
`${imports}def foo ():\n pass\n `
`${pythonHeader}def foo ():\n pass\n `
],
[
'empty',
'python(){\n}',
`${imports}def _ ():\n pass\n `
`${pythonHeader}def _ ():\n pass\n `
],
[
'with def keyword',
'def foo():\n pass',
`${imports}def foo():\n pass`
`${pythonHeader}def foo():\n pass`
],
[
'with fakeroot',
'fakeroot python(){\n pass\n}',
`${imports}def _ ():\n pass\n `
`${pythonHeader}def _ ():\n pass\n `
]
])('%s', async (description, input, result) => {
const embeddedContent = await createEmbeddedContent(input, 'python')
const embeddedContent = await createEmbeddedContent(input, 'python', uri)
expect(embeddedContent).toEqual(result)
})
})

describe('Create Python embedded language content with inline Python', () => {
const uri = randomUUID()
const pythonHeader = getPythonHeader(uri)

beforeAll(async () => {
if (!analyzer.hasParsers()) {
const bitBakeParser = await generateBitBakeParser()
Expand All @@ -108,40 +117,40 @@ describe('Create Python embedded language content with inline Python', () => {
'basic',
// eslint-disable-next-line no-template-curly-in-string
'FOO = \'${@"BAR"}\'',
`${imports} \n\n"BAR"\n `
`${pythonHeader} \n\n"BAR"\n `
],
[
'with spacing',
// eslint-disable-next-line no-template-curly-in-string
'FOO = \'${@ "BAR" }\'',
`${imports} \n \n"BAR" \n `
`${pythonHeader} \n \n"BAR" \n `
],
[
'multiline',
// eslint-disable-next-line no-template-curly-in-string
'FOO = \'${@"BAR"}\' \\\n1 \\\n2"',
`${imports} \n\n"BAR"\n \n \n `
`${pythonHeader} \n\n"BAR"\n \n \n `
],
[
'with two embedded python regions',
// eslint-disable-next-line no-template-curly-in-string
'FOO = \'${@"BAR"}${@"BAR"}\'',
`${imports} \n\n"BAR"\n \n\n"BAR"\n `
`${pythonHeader} \n\n"BAR"\n \n\n"BAR"\n `
],
[
'without surrounding quotes',
// eslint-disable-next-line no-template-curly-in-string
'inherit ${@"test"}',
`${imports} \n\n"test"\n`
`${pythonHeader} \n\n"test"\n`
],
[
'inside bash function',
// eslint-disable-next-line no-template-curly-in-string
'foo(){\n${@FOO}\n}',
`${imports} \n \n\nFOO\n\n `
`${pythonHeader} \n \n\nFOO\n\n `
]
])('%s', async (description, input, result) => {
const embeddedContent = await createEmbeddedContent(input, 'python')
const embeddedContent = await createEmbeddedContent(input, 'python', uri)
expect(embeddedContent).toEqual(result)
})
})
Expand Down Expand Up @@ -203,8 +212,11 @@ describe('Finds proper embedded language type', () => {
})
})

const createEmbeddedContent = async (content: string, language: EmbeddedLanguageType): Promise<string | undefined> => {
const uri = randomUUID()
const createEmbeddedContent = async (
content: string,
language: EmbeddedLanguageType,
uri: string
): Promise<string | undefined> => {
const document = TextDocument.create(uri, 'bitbake', 1, content)
analyzer.analyze({ document, uri })
const embeddedLanguageDocs = generateEmbeddedLanguageDocs(document)
Expand Down
17 changes: 10 additions & 7 deletions server/src/embedded-languages/bash-support.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ const shellcheckDisables = [
'# shellcheck disable=SC2317'
]

export const bashHeader = [
shebang,
...shellcheckDisables,
''
].join('\n')

export const generateBashEmbeddedLanguageDoc = (
textDocument: TextDocument,
bitBakeTree: Parser.Tree,
Expand Down Expand Up @@ -53,8 +47,17 @@ export const generateBashEmbeddedLanguageDoc = (
return embeddedLanguageDoc
}

export const getBashHeader = (originalUri: string): string => {
return [
shebang,
`# Original BitBake document: ${originalUri}`,
...shellcheckDisables,
''
].join('\n')
}

const insertBashHeader = (embeddedLanguageDoc: EmbeddedLanguageDoc): void => {
insertTextIntoEmbeddedLanguageDoc(embeddedLanguageDoc, 0, 0, bashHeader)
insertTextIntoEmbeddedLanguageDoc(embeddedLanguageDoc, 0, 0, getBashHeader(embeddedLanguageDoc.originalUri))
}

const insertBashTools = (embeddedLanguageDoc: EmbeddedLanguageDoc, pokyFolder: string): void => {
Expand Down
20 changes: 16 additions & 4 deletions server/src/embedded-languages/python-support.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ export const imports = [
'd = bb.data_smart.DataSmart()',
'e = bb.event.Event()',
'e.data = d',
'import os',
''
].join('\n')
'import os'
]

export const generatePythonEmbeddedLanguageDoc = (
textDocument: TextDocument,
Expand All @@ -42,10 +41,23 @@ export const generatePythonEmbeddedLanguageDoc = (
return true
}
})
insertTextIntoEmbeddedLanguageDoc(embeddedLanguageDoc, 0, 0, imports)
insertHeader(embeddedLanguageDoc)
return embeddedLanguageDoc
}

export const getPythonHeader = (originalUri: string): string => {
const headers = [
`# Original BitBake document: ${originalUri}`,
...imports,
''
].join('\n')
return headers
}

const insertHeader = (embeddedLanguageDoc: EmbeddedLanguageDoc): void => {
insertTextIntoEmbeddedLanguageDoc(embeddedLanguageDoc, 0, 0, getPythonHeader(embeddedLanguageDoc.originalUri))
}

const handlePythonFunctionDefinition = (node: SyntaxNode, embeddedLanguageDoc: EmbeddedLanguageDoc): void => {
insertTextIntoEmbeddedLanguageDoc(embeddedLanguageDoc, node.startIndex, node.endIndex, node.text)
node.children.forEach((child) => {
Expand Down