APIReference UI improvement #1239

nighca · 2025-01-14T01:02:53Z

APIReference UI optimizations, close APIReference UI Improvement #1234
Upgrade spx & add docs for new onTouchStart APIs, close Upgrade spx #1228

qiniu-prow · 2025-01-14T01:02:58Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Copilot reviewed 8 out of 15 changed files in this pull request and generated no comments.

Files not reviewed (7)

tools/ispx/go.mod: Language not supported
tools/spxls/go.mod: Language not supported
spx-gui/src/components/editor/ProjectEditor.vue: Evaluated as low risk
spx-gui/src/components/editor/code-editor/ui/CodeEditorUI.vue: Evaluated as low risk
spx-gui/src/components/editor/code-editor/ui/api-reference/APIReferenceUI.vue: Evaluated as low risk
spx-gui/src/components/editor/code-editor/document-base/spx/index.ts: Evaluated as low risk
spx-gui/src/components/editor/code-editor/ui/resource-reference/index.ts: Evaluated as low risk

tools/spxls/internal/server/format.go

nighca · 2025-01-14T10:05:34Z

tools/spxls/internal/server/format.go

+}
+
+// getFuncAndOverloadsType returns the function type and all its overloads.
+func getFuncAndOverloadsType(compileResult *compileResult, funIdent *gopast.Ident) (fun *types.Func, overloads []*types.Func) {


基本上是从 https://github.com/goplus/builder/pull/1209/files#diff-f13ba743896019fa1eadba9196fe866428e9616044e188defc8314b9ac2fba86 这里抄的，现在的代码里好像没有对类似逻辑的封装了🤣

nighca · 2025-01-14T10:17:26Z

tools/spxls/internal/server/format.go

+//
+// NOTE: There are limitations with current implementation:
+// 1. Only `LambdaExpr2` (not `LambdaExpr`) is supported.
+// 2. Only the last parameter of the lambda is checked.


如果考虑 lambda 每一个 parameter，尤其是当多个 parameter 可以省略的时候，“检查匹配的 overload”本身就会变复杂不少，而性价比很低；所以这里只处理 lambda 最后一个 parameter 可省略的情况，这已经能覆盖所有已知的 spx API 了

qiniu-x · 2025-01-15T00:53:50Z

[Git-flow] Hi @nighca, There are some suggestions for your information:

Rebase suggestions

Following commits have duplicated messages

typo

typo

Which seems insignificant, recommend to use git rebase command to reorganize your PR.

For other git-flow instructions, recommend refer to these examples.

If you have any questions about this comment, feel free to raise an issue here:

https://github.com/qiniu/reviewbot

qiniu-ci · 2025-01-15T00:57:53Z

This PR has been deployed to the preview environment. You can explore it using the preview URL.

Warning

Please note that deployments in the preview environment are temporary and will be automatically cleaned up after a certain period. Make sure to explore it before it is removed. For any questions, contact the Go+ Builder team.

aofei · 2025-01-15T03:43:30Z

tools/spxls/internal/server/format.go

@@ -28,7 +27,7 @@ func (s *Server) textDocumentFormatting(params *DocumentFormattingParams) ([]Tex
 		return nil, err
 	}

-	formatted, err := formatSpx(content)
+	formatted, err := formatSpx(s, spxFile)


这样看来不如直接把 formatSpx 的逻辑合并进 Server.textDocumentFormatting 里来，且用 astFile.Code 作为原始 content 来跟 formatted 做比较来判断是否发生变化

且用 astFile.Code 作为原始 content

这个是由于目前的 content 是实时读取的，因为预期会拿它去格式化。如果改成依赖 compile 后，按理说就不能用实时读取的 content 了。

aofei · 2025-01-15T03:44:04Z

tools/spxls/internal/server/format.go

-	astFile, err := gopparser.ParseFSEntry(fset, memfs.SingleFile("", "main.spx", string(src)), "main.spx", nil, gopparser.Config{
-		Mode: gopparser.ParseComments | gopparser.ParseGoPlusClass,
-	})
+	compileResult, _ := s.compile()


这里的 error 应该还是要处理下的，不然下面访问 compileResult 可能会 panic。可以参考这里的逻辑：

builder/tools/spxls/internal/server/command.go

Lines 112 to 121 in b4b1e78

result, spxFile, astFile, err := s.compileAndGetASTFileForDocumentURI(param.TextDocument.URI)

if err != nil {

if errors.Is(err, errNoValidSpxFiles) || errors.Is(err, errNoMainSpxFile) {

return nil, nil

}

return nil, err

}

if astFile == nil {

return nil, nil

}

aofei · 2025-01-15T03:59:48Z

tools/spxls/internal/server/format.go

+			return true
+		}
+		if pn, overloadId := parseGopFuncName(method.Name()); pn == funIdent.Name && overloadId == nil {
+			underlineFunType = method


这里应该可以 return false

aofei · 2025-01-15T04:06:59Z

tools/spxls/internal/server/format.go

+	if underlineFunType == nil {
+		return
+	}
+	return funType, expandGopOverloadableFunc(underlineFunType)


除了 expandGopOverloadableFunc(underlineFunType) 其实还有一种做法就是直接在 walkStruct 里收集所有 pn == funIdent.Name && overloadId != nil 的 methods，拿到的结果和 expandGopOverloadableFunc 应该是一样的

aofei · 2025-01-15T04:14:20Z

tools/spxls/internal/server/format_test.go

+				End:   Position{Line: 8, Character: 0},
+			},
+			NewText: `// A spx game.
+onKey [KeyLeft, KeyRight], () => {


像这种会建议写成 onKey [KeyLeft, KeyRight], () => { 还是 onKey [KeyLeft, KeyRight], => {？

vercel bot deployed to Preview January 14, 2025 01:06 View deployment

nighca requested a review from Copilot January 14, 2025 01:13

Copilot AI reviewed Jan 14, 2025

View reviewed changes

nighca marked this pull request as ready for review January 14, 2025 01:30

nighca added 4 commits January 14, 2025 17:58

upgrade spx

a73a71f

improve APIReference rendering performance

1ee2b57

update docs for spx APIs

67585f6

typo

d4b5214

qiniu-x bot reviewed Jan 14, 2025

View reviewed changes

tools/spxls/internal/server/format.go Show resolved Hide resolved

vercel bot deployed to Preview January 14, 2025 10:03 View deployment

nighca force-pushed the issue-1234 branch from b92c4f7 to c3daeae Compare January 14, 2025 10:04

nighca commented Jan 14, 2025

View reviewed changes

eliminate unused lambda params when formatting

58585e7

nighca force-pushed the issue-1234 branch from c3daeae to 58585e7 Compare January 14, 2025 10:08

vercel bot deployed to Preview January 14, 2025 10:15 View deployment

nighca commented Jan 14, 2025

View reviewed changes

typo

bb00979

vercel bot deployed to Preview January 15, 2025 00:59 View deployment

aofei reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

APIReference UI improvement #1239

APIReference UI improvement #1239

nighca commented Jan 14, 2025

qiniu-prow bot commented Jan 14, 2025

nighca Jan 14, 2025

nighca Jan 14, 2025 •

edited

Loading

qiniu-x bot commented Jan 15, 2025

qiniu-ci commented Jan 15, 2025

aofei Jan 15, 2025

aofei Jan 15, 2025

aofei Jan 15, 2025

aofei Jan 15, 2025

aofei Jan 15, 2025

aofei Jan 15, 2025

	result, spxFile, astFile, err := s.compileAndGetASTFileForDocumentURI(param.TextDocument.URI)
	if err != nil {
	if errors.Is(err, errNoValidSpxFiles) \|\| errors.Is(err, errNoMainSpxFile) {
	return nil, nil
	}
	return nil, err
	}
	if astFile == nil {
	return nil, nil
	}

APIReference UI improvement #1239

Are you sure you want to change the base?

APIReference UI improvement #1239

Conversation

nighca commented Jan 14, 2025

qiniu-prow bot commented Jan 14, 2025

Choose a reason for hiding this comment

nighca Jan 14, 2025

Choose a reason for hiding this comment

nighca Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

qiniu-x bot commented Jan 15, 2025

Rebase suggestions

qiniu-ci commented Jan 15, 2025

aofei Jan 15, 2025

Choose a reason for hiding this comment

aofei Jan 15, 2025

Choose a reason for hiding this comment

aofei Jan 15, 2025

Choose a reason for hiding this comment

aofei Jan 15, 2025

Choose a reason for hiding this comment

aofei Jan 15, 2025

Choose a reason for hiding this comment

aofei Jan 15, 2025

Choose a reason for hiding this comment

nighca Jan 14, 2025 •

edited

Loading