chenyukai 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/commands/Install.js +1 -1
- package/commands/SshPublish.js +2 -2
- package/lib/Application.js +5 -5
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# ChenYuKai (cy)
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
🚀 **ChenYu CLI** 是一个轻量级、零配置的前端自动化部署工具。
|
|
8
|
+
只需一行命令,即可将构建产物(如 `dist` 文件夹)自动发布到 **阿里云 OSS** 或 **Linux SSH 服务器**。
|
|
9
|
+
|
|
10
|
+
## ✨ 核心特性
|
|
11
|
+
|
|
12
|
+
* **⚡️ 极速初始化**:`cy install` 智能检测项目构建目录(支持 `dist`, `build`, `output`),一键生成配置文件。
|
|
13
|
+
* **☁️ 阿里云 OSS**:支持自动上传、增量覆盖、MIME 类型自动识别、Windows/Mac 路径兼容。
|
|
14
|
+
* **🔌 SSH 服务器**:支持密钥/密码登录、自定义端口、并发传输、自动创建远程目录。
|
|
15
|
+
* **🛡 安全设计**:配置与代码分离,敏感密钥保留在本地,不随代码提交。
|
|
16
|
+
|
|
17
|
+
## 📦 安装
|
|
18
|
+
|
|
19
|
+
请确保你的环境已安装 [Node.js](https://nodejs.org/) (>= 12.0.0)。
|
|
20
|
+
|
|
21
|
+
### 使用 npm 安装
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# 注意:请将 chenyu-cli 替换为你实际发布的 npm 包名
|
|
25
|
+
npm install -g chenyu-cli
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
### 其他命令
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# 发布到阿里云 OSS
|
|
32
|
+
cy oss-publish
|
|
33
|
+
|
|
34
|
+
# 发布到服务器
|
|
35
|
+
cy oss-publish
|
|
36
|
+
|
|
37
|
+
```
|
package/commands/Install.js
CHANGED
|
@@ -4,7 +4,7 @@ const chalk = require('chalk');
|
|
|
4
4
|
|
|
5
5
|
module.exports = async (config, configPath) => {
|
|
6
6
|
// 1. 确定配置文件路径
|
|
7
|
-
// 如果 Application.js 传进来的 configPath 名字不对,这里强制修正为
|
|
7
|
+
// 如果 Application.js 传进来的 configPath 名字不对,这里强制修正为 cy.json
|
|
8
8
|
// 或者你可以直接信任 configPath (建议在 Application.js 里统一修改 CONFIG_FILE = 'cy.json')
|
|
9
9
|
const targetFile = path.join(process.cwd(), 'cy.json');
|
|
10
10
|
|
package/commands/SshPublish.js
CHANGED
|
@@ -5,13 +5,13 @@ const fs = require('fs');
|
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* SSH 发布逻辑
|
|
8
|
-
* @param {Object} config - 从
|
|
8
|
+
* @param {Object} config - 从 cy.json 读取的配置对象
|
|
9
9
|
*/
|
|
10
10
|
module.exports = async (config) => {
|
|
11
11
|
// 1. 校验配置
|
|
12
12
|
const sshConfig = config.ssh;
|
|
13
13
|
if (!sshConfig) {
|
|
14
|
-
console.error(chalk.red('❌ 配置错误:
|
|
14
|
+
console.error(chalk.red('❌ 配置错误: cy.json 中缺少 "ssh" 字段'));
|
|
15
15
|
return;
|
|
16
16
|
}
|
|
17
17
|
|
package/lib/Application.js
CHANGED
|
@@ -77,12 +77,12 @@ class Application {
|
|
|
77
77
|
}
|
|
78
78
|
|
|
79
79
|
showHelp() {
|
|
80
|
-
console.log(chalk.cyan('\n🔥
|
|
80
|
+
console.log(chalk.cyan('\n🔥 ChenYuKai CLI 使用指南:'));
|
|
81
81
|
console.log('-----------------------------------');
|
|
82
|
-
console.log(`
|
|
83
|
-
console.log(`
|
|
84
|
-
console.log(`
|
|
85
|
-
console.log(`
|
|
82
|
+
console.log(` cy install - 初始化配置 (生成 cy.json)`);
|
|
83
|
+
console.log(` cy oss-publish - 发布到阿里云 OSS`);
|
|
84
|
+
console.log(` cy ssh-publish - 发布到 SSH 服务器`);
|
|
85
|
+
console.log(` cy version - 查看当前版本`);
|
|
86
86
|
console.log('-----------------------------------\n');
|
|
87
87
|
}
|
|
88
88
|
}
|