首先我们需要安装 php cs fixer,下载 php-cs-fixer.phar
wget http://get.sensiolabs.org/php-cs-fixer.phar -o php-cs-fixersudo mv php-cs-fixer.phar /usr/local/bin/phpcssudo chmod +x /usr/local/bin/phpcs
接下来验证一下是否安装成功:
phpcs
显示:
usage: help [options] [--] []
则表明anything ok
说一下这个插件的目标:
保存文件时自动格式化php文件
组合键格式化php文件
首先需要一个sublime command,
class mikecommand(sublime_plugin.textcommand): def run(self, edit):
在 run 方法中, 调用 phpcs命令格式化php文件
class mikecommand(sublime_plugin.textcommand): def run(self, edit): view = self.view; filename = view.file_name(); suffix = os.path.splitext(filename)[1][1:] if suffix == 'php': fix(filename)def fix(phpfile): if not os.path.exists(phpfile): return; command = 'phpcs fix ' + phpfile; os.system(command);
因为在keymap文件中配置过组合键:
[ { "keys": [ "ctrl+alt+k" ], "command": "mike" }]
所以当我 使用 ctrl+alt+k 时代码便自动格式化
那么如何在自动保存是去执行响应的命令呢? sublime text 3 api 提供了eventlistener, 因此我们定义class 继承自sublime_plugin.eventlistener, 然后监听响应的事件即可:
class autoalign(sublime_plugin.eventlistener): def on_post_save(self, view): filename = view.file_name(); suffix = os.path.splitext(filename)[1][1:] if suffix == 'php': fix(filename)
关于更多事件类型, 请参考eventlistener
到现在, 一开始的两个目标都已经实现了, 我们可以看一下效果:
没有代码风格的php文件:
$value) { $ids = explode(',', $value); asort($ids); $fullpermutation[$key] = md5(implode(',', $ids)); } return $fullpermutation;}
ctrl+alt+k 或 ctrl+s后的文件:
$value) { $ids = explode(',', $value); asort($ids); $fullpermutation[$key] = md5(implode(',', $ids)); } return $fullpermutation;}
php-cs 默认是遵循 psr-2 的编码规范的, 但是也可以通过指定参数设置代码风格
但是这里存在另外一个问题, 所有的执行都是在主线程里面, 那么整体就会很卡, 我们需要在这种计算提取到额外的线程里面.
class handlerthread(threading.thread): def __init__(self, view): self.view = view threading.thread.__init__(self) def run(self): filename = self.view.file_name(); suffix = os.path.splitext(filename)[1][1:] if suffix == 'php': fix(filename)
那么更改监听 ctrl+s 的实现方式:
class autoalign(sublime_plugin.eventlistener): def on_post_save(self, view): thread = handlerthread(view) thread.start()
因为sublime text 3的api是用pyhton 3写的, 所以我们的实现都是使用的python 3.在使用 threading.thread, os.path.splitext, os.system时要记得引入相应的package.
import osimport os.pathimport threading
至此所有的工作皆已完成, 又可以愉快的写php了!
很多时候语言只是一种工具, 重要的还是想法,思路.我们知道我们可以创造很多新奇的东西, 但是我们却不知道idea从何而来.只有不断的积累学习, 眼界开阔之后, 你才会看到和想到更多.才能创造属于我们的价值~
相关文章：
7款开发者最常用的sublime text 3插件
详细介绍javascript开发者必备的10个sublime text插件的示例代码
sublime text3快捷键实用总结