plone.recipe.sublimetext 1.3.0

简介

plone.recipe.sublimetext 是为喜爱 ST3 并希望在开发基于 Buildout 的 Python 项目时拥有类似 Python IDE 特性的开发者准备的构建脚本。这个工具将帮助他们根据项目创建适当的路径位置分配的 SublimeText 设置。目前，plone.recipe.sublimetext 提供了对 Anaconda（一个包含所有功能的集成包）、Jedi、Sublimelinter、Sublimelinter-Flake8、Sublimelinter-Pylint 的支持设置。可能会有人提出一个一般性的问题，即为什么我们会使用这个工具，我们是否可以轻松创建 ST3 项目设置（我们对 ST3 的配置有更好的了解）？我完全同意你的看法，但如果你想从 Anaconda 或 Jedi 的 Python 自动完成功能中受益（基本上我是一个自动完成功能的爱好者），你必须添加 Anaconda 或 Jedi 的所有路径设置，如果项目规模很大（想想任何 Plone 驱动的项目），那么手动管理 eggs 链接将变得很困难（除了 Sublimelinter-Pylint 之外，还需要添加到 sys.path 中的路径列表以查找模块）。

安装

安装 plone.recipe.sublimetext 非常简单，只需在 buildout 中创建一个 sublimetext 部分。在使用 plone.recipe.sublimetext 之前，请确保 Jedi、Sublimelinter、Sublimelinter-Flake8 和/或 Sublimelinter-Pylint 插件已经安装在你的 ST3 上。如果你还没有设置 ST3，可以参考 [这里] 的完整说明。Flake8 检查器需要全局可用的 flake8 可执行文件（除非你打算使用本地的 flake8），还建议你安装一些出色的 flake8 插件（flake8-isort、flake8-coding、pep8-naming、flake8-blind-except、flake8-quotes 等，更多可以在 pypi 中找到）。

示例 Buildout

[buildout]
parts += sublimetext

[sublimetext]
recipe = plone.recipe.sublimetext
eggs = ${buildout:eggs}
jedi-enabled = True
sublimelinter-enabled = True
sublimelinter-pylint-enabled = True

链接

代码仓库

https://github.com/collective/plone.recipe.sublimetext

持续集成

https://travis-ci.org/collective/plone.recipe.sublimetext

问题跟踪器

https://github.com/collective/plone.recipe.sublimetext/issues

已知问题

• Sublimelinter-Flake8 可能会停止工作，如果安装了 flake8-plone-api，直到 1.2 版本，flake8-plone-api 不支持 SublimeText（linting），请参阅 pull request 这里。这意味着即将推出的版本可能会支持。这可能发生在您使用全局或 virtualenv flake8 的情况下。您可以在 ST3 控制台中看到错误。

  flake8_plone_api-1.2-py2.7.egg/flake8_plone_api.py", line 16, in run
  with open(self.filename) as f:
  IOError: [Errno 2] No such file or directory: 'stdin'

示例用法

最小构建：

>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
...     zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... jedi-enabled = True
... """)
>>> system(buildout + ' -c buildout.cfg')
>>> import os
>>> os.path.exists('plone-recipe-sublime.sublime-project')
True

标准构建

>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
...     zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... jedi-enabled = True
... sublimelinter-enabled = True
... sublimelinter-flake8-enabled = True
... sublimelinter-flake8-executable = ${buildout:directory}/bin/flake8
... """)
>>> system(buildout + ' -c buildout.cfg')
>>> import json
>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> 'Sublimelinter.linters.flake8.enable' in settings['settings']
True

多 linters 和没有项目名称

>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
...     zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... eggs = ${buildout:eggs}
... jedi-enabled = True
... sublimelinter-enabled = True
... sublimelinter-flake8-enabled = True
... sublimelinter-flake8-executable = ${buildout:directory}/bin/flake8
... sublimelinter-pylint-enabled = True
... """)
>>> system(buildout + ' -c buildout.cfg')

（项目文件名应为之前生成的 plone-recipe-sublime.sublime-project）

>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> 'pylint' in settings['Sublimelinter']['linters']
True

使用 Anaconda（linting、自动补全）进行所有目的，其余部分未使用

>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
...     zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... anaconda-enabled = True
... anaconda-pep8-ignores =
...     N802
... """)
>>> system(buildout + ' -c buildout.cfg')
>>> import json
>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> 'build_systems' in settings.keys()
True
>>> 'extra_paths' in settings['settings'].keys()
True
>>> settings['settings']['anaconda_linting']
True
>>> settings['settings']['use_pylint']
False

带有 flake8 参数的 flake8 linters

>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
...     zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... jedi-enabled = True
... sublimelinter-enabled = True
... sublimelinter-flake8-enabled = True
... sublimelinter-flake8-executable = ${buildout:directory}/bin/flake8
... sublimelinter-flake8-args = max-complexity=10  max-line-length=119
...                             exclude=docs,*.egg.,omelette
... """)
>>> system(buildout + ' -c buildout.cfg')

（项目文件名应为 plone-recipe-sublime.sublime-project）

>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> len(settings['settings']['Sublimelinter.linters.flake8.args']) == 3
True

贡献者

• Md Nazrul Islam<email2nazrul@gmail.com>，原作者

• Sune Brøndum Wøller [sunew]

变更日志