feat: add a api for unifying the KCL cli #369
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Peefy
reviewed
Jun 26, 2024
| } | ||
| } | ||
|
|
||
| func (c *KpmClient) Add(options ...AddOption) (*pkg.KclPkg, error) { |
There was a problem hiding this comment.
We can split this to some small functions.
Peefy
reviewed
Jun 26, 2024
| return "", fmt.Errorf("no kcl module root path found") | ||
| } | ||
|
|
||
| func (source *Source) ToFilePath() (string, error) { |
There was a problem hiding this comment.
We can use some abstract interfaces or factory methods to implement redundant if else code, improving the level of abstraction while avoiding bugs.
Peefy
reviewed
Jun 26, 2024
|
|
||
| type AddOption func(*AddOptions) error | ||
|
|
||
| func WithNewPkgName(name string) AddOption { |
There was a problem hiding this comment.
Add more docs and examples for public APIs.
| } | ||
| } | ||
|
|
||
| if runtime.GOOS != "windows" { |
There was a problem hiding this comment.
I suggest use a new function for this judgment, e.g.,
func moveTmpDirToLocal
|
|
||
| type PullOption func(*PullOptions) error | ||
|
|
||
| func WithPullSource(source *downloader.Source) PullOption { |
There was a problem hiding this comment.
Add more docs and examples here.
Peefy
reviewed
Jun 26, 2024
zong-zhe
changed the title
Pull Request Test Coverage Report for Build 9778724044Details
💛 - Coveralls |
Peefy
reviewed
Jul 3, 2024
pkg/utils/utils.go
Outdated
| // MoveFile will move the file from 'src' to 'dest'. | ||
| // On windows, it will copy the file from 'src' to 'dest', and then delete the file under 'src'. | ||
| // On unix-like systems, it will rename the file from 'src' to 'dest'. | ||
| func MoveFile(src, dest string) error { |
pkg/runner/entry.go
Outdated
| @@ -23,6 +23,11 @@ import ( | |||
| type EntryKind string | |||
|
|
|||
| // Entry is the entry of 'kpm run'. | |||
| // 一个编译入口，主要包括 | |||
pkg/package/modfile_test.go
Outdated
| @@ -245,6 +245,6 @@ func TestGenSource(t *testing.T) { | |||
| src, err = GenSource("oci", "oci://ghcr.io/kcl-lang/k8s", "1.24") | |||
| assert.Equal(t, err, nil) | |||
| assert.Equal(t, src.Oci.Reg, "ghcr.io") | |||
| assert.Equal(t, src.Oci.Repo, "kcl-lang/k8s") | |||
| assert.Equal(t, src.Oci.Repo, "/kcl-lang/k8s") | |||
There was a problem hiding this comment.
Why add a / for oci.Repo and what's the spec of OCI reg and repo.
pkg/client/run.go
Outdated
| type RunOptions struct { | ||
| // CompileOptions is the options for kcl compiler. | ||
| hasSettingsYaml bool | ||
| SettingYamls []string |
pkg/client/run.go
Outdated
| ro.Option = kcl.NewOption() | ||
| } | ||
| ro.hasSettingsYaml = true | ||
| ro.SettingYamls = settingFiles |
There was a problem hiding this comment.
SettingYamls or SettingFiles?
| } | ||
|
|
||
| // WithStrictRange sets the strict range flag for the kcl package. | ||
| func WithStrictRange(strictRange bool) RunOption { |
pkg/client/run.go
Outdated
| } | ||
|
|
||
| // NoCompileEntries returns true if there is no compile entries. | ||
| func (o *RunOptions) NoCompileEntries() bool { |
pkg/client/run.go
Outdated
| } | ||
|
|
||
| // Merge merges the options from kcl.yaml which is located in the work directory or inputed by the cli. | ||
| func (o *RunOptions) loadYamlSettingsFromLocalAndCli(rootPath string) error { |
There was a problem hiding this comment.
I want to know why you new so many names? SettingsYamls, YamlSettings, Settings, SettingFiles...
pkg/client/run.go
Outdated
| func (o *RunOptions) loadCliSettings(rootPath string, rootPkgSource *downloader.Source) error { | ||
| // If user input is empty, return error. | ||
| if o.NoCompileEntries() { | ||
| return ErrNoCliSettings |
There was a problem hiding this comment.
Why no entris returns no cli settings err message...
pkg/client/run.go
Outdated
| } | ||
|
|
||
| // acquire the lock of the package cache. | ||
| err := c.AcquirePackageCacheLock() |
There was a problem hiding this comment.
Why lock here if we do not load deps from remote sources.
Signed-off-by: zongz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):
re #289
2. What is the scope of this PR (e.g. component or file name):
3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):
4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):
5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links: