added the docs directory with design report for kpm sparse checkout

[d4v1d03]

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

• N
• Y

design doc for the issue #304

[coveralls]

Pull Request Test Coverage Report for Build 9358548895

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 43.549%

---

Totals
Change from base Build 9301223610:	0.0%
Covered Lines:	2474
Relevant Lines:	5681

---

💛 - Coveralls

[Peefy]

@d4v1d03
Is this a design document related to PreTest? I personally don't think there are many useful parts. At least it should include

• User interface/story: How users can add Git repository subdirectories as dependencies through the kcl command line, and what are the similarities and differences between its operation methods and other tools such as Cargo? What are the precautions for these.
• The KCL package manager currently uses go getter to add Git dependencies. How do we integrate with go getter to add Git subdirectories.

cc @zong-zhe Could you please give more comments?

[d4v1d03]

I'll update it accordingly

[officialasishkumar]

Hey @Peefy

other tools such as Cargo

Can you please elaborate on the tool in cargo which has similar functionality?

[Peefy]

Hey @Peefy

other tools such as Cargo

Can you please elaborate on the tool in cargo which has similar functionality?

Cargo, go, helm, terraform and etc.

[Peefy]

@d4v1d03 For developers, how they add the subfolder for git dependency through the KCL CLI? Could you please point it out in the design doc? cc @zong-zhe Cloud you please help review it?

[d4v1d03]

Could you pls point out why these tests are failing, is it because of low code cov? or anything else related to tests

[Peefy]

Could you pls point out why these tests are failing, is it because of low code cov? or anything else related to tests

You've changed some files, so the CI failed.

[Peefy]

Hello @d4v1d03 Please avoid directly modifying irrelevant code in the PR of the plan. The design looks good to me.

[d4v1d03]

yeah @Peefy , am really sorry, i'll take care for that in my next PR

[zong-zhe]

I just have a question, why don't you just merge these two parameters, something like this?

kcl mod add https://github.com/kcl-lang/modules/tree/main/nginx-ingress/restrict-ingress-anotations

I'm not sure what the problems will be behind such a merging, so you need to consider it or have a research.

[d4v1d03]

Done the changes, i did some research and gave thought to it but i don't think there won't be much of any problem. If any problems arise during implementation, i'll adjust accordingly.

[zong-zhe]

The problem here is the same as above.

[dependencies]
my_dependency = { git = "https://github.com/example/repo/path/to/package" }

Any problem like this ?

[d4v1d03]

made the changes

[zong-zhe]

This chapter I think could need more details.

[d4v1d03]

Ok, I'll add some on my own, though can you still point out some specific details (if any) you're looking for.

[d4v1d03]

@zong-zhe

[d4v1d03]

@Peefy , @zong-zhe please ignore the mess, just fixed my DCO, done the doc changes as per zong-zhe suggested.

[zong-zhe]

Hi @d4v1d03 😄

I've been looking at the cargo's design for this feature. I have some new findings to share with you. Hope this helpful.

I find this design comfortable to use. ❤️
It is here: https://doc.rust-lang.org/stable/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml

The cargo.toml looks like this:

[package]
name = "mypackage"
version = "0.0.1"

[dependencies]
bar = { git = "https://github.com/example/project", package = "foo" }

It will clone the git repo -> recursively look for all cargo.toml in the subdirectory -> find the package named foo -> load it.

I tried to use this feature on a project and found several advantages of this design.

• Compared to adding a subdirectory to the URL, this way the user does not need to bother typing the URL. The URL of the subdirectory in the browser is not directly usable. 😅

• When a user decides to use a dependency, he should probably know the package name of the dependency. 😆

[d4v1d03]

Hey @zong-zhe , yes my research over the design i proposed was inspired from cargo's package managemnet. The same reason i was clarifying regarding the recursive check on all kcl.mod files. Thanks a lot for clarification over this.😊