sync lsp.getProperties api change in xgolsw

Author: cn0809

spx-gui/src/components/editor/code-editor/spx-code-editor/api-reference/index.ts

@@ -14,7 +14,7 @@ import type {
   APIReferenceContext
 } from '../../xgo-code-editor'
 import { mainCategories, subCategories } from '../../xgo-code-editor/common'
-import { isTextDocumentStageCode } from '../common'
+import { isTextDocumentStageCode, parseDefinitionName } from '../common'
 import iconEvent from './icons/event.svg?raw'
 import iconLook from './icons/look.svg?raw'
 import iconMotion from './icons/motion.svg?raw'
@@ -302,18 +302,12 @@ const categoryViewInfos: APICategoryViewInfo[] = [
 export class SpxAPIReferenceProvider implements IAPIReferenceProvider {
   constructor(private documentBase: DocumentBase) {}
 
-  private parseName(name: string | undefined): [receiver: string | null, method: string] {
-    const parts = (name ?? '').split('.')
-    if (parts.length > 1) return [parts[0], parts[1]]
-    return [null, parts[0]]
-  }
-
   private getStageAPIReferenceItems = once(async () => {
     const maybeItems = await Promise.all(apiReferenceItems.map((id) => this.documentBase.getDocumentation(id)))
     const allItems = maybeItems.filter((i) => i != null) as DefinitionDocumentationItem[]
     return allItems.filter((item) => {
       if (item.definition.package !== packageSpx) return true
-      const [receiver] = this.parseName(item.definition.name)
+      const [receiver] = parseDefinitionName(item.definition.name)
       return receiver !== 'Sprite'
     })
   })
@@ -322,13 +316,13 @@ export class SpxAPIReferenceProvider implements IAPIReferenceProvider {
     const maybeItems = await Promise.all(apiReferenceItems.map((id) => this.documentBase.getDocumentation(id)))
     const allItems = maybeItems.filter((i) => i != null) as DefinitionDocumentationItem[]
     const spriteMethods = allItems.reduce((set, item) => {
-      const [receiver, method] = this.parseName(item.definition.name)
+      const [receiver, method] = parseDefinitionName(item.definition.name)
       if (receiver === 'Sprite') set.add(method)
       return set
     }, new Set<string>())
     return allItems.filter((item) => {
       if (item.definition.package !== packageSpx) return true
-      const [receiver, method] = this.parseName(item.definition.name)
+      const [receiver, method] = parseDefinitionName(item.definition.name)
       if (receiver === 'Game' && spriteMethods.has(method)) return false
       return true
     })

spx-gui/src/components/editor/code-editor/spx-code-editor/common.ts

@@ -24,7 +24,8 @@ import {
   type ResourceIdentifier,
   type TextDocumentIdentifier,
   getCodeFilePath,
-  type Property
+  type Property,
+  type DefinitionIdentifier
 } from '../xgo-code-editor'
 
 export type { ResourceModel }
@@ -182,6 +183,24 @@ export function textDocumentId2CodeFileName(id: TextDocumentIdentifier) {
   }
 }
 
+/**
+ * Parse receiver & method in `DefinitionIdentifier.name`.
+ * For example:
+ *  - 'Game.timer' => ['Game', 'timer']
+ *  - 'Sprite.heading' => ['Sprite', 'heading']
+ *  - 'hour' => [null, 'hour']
+ */
+export function parseDefinitionName(name: string | undefined): [receiver: string | null, method: string] {
+  const parts = (name ?? '').split('.')
+  if (parts.length > 1) return [parts[0], parts[1]]
+  return [null, parts[0]]
+}
+
+export function isStageDefinition(definition: DefinitionIdentifier) {
+  const [receiver] = parseDefinitionName(definition.name)
+  return receiver === 'Game'
+}
+
 export type { ColorValue }
 
 export enum SpxInputType {
@@ -273,18 +292,20 @@ export async function getInvalidMonitors(
       invalidMonitors.push(monitor)
       continue
     }
-    let propertyNames = propertyNamesMap.get(monitor.target)
-    if (propertyNames == null) {
+    let ownPropertyNames = propertyNamesMap.get(monitor.target)
+    if (ownPropertyNames == null) {
       try {
         const properties = await getProperties(monitor.target, signal)
-        propertyNames = new Set(properties.map((p) => p.name))
-        propertyNamesMap.set(monitor.target, propertyNames)
+        const ownProperties =
+          monitor.target === '' ? properties : properties.filter((item) => !isStageDefinition(item.definition))
+        ownPropertyNames = new Set(ownProperties.map((p) => p.name))
+        propertyNamesMap.set(monitor.target, ownPropertyNames)
       } catch (e) {
         capture(e, `Failed to load properties for target: "${monitor.target}"`)
         continue
       }
     }
-    if (!propertyNames.has(monitor.variableName)) {
+    if (!ownPropertyNames.has(monitor.variableName)) {
       invalidMonitors.push(monitor)
     }
   }

spx-gui/src/components/editor/code-editor/spx-code-editor/ui/input-helper/SpxPropertyNameInput.vue

@@ -41,19 +41,14 @@ const codeEditor = useCodeEditor()
 
 const properties = ref<Property[]>([])
 
-async function getProperties(textDocument: TextDocument, signal?: AbortSignal) {
+function getProperties(textDocument: TextDocument, signal?: AbortSignal) {
   const codeFilePath = getCodeFilePath(textDocument.id.uri)
   const isStage = stageCodeFilePaths.includes(codeFilePath)
   if (isStage) {
-    return await codeEditor.getProperties('', signal)
+    return codeEditor.getProperties('', signal)
   }
   const spriteName = codeFilePath.replace(/\.spx$/, '')
-  const [stageProperties, spriteProperties] = await Promise.all([
-    codeEditor.getProperties('', signal),
-    codeEditor.getProperties(spriteName, signal)
-  ])
-  const spritePropertyNames = new Set(spriteProperties.map((p) => p.name))
-  return [...spriteProperties, ...stageProperties.filter((p) => !spritePropertyNames.has(p.name))]
+  return codeEditor.getProperties(spriteName, signal)
 }
 
 watchEffect(async (onCleanup) => {

spx-gui/src/components/editor/code-editor/xgo-code-editor/code-editor.ts

@@ -20,6 +20,7 @@ import {
   toLSPPosition,
   type TextDocumentIdentifier,
   type ResourceIdentifier,
+  DefinitionKind,
   fromLSPTextEdit,
   type Position,
   getTextDocumentId,
@@ -335,7 +336,23 @@ export class CodeEditor extends Disposable {
 
   /** Get properties for a given target */
   async getProperties(target: string, signal?: AbortSignal): Promise<Property[]> {
-    return this.lspClient.getProperties({ signal }, target)
+    const properties = await this.lspClient.getProperties({ signal }, target)
+
+    const classFrameworkPkg = this.project.classFramework.pkgPaths[0]
+    const maybeProperties = await Promise.all(
+      properties.map(async (item) => {
+        const documentation = await this.documentBase.getDocumentation(item.definition)
+        // Skip APIs from framework packages without documentation — assumed not recommended
+        if (item.definition.package === classFrameworkPkg && documentation == null) return null
+        if (documentation != null) {
+          if (documentation.hiddenFromList) return null
+          if (![DefinitionKind.Read, DefinitionKind.Variable, DefinitionKind.Constant].includes(documentation.kind))
+            return null
+        }
+        return item
+      })
+    )
+    return maybeProperties.filter((item) => item != null)
   }
 
   private uis: ICodeEditorUIController[] = []

spx-gui/src/components/editor/code-editor/xgo-code-editor/common.ts

@@ -620,6 +620,8 @@ export type Property = {
   kind: 'field' | 'method'
   /** Optional documentation for the property */
   doc?: string
+  /** The definition identifier for the property */
+  definition: DefinitionIdentifier
 }
 
 export function positionEq(a: Position | null, b: Position | null) {

spx-gui/src/components/editor/stage/widget/detail/MonitorDetail.vue

@@ -122,7 +122,7 @@ import { capture, useMessageHandle } from '@/utils/exception'
 import type { Monitor } from '@/models/spx/widget/monitor'
 import { useRenameWidget } from '@/components/asset'
 import { useEditorCtx } from '@/components/editor/EditorContextProvider.vue'
-import { useCodeEditor } from '@/components/editor/code-editor/spx-code-editor'
+import { isStageDefinition, useCodeEditor } from '@/components/editor/code-editor/spx-code-editor'
 import EditorItemDetail from '../../../common/EditorItemDetail.vue'
 import monitorIcon from '../monitor.svg?raw'
 
@@ -140,11 +140,17 @@ const handleRename = useMessageHandle(() => renameWidget(props.monitor), {
 
 const sprites = computed(() => editorCtx.project.sprites)
 
+async function getOwnProperties(target: string, signal: AbortSignal) {
+  const properties = await codeEditor.getProperties(target, signal)
+  if (target === '') return properties
+  return properties.filter((item) => !isStageDefinition(item.definition))
+}
+
 const properties = useAsyncComputed(async (onCleanup) => {
   const target = props.monitor.target
   const signal = getCleanupSignal(onCleanup)
   try {
-    return await codeEditor.getProperties(target, signal)
+    return await getOwnProperties(target, signal)
   } catch (e) {
     capture(e, `Failed to load properties for target: "${target}"`)
     return []

tools/spxls/go.mod

@@ -6,15 +6,15 @@ tool github.com/goplus/xgolsw/cmd/pkgdatagen
 
 require (
 	github.com/goplus/builder/tools/ai v0.0.0
-	github.com/goplus/xgolsw v0.17.0
+	github.com/goplus/xgolsw v0.17.1-0.20260327033750-feb54c4edc9e
 )
 
 require (
 	github.com/goplus/gogen v1.21.2 // indirect
 	github.com/goplus/mod v0.19.6 // indirect
 	github.com/goplus/spbase v0.1.0 // indirect
 	github.com/goplus/spx/v2 v2.0.0-pre.48 // indirect
-	github.com/goplus/xgo v1.6.6 // indirect
+	github.com/goplus/xgo v1.6.7 // indirect
 	github.com/petermattis/goid v0.0.0-20250721140440-ea1c0173183e // indirect
 	github.com/qiniu/x v1.16.5 // indirect
 	golang.org/x/image v0.23.0 // indirect

tools/spxls/go.sum

@@ -13,8 +13,12 @@ github.com/goplus/spx/v2 v2.0.0-pre.48 h1:7SOl5inDxCuKsvwWteWjIaB5csqZtlvt7lQ1Lx
 github.com/goplus/spx/v2 v2.0.0-pre.48/go.mod h1:oP0YVzWNrczCyyO8qjYyni5sV4wJ3sqVkjCmc+P6jBo=
 github.com/goplus/xgo v1.6.6 h1:gfFoGYnyGfImt1aFEkK55TQTzNUDZQYDlWq9mRr3ors=
 github.com/goplus/xgo v1.6.6/go.mod h1:7ViCaG6azWTPIxxvXPtkod7J13IO06qKWHJSaQ2nqvY=
+github.com/goplus/xgo v1.6.7 h1:vPKx5ddOmx93oSan0rXTKWk6RO2/gJowBew9GFrUNcU=
+github.com/goplus/xgo v1.6.7/go.mod h1:8wsvmW48dGeZ+rCMqlk/MsNecp/snz/tUqNkXaLoe6U=
 github.com/goplus/xgolsw v0.17.0 h1:IZvqYIsTCpfMrVvsb3JQMd0WvtZj9PNp0uooEX5PfSg=
 github.com/goplus/xgolsw v0.17.0/go.mod h1:R61Je+Ps3trGmRV1pambjv0o0PUfHD5MRnNL6G+GC88=
+github.com/goplus/xgolsw v0.17.1-0.20260327033750-feb54c4edc9e h1:d09IJ0zUTX4XPg6QilBVNpgx1WsQMYaW65579hOH7nk=
+github.com/goplus/xgolsw v0.17.1-0.20260327033750-feb54c4edc9e/go.mod h1:Gh43ivd+brouDLQxF5UGYCTOKvd9l7dRQtsoGX4J1V0=
 github.com/petermattis/goid v0.0.0-20250721140440-ea1c0173183e h1:D0bJD+4O3G4izvrQUmzCL80zazlN7EwJ0PPDhpJWC/I=
 github.com/petermattis/goid v0.0.0-20250721140440-ea1c0173183e/go.mod h1:pxMtw7cyUw6B2bRH0ZBANSPg+AoSud1I1iyJHI69jH4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=