Skip to content

Commit 159edb7

Browse files
authored
Merge pull request #258 from zong-zhe/deprecated-kpm-cmd
chore: make the kpm cli deprecated
2 parents 4edf455 + ac858d5 commit 159edb7

17 files changed

+95
-0
lines changed

README-zh.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,37 @@
1313
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen">
1414
</p>
1515

16+
# 注意 !
17+
18+
KPM CLI 将在 v0.8.0 版本后被弃用,并且 KPM CLI 将被 KCL CLI 替代 - https://github.com/kcl-lang/cli.
19+
20+
受到影响的部分如下所示:
21+
22+
```
23+
kpm
24+
├── pkg
25+
│ ├── api
26+
│ ├── client
27+
│ ├── cmd # KPM CLI 将在 v0.8.0 版本后被弃用.
28+
│ ├── constants
29+
│ ├── env
30+
│ ├── errors
31+
│ ├── git
32+
│ ├── oci
33+
│ ├── opt
34+
│ ├── package
35+
│ ├── reporter
36+
│ ├── runner
37+
│ ├── semver
38+
│ ├── settings
39+
│ ├── utils
40+
│ └── version
41+
├── scripts
42+
├── test
43+
│ └── e2e # KPM CLI 的 e2e 测试将在 v0.8.0 版本后被弃用.
44+
├── ......
45+
```
46+
1647
## 介绍
1748

1849
`kpm` 是 KCL 包管理器。`kpm` 会下载您的 KCL 包的依赖项、编译您的 KCL 包、制作可分发的包并将其上传到 KCL 包的仓库中。

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,37 @@
1313
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen">
1414
</p>
1515

16+
# NOTE !
17+
18+
The KPM CLI will be deprecated after v0.8.0, and the KPM CLI will be replaced by the KCL CLI - https://github.com/kcl-lang/cli.
19+
20+
The affected parts are shown below:
21+
22+
```
23+
kpm
24+
├── pkg
25+
│ ├── api
26+
│ ├── client
27+
│ ├── cmd # The KPM CLI will deprecated after v0.8.0.
28+
│ ├── constants
29+
│ ├── env
30+
│ ├── errors
31+
│ ├── git
32+
│ ├── oci
33+
│ ├── opt
34+
│ ├── package
35+
│ ├── reporter
36+
│ ├── runner
37+
│ ├── semver
38+
│ ├── settings
39+
│ ├── utils
40+
│ └── version
41+
├── scripts
42+
├── test
43+
│ └── e2e # The e2e test for KPM CLI will deprecated after v0.8.0.
44+
├── ......
45+
```
46+
1647
## Introduction
1748

1849
`kpm` is the KCL package manager. `kpm` downloads your KCL package's dependencies, compiles your KCL packages, makes packages, and uploads them to the kcl package registry.

pkg/cmd/cmd_add.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_flags.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
22
// This file provides all the flags in the kpm cli.
3+
//
4+
// Deprecated: The entire contents of this file will be deprecated.
5+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
6+
37
package cmd
48

59
const FLAG_INPUT = "input"

pkg/cmd/cmd_import.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_init.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_login.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_logout.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_metadata.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_pkg.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_pull.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_push.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_push_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_run.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/cmd/cmd_update.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2023 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package cmd
46

pkg/version/version.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright 2022 The KCL Authors. All rights reserved.
2+
// Deprecated: The entire contents of this file will be deprecated.
3+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
24

35
package version
46

pkg/version/version_test.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1+
// Deprecated: The entire contents of this file will be deprecated.
2+
// Please use the kcl cli - https://github.com/kcl-lang/cli.
13
package version
24

35
import "testing"
46

7+
// Deprecated: This function will be removed in a future version.
58
func TestGetVersionInStr(t *testing.T) {
69
tests := []struct {
710
name string

0 commit comments

Comments
 (0)