Skip to content

Scope aware symbol resolution #649

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

Merged
merged 16 commits into from
Jan 2, 2023
Merged

Scope aware symbol resolution #649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
807e9b6
Skip symbols defined after the given location
skovhus Dec 22, 2022
e8ccecc
Make position required
skovhus Dec 22, 2022
2c651fb
Add fixture
skovhus Dec 23, 2022
7b5db2c
Only preprocess global declarations
skovhus Dec 29, 2022
4fb3425
Resolve symbols based on basic scoping
skovhus Dec 29, 2022
7d9a80e
Use latest symbol for global declarations
skovhus Dec 29, 2022
43f2a4b
Make global declarations a record
skovhus Dec 29, 2022
5928287
Fix onDocumentHighlight returning duplicated locations
skovhus Dec 29, 2022
9218768
Make findDefinition scope aware
skovhus Dec 29, 2022
64f41a6
Reuse declaration logic for completions
skovhus Dec 30, 2022
7864d27
Renaming analyzer methods
skovhus Dec 30, 2022
5bb71d4
Correct getDeclarationsForUri
skovhus Jan 2, 2023
2effa52
Simplify getGlobalDeclarations
skovhus Jan 2, 2023
8b45785
Add failing test case
skovhus Jan 2, 2023
2d41239
Add missing global variables
skovhus Jan 2, 2023
4b4b2ce
Update test case
skovhus Jan 2, 2023
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
431 changes: 209 additions & 222 deletions server/src/__tests__/__snapshots__/analyzer.test.ts.snap
View file
Open in desktop

Large diffs are not rendered by default.

282 changes: 219 additions & 63 deletions server/src/__tests__/analyzer.test.ts
View file
Open in desktop

Large diffs are not rendered by default.

245 changes: 147 additions & 98 deletions server/src/__tests__/server.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@ describe('server', () => {
{} as any,
)

// TODO: there is a superfluous range here on line 0:
expect(result1).toMatchInlineSnapshot(`
Array [
Object {
Expand All @@ -236,18 +235,6 @@ describe('server', () => {
},
},
},
Object {
"range": Object {
"end": Object {
"character": 12,
"line": 0,
},
"start": Object {
"character": 9,
"line": 0,
},
},
},
Object {
"range": Object {
"end": Object {
Expand Down Expand Up @@ -279,6 +266,134 @@ describe('server', () => {
)

expect(result2).toMatchInlineSnapshot(`Array []`)

const result3 = await onDocumentHighlight(
{
textDocument: {
uri: FIXTURE_URI.SCOPE,
},
position: {
// X
line: 32,
character: 8,
},
},
{} as any,
{} as any,
)

expect(result3).toMatchInlineSnapshot(`
Array [
Object {
"range": Object {
"end": Object {
"character": 1,
"line": 2,
},
"start": Object {
"character": 0,
"line": 2,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 1,
"line": 4,
},
"start": Object {
"character": 0,
"line": 4,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 9,
"line": 8,
},
"start": Object {
"character": 8,
"line": 8,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 11,
"line": 12,
},
"start": Object {
"character": 10,
"line": 12,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 13,
"line": 15,
},
"start": Object {
"character": 12,
"line": 15,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 13,
"line": 19,
},
"start": Object {
"character": 12,
"line": 19,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 15,
"line": 20,
},
"start": Object {
"character": 14,
"line": 20,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 11,
"line": 29,
},
"start": Object {
"character": 10,
"line": 29,
},
},
},
Object {
"range": Object {
"end": Object {
"character": 9,
"line": 32,
},
"start": Object {
"character": 8,
"line": 32,
},
},
},
]
`)
})

it('responds to onWorkspaceSymbol', async () => {
Expand Down Expand Up @@ -307,17 +422,6 @@ describe('server', () => {
},
name: 'npm_config_loglevel',
},
{
kind: expect.any(Number),
location: {
range: {
end: { character: 31, line: 48 },
start: { character: 2, line: 48 },
},
uri: expect.stringContaining('/testing/fixtures/install.sh'),
},
name: 'npm_config_loglevel',
},
])
}

Expand Down Expand Up @@ -669,58 +773,6 @@ describe('server', () => {
"kind": 6,
"label": "RESET",
},
Object {
"data": Object {
"name": "USER",
"type": 3,
},
"documentation": Object {
"kind": "markdown",
"value": "Variable: **USER** - *defined in issue101.sh*",
},
"kind": 6,
"label": "USER",
},
Object {
"data": Object {
"name": "PASSWORD",
"type": 3,
},
"documentation": Object {
"kind": "markdown",
"value": "Variable: **PASSWORD** - *defined in issue101.sh*",
},
"kind": 6,
"label": "PASSWORD",
},
Object {
"data": Object {
"name": "COMMENTS",
"type": 3,
},
"documentation": Object {
"kind": "markdown",
"value": "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": Object {
"kind": "markdown",
"value": "Variable: **tag** - *defined in ../../scripts/tag-release.inc*",
},
"kind": 6,
"label": "tag",
},
]
`)
})
Expand Down Expand Up @@ -849,30 +901,27 @@ describe('server', () => {
`)
})

it.failing(
'returns executable documentation if the function is not redefined',
async () => {
const { connection, server } = await initializeServer()
server.register(connection)
it('returns executable documentation if the function is not redefined', async () => {
const { connection, server } = await initializeServer()
server.register(connection)

const onHover = connection.onHover.mock.calls[0][0]
const onHover = connection.onHover.mock.calls[0][0]

const result = await onHover(
{
textDocument: {
uri: FIXTURE_URI.OVERRIDE_SYMBOL,
},
position: {
line: 2,
character: 1,
},
const result = await onHover(
{
textDocument: {
uri: FIXTURE_URI.OVERRIDE_SYMBOL,
},
{} as any,
{} as any,
)
position: {
line: 2,
character: 1,
},
},
{} as any,
{} as any,
)

expect(result).toBeDefined()
expect((result as any)?.contents.value).toContain('ls – list directory contents')
},
)
expect(result).toBeDefined()
expect((result as any)?.contents.value).toContain('list directory contents')
})
})
Loading