sparse checkout feature - Load the package after downloading the entire repository

[officialasishkumar]

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

• N
• Y

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):

• Affects user behaviors
• Contains syntax changes
• Contains variable changes
• Contains experimental features
• Performance regression: Consumes more CPU
• Performance regression: Consumes more Memory
• Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

• N
• Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

• Unit test
• Integration test
• Benchmark (add benchmark stats below)
• Manual test (add detailed scripts or steps below)
• Other

[officialasishkumar]

PTAL @zong-zhe @Peefy

[Peefy]

cc @zong-zhe Could you help review it?

[officialasishkumar]

By mistake i defined the package in https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/kcl/opt.go#L15 and it worked locally. I didn't realised that and pushed it. I was wondering do i have to make changes to that repo too?

There is another option to pass package here https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/spec/gpyrpc/gpyrpc.pb.go#L1497

lmk which sounds good

cc: @Peefy @zong-zhe

[zong-zhe]

By mistake i defined the package in https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/kcl/opt.go#L15 and it worked locally. I didn't realised that and pushed it. I was wondering do i have to make changes to that repo too?

There is another option to pass package here https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/spec/gpyrpc/gpyrpc.pb.go#L1497

lmk which sounds good

cc: @Peefy @zong-zhe

Hi @officialasishkumar 😄

At present, define the package field in the kpm project because the current definition of KCL-GO is the go-sdk of KCL language; from the language side, the compiler can not understand the concept of package; all package-related content should be managed by kpm. Although they all work well, having a clear division of responsibility for each project is more helpful.

[officialasishkumar]

Hi @zong-zhe ,

Thanks for the response. I have changed the code accordingly. Please have a look : )

[coveralls]

Pull Request Test Coverage Report for Build 10433442117

Details

• 1 of 53 (1.89%) changed or added relevant lines in 3 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.3%) to 40.105%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
pkg/client/client.go	1	9	11.11%
pkg/cmd/cmd_run.go	0	8	0.0%
pkg/utils/utils.go	0	36	0.0%

Totals
Change from base Build 10383495256:	-0.3%
Covered Lines:	3129
Relevant Lines:	7802

---

💛 - Coveralls

[Peefy]

Why not use the loadpackage function?

[officialasishkumar]

Where is it? Can you share the link of the code or the docs?

[Peefy]

Could you please add more documents and unit tests?

[Peefy]

Use the kcl.mod constant defined in the repo.

[officialasishkumar]

done!

[Peefy]

cc @zong-zhe Could you help review it?

@officialasishkumar I am not sure if this PR can meet all the requirements of LFX, but you should at least provide complete PR information for the functionality according to your changed code. Therefore, I only left some comments on the content of this PR.

However, I believe that there is still a lot of work to be done to complete the entire topic and enable users to add Git dependent submodules using kcl mod add.

[Peefy]

#335

Additionally, the PR for this plan has been four months and it has still not been merged... cc @Zongzhe @officialasishkumar

[officialasishkumar]

Thanks for the review. Will look into it!

I am not sure if this PR can meet all the requirements of LFX,

Could you please clarify all the requirements so that I can start working on it?

cc: @Peefy @zong-zhe

[Peefy]

@officialasishkumar

The two most important things:

1. The design document is correct and merged
2. Develop corresponding features and tests, merge this PR, users can use kcl mod add <sub_package> --git foo or set sub package in the kcl.mod file to add sub modules for a git dependency.

The problem I currently see is that your design doc and code do not match, and I believe you should first design the correct solution.

cc @zong-zhe

[officialasishkumar]

@Peefy

The implementation of my design docs was in #387

[Peefy]

@Peefy

The implementation of my design docs was in #387

Can you provide detailed information on the association between PR and Issue? Why is it confusing that all your PR titles are the same?

[officialasishkumar]

Sure thing, I have updated the title.

kcl mod add <sub_package> --git foo

Since the idea was changed that is to download the entire repo, I asked in slack whether to use package command in add or run. I found run to be more suitable since the repo is download entirely and the user can change it whenever they want while running their program. So, I implemented it the same way.

[Peefy]

I think you should update design in this PR #335 and merge it firstly. I don't think user interfaces are right in this doc.

[officialasishkumar]

@Peefy
Okay, So which idea should I write down in the design doc?

kcl mod run --package test

or

kcl mod add --git <git-url> --commit <commit-hash> --package test

Will also put the package name in kcl.mod file.

I will update the code accordingly.

[Peefy]

#453 is merged. Do we still need to keep this PR? @officialasishkumar

[officialasishkumar]

No @Peefy