Skip to content

一个强大的 VSCode 扩展,通过 SSH/SFTP 将工作空间文件快速同步到远程服务器。支持智能文件过滤、并发上传、校验和检查,以及完整的中文界面。

License

Notifications You must be signed in to change notification settings

pengcunfu/vscode-workspace-sync

Repository files navigation

WorkSpace Sync

一个用于将 VSCode 工作空间文件同步到远程服务器的插件。

功能特性

  • 📦 通过 SSH 将工作空间文件同步到远程服务器
  • ⚙️ 简单的 JSON 配置文件
  • 🚫 支持忽略特定文件和目录
  • 📊 实时同步进度显示
  • 🔒 支持密码认证

使用方法

1. 创建配置文件

  1. Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (Mac) 打开命令面板
  2. 输入 WorkSpace Sync: Create Configuration File
  3. 配置文件将在 .vscode/workspace-sync.json 中创建

2. 配置连接信息

编辑 .vscode/workspace-sync.json 文件,设置你的服务器信息:

{
    "host": "your host",
    "port": 22,
    "username": "root",
    "password": "password",
    "remotePath": "/www/wwwroot/yourhost",
    "ignore": [
        ".cursor",
        ".git",
        ".vscode",
        "web",
        "config/database.php"
    ]
}

配置说明:

  • host: 远程服务器地址
  • port: SSH 端口(默认 22)
  • username: SSH 用户名
  • password: SSH 密码
  • remotePath: 远程服务器上的目标路径
  • ignore: 要忽略的文件或目录列表(相对于工作空间根目录)

3. 同步文件

  1. Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (Mac) 打开命令面板
  2. 输入 WorkSpace Sync: Sync to Remote Server
  3. 等待同步完成

命令列表

  • WorkSpace Sync: Create Configuration File - 创建配置文件
  • WorkSpace Sync: Sync to Remote Server - 同步文件到远程服务器

注意事项

⚠️ 安全提醒:

  • 配置文件包含敏感信息(密码),请将 .vscode/workspace-sync.json 添加到 .gitignore
  • 建议使用 SSH 密钥认证代替密码(未来版本将支持)

安装

从源码安装

  1. 克隆此仓库
  2. 运行 npm install 安装依赖
  3. 运行 npm run compile 编译扩展
  4. F5 在扩展开发主机中运行

打包安装

  1. 安装 vsce: npm install -g @vscode/vsce
  2. 运行 vsce package 打包扩展
  3. 在 VSCode 中安装生成的 .vsix 文件

开发

# 安装依赖
npm install

# 编译
npm run compile

# 监视模式编译
npm run watch

# 运行代码检查
npm run lint

许可证

MIT

更新日志

1.0.0

  • 初始版本发布
  • 支持 SSH 文件同步
  • 支持忽略文件和目录
  • 配置文件管理

About

一个强大的 VSCode 扩展,通过 SSH/SFTP 将工作空间文件快速同步到远程服务器。支持智能文件过滤、并发上传、校验和检查,以及完整的中文界面。

Topics

Resources

License

Stars

Watchers

Forks