feat: add api 'GetFullSchemaType' to support external package in kcl …

…doc (#188) * feat: add api 'GetFullSchemaType' to support external package in kcl doc Signed-off-by: zongz <zongzhe1024@163.com> * chore: bump kcl artifact version Signed-off-by: zongz <zongzhe1024@163.com> * fix: remove useless changes Signed-off-by: zongz <zongzhe1024@163.com> * fix: make fmt Signed-off-by: zongz <zongzhe1024@163.com> * fix: move add kfiles code out the method ParseArgs Signed-off-by: zongz <zongzhe1024@163.com> --------- Signed-off-by: zongz <zongzhe1024@163.com>
kcl-lang · Nov 30, 2023 · a0ae3a2 · a0ae3a2
1 parent 83897a5
commit a0ae3a2
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 0 deletions.
diff --git a/pkg/kcl/api.go b/pkg/kcl/api.go
@@ -199,6 +199,26 @@ func GetSchemaType(file, code, schemaName string) ([]*gpyrpc.KclType, error) {
 	return resp.SchemaTypeList, nil
 }
 
+func GetFullSchemaType(pathList []string, schemaName string, opts ...Option) ([]*gpyrpc.KclType, error) {
+	opts = append(opts, *NewOption().Merge(WithKFilenames(pathList...)))
+	args, err := ParseArgs(pathList, opts...)
+	if err != nil {
+		return nil, err
+	}
+
+	client := service.NewKclvmServiceClient()
+	resp, err := client.GetFullSchemaType(&gpyrpc.GetFullSchemaType_Args{
+		ExecArgs:   args.ExecProgram_Args,
+		SchemaName: schemaName,
+	})
+
+	if err != nil {
+		return nil, err
+	}
+
+	return resp.SchemaTypeList, nil
+}
+
 func GetSchemaTypeMapping(file, code, schemaName string) (map[string]*gpyrpc.KclType, error) {
 	client := service.NewKclvmServiceClient()
 	resp, err := client.GetSchemaTypeMapping(&gpyrpc.GetSchemaTypeMapping_Args{

diff --git a/pkg/kcl/api_test.go b/pkg/kcl/api_test.go
@@ -4,10 +4,12 @@ package kcl
 
 import (
 	"fmt"
+	"path/filepath"
 	"reflect"
 	"sort"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"kcl-lang.io/kcl-go/pkg/tools/list"
 )
 
@@ -102,3 +104,16 @@ func TestListUpstreamFiles(t *testing.T) {
 		t.Fatalf("\nexpect = %v\ngot    = %v", expect, deps)
 	}
 }
+
+func TestGetFullSchemaType(t *testing.T) {
+	testPath := filepath.Join(".", "testdata", "get_schema_ty")
+	tys, err := GetFullSchemaType(
+		[]string{filepath.Join(testPath, "aaa")},
+		"",
+		WithExternalPkgs(fmt.Sprintf("bbb=%s", filepath.Join(testPath, "bbb"))),
+	)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, len(tys), 1)
+	assert.Equal(t, tys[0].Filename, filepath.Join("testdata", "get_schema_ty", "bbb", "main.k"))
+	assert.Equal(t, tys[0].SchemaName, "B")
+}
diff --git a/pkg/kcl/testdata/get_schema_ty/aaa/kcl.mod b/pkg/kcl/testdata/get_schema_ty/aaa/kcl.mod
@@ -0,0 +1,5 @@
+[package]
+name = "aaa"
+edition = "0.0.1"
+version = "0.0.1"
+
diff --git a/pkg/kcl/testdata/get_schema_ty/aaa/main.k b/pkg/kcl/testdata/get_schema_ty/aaa/main.k
@@ -0,0 +1,5 @@
+import bbb as b
+
+a = b.B {
+    name: "b instance in a"
+}
diff --git a/pkg/kcl/testdata/get_schema_ty/bbb/kcl.mod b/pkg/kcl/testdata/get_schema_ty/bbb/kcl.mod
@@ -0,0 +1,5 @@
+[package]
+name = "bbb"
+edition = "0.0.1"
+version = "0.0.1"
+
diff --git a/pkg/kcl/testdata/get_schema_ty/bbb/main.k b/pkg/kcl/testdata/get_schema_ty/bbb/main.k
@@ -0,0 +1,2 @@
+schema B:
+    name: str