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

Implement AutocompleteMetadata and add autofills #28

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Implement AutocompleteMetadata and add autofills #28

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
d4209db
Create AutocompleteMetadata Dump
JohnnyMorganz Jun 18, 2020
d4c3020
Implement LuaLibrary and ItemStruct autocomplete
JohnnyMorganz Jun 18, 2020
49f0e75
Improve autocomplete property details
JohnnyMorganz Jun 18, 2020
97827e2
Hide ItemStructs with no autocomplete
JohnnyMorganz Jun 18, 2020
1fc2bb9
Fixes and adds type info for XML
JohnnyMorganz Jun 19, 2020
e0528cd
Handle snippets within ItemStruct
JohnnyMorganz Jun 19, 2020
9a444d5
Update CHANGELOG.md
JohnnyMorganz Jun 19, 2020
e474ad7
Reformat for style consistency
JohnnyMorganz Jun 19, 2020
3796d45
Add dot
JohnnyMorganz Jun 20, 2020
fe77495
Cleanup
JohnnyMorganz Jun 24, 2020
461fbe5
Merge branch 'master' into master
JohnnyMorganz Jul 2, 2020
a4f0006
Provide better autocomplete for Instance.new
JohnnyMorganz Aug 4, 2020
c414b04
Merge branch 'master' of https://github.com/JohnnyMorganz/roblox-lua-…
JohnnyMorganz Aug 4, 2020
30fd74b
Cleanup
JohnnyMorganz Aug 4, 2020
4d0ea52
Update Instance.new label
JohnnyMorganz Aug 4, 2020
326ece8
Merge branch 'master' into master
JohnnyMorganz Jan 10, 2021
6b5677d
Merge branch 'master' into master
JohnnyMorganz Jan 12, 2021
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
123 changes: 73 additions & 50 deletions src/itemStruct.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,59 @@
import * as vscode from "vscode"
import { getAutocompleteDump } from "./autocompleteDump"
import { getApiDump, UNCREATABLE_TAGS } from "./dump"
import { AutocompleteFunction, getAutocompleteDump } from "./autocompleteDump"
import { ApiClass, ApiDump, getApiDump, UNCREATABLE_TAGS } from "./dump"

const parameterClassFilter = (objectType: string, constraint: string) => {
return (klass: ApiClass): boolean => {
if (objectType === "Instance") {
if (constraint === "any") {
return true
} else if (constraint === "isScriptCreatable") {
const tags = klass.Tags
if (tags !== undefined) {
for (const tag of tags) {
if (UNCREATABLE_TAGS.has(tag)) {
return false
}
}
}
return true
JohnnyMorganz marked this conversation as resolved.
Show resolved Hide resolved
}
}
return false
JohnnyMorganz marked this conversation as resolved.
Show resolved Hide resolved
}
}

const getFunctionParameters = (func: AutocompleteFunction, apiDump: ApiDump): [ string[], vscode.SnippetString ] => {
const insertText = new vscode.SnippetString(`${func.name}(`)

const params = []
for (const paramIndex in func.parameters) {
if (func.parameters[paramIndex] !== undefined) {
const param = func.parameters[paramIndex]
Comment on lines +23 to +25
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be for (const param of func.parameters)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't actually do this because I need to use the paramIndex later - unless you want me to use for ... of and use Array.findIndex() afterwards?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should be able to do something like for (const [paramIndex, param] of Object.entries(func.parameters)).

const paramText = `${param.name}${param.optional ? "?" : ""}: ${param.type || "unknown"}`
params.push(paramText)

// Create a snippet if the parameters are definable (eg. Instance.new())
let paramInsertText
if (param.constraint !== undefined) {
const constraintSplit = param.constraint.split(":")
const objectType = constraintSplit[0]
const constraint = constraintSplit[1] || "any"

paramInsertText = apiDump.Classes
.filter(parameterClassFilter(objectType, constraint))
.map(klass => klass.Name).sort().join(",")
}

if (paramInsertText !== undefined) {
insertText.value += `"\${${paramIndex + 1}|${paramInsertText}|}"`
}
}
}
// End parantheses and set the cursor inside or outside the parens depending on param count
insertText.value += `${params.length > 0 ? `$0)` : `)$0`}`
return [ params, insertText ]
}

export class ItemStructCompletionProvider implements vscode.CompletionItemProvider {
itemStructNames: Promise<vscode.CompletionItem[]>
Expand All @@ -20,49 +73,7 @@ export class ItemStructCompletionProvider implements vscode.CompletionItemProvid
return item
}),
...itemStruct.functions.filter(func => func.static).map(func => {
const insertText = new vscode.SnippetString(`${func.name}(`)

const params = []
for (const paramIndex in func.parameters) {
if (func.parameters[paramIndex] !== undefined) {
const param = func.parameters[paramIndex]
const paramText = `${param.name}${param.optional ? "?" : ""}: ${param.type || "unknown"}`
params.push(paramText)

// Create a snippet if the parameters are definable (eg. Instance.new())
let paramInsertText
if (param.constraint !== undefined) {
const constraintSplit = param.constraint.split(":")
const objectType = constraintSplit[0]
const constraint = constraintSplit[1] || "any"

paramInsertText = apiDump.Classes.filter(klass => {
if (objectType === "Instance") {
if (constraint === "any") {
return true
} else if (constraint === "isScriptCreatable") {
const tags = klass.Tags
if (tags !== undefined) {
for (const tag of tags) {
if (UNCREATABLE_TAGS.has(tag)) {
return false
}
}
}
return true
}
}
return false
}).map(klass => klass.Name).sort().join(",")
}

if (paramInsertText !== undefined) {
insertText.value += `"\${${paramIndex + 1}|${paramInsertText}|}"`
}
}
}
// End parantheses and set the cursor inside or outside the parens depending on param count
insertText.value += `${params.length > 0 ? `$0)` : `)$0`}`
const [ params, insertText ] = getFunctionParameters(func, apiDump)

const item = new vscode.CompletionItem(
func.name,
Expand All @@ -81,14 +92,26 @@ export class ItemStructCompletionProvider implements vscode.CompletionItemProvid

this.itemStructNames = (async () => {
const autocompleteDump = await getAutocompleteDump()
const apiDump = await getApiDump()
return autocompleteDump.ItemStruct.filter(
itemStruct => {
return itemStruct.functions.filter(
itemStruct => itemStruct.functions.filter(
func => func.static,
).length > 0 || itemStruct.properties.filter((property) => property.static).length > 0
},
).length > 0 || itemStruct.properties.filter((property) => property.static).length > 0,
).map(
itemStruct => new vscode.CompletionItem(itemStruct.name, vscode.CompletionItemKind.Class),
itemStruct => {
const completionItem = new vscode.CompletionItem(itemStruct.name, vscode.CompletionItemKind.Class)
if (itemStruct.name === "Instance") {
const func = itemStruct.functions.find(func => func.name === "new")
if (func !== undefined) {
const [, insertText ] = getFunctionParameters(func, apiDump)
JohnnyMorganz marked this conversation as resolved.
Show resolved Hide resolved
insertText.value = `${itemStruct.name}.${insertText.value}`
completionItem.insertText = insertText
}
}
completionItem.detail = `(struct) ${itemStruct.name}`
completionItem.documentation = new vscode.MarkdownString(`[Developer Reference](https://developer.roblox.com/en-us/api-reference/datatype/${itemStruct.name})`)
return completionItem
},
)
})()
}
Expand Down