Sublime 从本地上传文件或是目录到服务器

人生苦短,我用Python。

问题描述:
最近在使用ST3进行代码编写,之前用的是Atom或是vscode,并没有一个十分中意的代码编辑器,主要还是看使用的心情吧,有的时候使用不同的编辑器。由于部分的代码是在本地机器(Macbook pro)上编写测试,等到测试成功或是可以使用的时候直接上传到服务器(n多核+高性能GPU+ubutun)上面,让服务器去跑实验,这个时候就需要使用ssh将本地的代码文件或是目录上传到server上面。但是每次都用scp去上传总是有点麻烦,所以这里就直接编写了一个ST3的插件,让插件自动完成代码的上传。(这是受启发于pycharm pro的功能)

前置条件:

  1. ssh已经将你的公钥上传到server中,所以能够实现免密登录。并且在terminal中scp的时候也可以不用输密码;
  2. 熟悉python编码;
  3. 本地代码库有专门的地址
  4. server上面有也专门的代码库,一般是存放在你的个人用户目录下

预期结果:

  1. 打开文件编辑之后,通过鼠标右键或是快捷键就能将刚才编辑的文件上传到服务器上。
  2. 通过再ST3的左边的打开的目录列表上通过鼠标右键的菜单能够将选中的目录下的所有文件上传到服务器上。
  3. 可以设置多个服务器,当服务器只有一个的时候默认上传到这个服务器上;当有多个服务器的时候,在使用菜单或是快捷键的时候会出现选择服务器的界面,能够将文件上传到指定的服务器上。

下一步实现:

  1. 能够在ST3的terminal中显示scp的传输过程(python调用shell命令scp的时候不显示过程)
  2. 将服务器的配置写在配置文件中而不是硬编码
  3. 将用户名和密码放在配置文件中

插件结果截图:


传输单文件到server上面
将文件和文件夹传递到服务器

怎样编写插件

ST3的插件使用的语言主要是Python,在ST3的安装目录中我们可以发现两个python文件sublime.pysublime_plugin.py这两个不同的插件。这两个module就是ST3在生成新插件的时候默认导入的两个模块,里面包含了不同的class。通过继承不同的class来完成插件的编写。

定义好了插件之后,还可以添加顶部菜单,右键菜单以及编辑器左边的sidebar的右键菜单。同时还能够定义不同的快捷键来调用相应的功能。由于文件和文件夹通过scp使用的是不同的命令,所以这里需要定义两个不同的插件。

首先,我们通过ST3的[tools]->[Developers]->[New Plugin] 来自动的建立一个插件,可以看出自动建立的插件是一个python的类,并且这个类继承的TextCommand类,插件的主要功能代码就是写在run函数里面。将你需要实现的功能写在这个run函数里面。主要就是解析path,然后构造server上面的代码的path。再添加到一个右键快捷菜单中。

文件夹下的所有文件

此时并不能得到的一个特定的文件路径,如果需要将某个文件下的所有文件全部上传到server上的话,那么scp中需要带有一个-r的命令表示递归。需要找到文件夹的路径,我们在左侧的project树状结构中可以使用右键菜单,但是我们可以看到,系统自带的只有[new file][rename][new folder][delete folder][find in folder]这几种菜单,通过查看API(非官方的API)可以看到通过定义一个Side Bar.sublime-menu 文件就能将菜单和功能相互连接起来了。

快捷键和邮件菜单

通过上图我们可以看出sublime-keymap是快捷键的配置,sublime-menu是右键菜单的配置,Context指的是在文件编辑状态下的右键菜单,而Side Bar则是左边的树状结构中的右键菜单设置。

最后,通过编码和连接菜单就能完成预期得功能,接下来就是利用这个插件代替你打开命令行手敲scp命令了。happy coding

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

推荐阅读更多精彩内容