项目介绍
这是一个针对 VS Code 编辑器的文件同步更新插件,实时监听文件保存修改,并将其同步到指定目录下的对应文件。
主要功能
- 实时监听:插件会监控指定的文件目录,实时监听文件的保存和修改事件。
- 文件同步:当文件被修改时,插件会自动将其同步到用户指定的目标目录。
- 灵活配置:
- 监听目录:用户可以配置多个监听目录,支持绝对路径和相对路径。
- 同步目录:用户必须指定一个同步目录,插件会将修改的文件同步到该目录。
- 忽略文件和目录:用户可以配置需要忽略的文件、目录和类型,支持正则表达式。
- 匹配文件类型:用户可以配置需要同步的文件类型,支持正则表达式。
使用说明
- 安装插件:在 VS Code 中安装该插件。
- 配置插件:
- 打开设置,配置
updateMapFile.monitorDirs 为需要监听的文件目录。
- 配置
updateMapFile.targetDir 为需要同步的目标目录。
- 可选配置
updateMapFile.ignorePatterns 和 updateMapFile.matchPatterns 来设置忽略和匹配的文件类型。
- 启动同步:点击状态栏中的同步按钮,开始文件同步。
- 停止同步:再次点击状态栏按钮,停止文件同步。
默认配置
以下是插件的默认配置项及其说明:
updateMapFile.monitorDirs : [] (默认值为空数组,用户可以配置多个监听目录)
updateMapFile.targetDir : "" (必须配置,指定同步的目标目录)
updateMapFile.ignorePatterns : ["target/", "node_modules/", "\\.git", "\\.cursor/"] (默认忽略的文件和目录)
updateMapFile.matchPatterns : ["\\.js$", "\\.html$", "\\.jsp$", "\\.css$", "\\.json$", "\\.txt$", "\\.svg$", "\\.ts$", "\\.vue$"] (默认匹配的文件类型)
注意事项
- 确保您有权限访问指定的文件和目录。
- 在目标目录中,插件会自动创建必要的目录结构。
日志输出
插件会在输出面板中记录操作日志,用户可以查看文件同步的状态和错误信息。
贡献
欢迎提交问题和建议,或为项目贡献代码。
License
该项目遵循 MIT 许可证。
| |