VS Code使用sftp插件实现上传打包文件

前言

对于小型公司,使用jenkins实现工作流就有点厚重了,尤其是内网测试的时候更显得厚重,所以很多公司依然在用FTP上传文件的方式。

网上流行的FTP自动化流,通常是使用node脚本:

  • 优势:可以自由配置,定制化程度高,可以根据打包命令来决定上传到哪个服务器,真正的一键完成。
  • 缺点:配置起来麻烦。

VS Code插件方案:

  • 优势:配置起来简单。
  • 缺点:因为不是自己写的脚本,所以可能不那么放心,如果开自动同步的话,你不晓得是否真的同步了以及是否同步完成了,如果改成手动同步,又不如node脚本一键完成那么方便。

所以你可以根据需要,自行选择使用哪个方案,下面我介绍一下VS Code插件方案。

原理

配置一个文件,让插件自动将项目的dist文件夹传到服务器。

安装

从扩展中搜索sftp,安装即可。

配置

Windows/Linux用Ctrl+Shift+P,Mac用Cmd+Shift+P打开命令面板,输入SFTP: config即可打开配置文件,只要修改任意字符,就会在工程根目录自动存入.vscode/sftp.json文件。默认是这样:

{
    "name": "My Server",
    "host": "localhost",
    "protocol": "sftp",
    "port": 22,
    "username": "username",
    "remotePath": "/",
    "uploadOnSave": true
}

大部分配置说明见:
https://github.com/liximomo/vscode-sftp/wiki/config
为什么说是“大部分”呢,因为有些配置项只出现在了:
https://marketplace.visualstudio.com/items?itemName=liximomo.sftp
比如profiles

我只说几个值得一说的:

路径的写法

本地路径省略最前的斜杠,比如"context": "dist",,远程路径不能省略最前的斜杠。

syncOption

  • delete:服务器文件夹如果有这次上传文件之外的文件,是否删除它们。通常应为false
  • skipCreate:服务器没有的文件和文件夹是否跳过创建,显然应该创建,因此设为false
  • ignoreExisting:跳过升级服务器已有的文件,显然也应该是false
  • update:它意思是,是否只当dist文件夹的某文件有更新,才上传到服务器。应当设为true,可以节省一些流量和时间。

watcher

  • files:需要监听的文件,因为要监听dist文件夹的所有文件,所以可设为**/*.*。另外,"uploadOnSave"一定要设为false
  • autoUpload:当然true
  • autoDelete:当然false

实例

根据官方说明,我配置成了这个样子:

[{
  "name": "213服务器",
  "context": "dist",
  "host": "39.101...(隐去)",
  "protocol": "sftp",
  "port": 8213,
  "username": "root",
  "password": "...(隐去)",
  "remotePath": "/opt/do/item/vue/yl_dist",
  "uploadOnSave": false,
  "syncOption": {
    "delete": false,
    "skipCreate": false,
    "ignoreExisting": false,
    "update": true
  },
  "ignore": [],
  "watcher": {
    "files": "**/*.*",
    "autoUpload": true,
    "autoDelete": false
  }
}]

配置完可能需要重启VS Code才能生效。

使用

现在你有两种选择,要么自动上传,要么手动上传。

  • 自动上传:就像上面的配置文件,其中保持autoUpload为true即可。别的什么都不用管。
  • 手动上传:autoUpload设为false,然后打包,然后在VS Code左侧资源管理器右击dist文件夹,点击SFTP: Sync Local -> Remote即可,VS Code下方会有上传进度提示。尤其其他文件夹,点击按钮的话,会有报错提示。

高级用法:使用profiles选项配置多个远程服务器

上面说的是一个dist对应一个服务器,即便多个配置对象,也只能是选择不同的dist目录,这样实践中显然不够用,所以你可以使用profiles选项,给同一个dist配置多个服务器,比如:

[{
  "name": "213服务器",
  "context": "dist",
  "host": "隐去",
  "protocol": "sftp",
  "port": 8213,
  "username": "root",
  "password": "隐去",
  "remotePath": "/opt/do/item/vue/yl_dist",
  "uploadOnSave": false,
  "syncOption": {
    "delete": false,
    "skipCreate": false,
    "ignoreExisting": false,
    "update": true
  },
  "ignore": [],
  "watcher": {
    "files": "**/*.*",
    "autoUpload": false,
    "autoDelete": false
  },
  "profiles": {
    "wai": {
      "remotePath": "/opt/do/item/vue/yl_dist"
    },
    "appli": {
      "remotePath": "/opt/do/item/vue/yl_dist/app"
    }
  }
}]

于是乎,现在你就有了3个profiles,分别是UNSET、wai、appli。

切换profile的办法:Windows/Linux用Ctrl+Shift+P,Mac用Cmd+Shift+P打开命令面板,输入SFTP: Set Profile,然后就可以切换。

总结

  1. 这个插件的文档写的太简单,需要猜。

  2. 切换profile需要手动,可能经常忘记切换,从而导致上传混乱,而node脚本根据你的yarn命令就已经能自我判断。

  3. 如果你的工作流足够简单,可以试试这个方案。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容