collective.recipe.vscode 0.1.9

介绍

collective.recipe.vscode 是为想要在基于 Visual Studio Code 开发并使用 python 自动补全和智能感应 功能的构建者提供的 buildout 配方。通常，即使提供了虚拟环境路径，python 路径中也可能没有 buildout 鸡蛋。这个工具不仅可以添加 eggs 路径作为 python extraPath，还可以根据项目管理 linter、自动格式化等 vscode 设置。

可能有人会问，为什么我们会使用这个工具，我们是否可以轻松创建 Visual Studio Code 项目设置（我们对 Visual Studio Code 配置有更好的了解）？我完全同意你的看法，但如果你想从 Visual Studio Code 的自动补全功能中获益（基本上我是自动补全的爱好者），你必须添加所有鸡蛋链接，如果项目规模很大（想想任何 Plone 驱动的项目），手动管理鸡蛋链接会很困难。此外，始终使用特定于项目的 linter 路径也是一个好的做法。例如，我的全局 flake8 linter 对我的 python3 项目不起作用！

安装

安装 collective.recipe.vscode 非常简单，只需在 buildout 中为 vscode 创建一个部分即可。在开始使用 collective.recipe.vscode 之前，如果你打算使用 linter 功能，请确保它们已添加到 eggs 部分或全局安装。

示例 Buildout

[buildout]
parts += vscode

[vscode]
recipe = collective.recipe.vscode
flake8-enabled = True
flake8-path = ${buildout:directory}/bin/flake8
black-enabled = True
black-args = ----line-length 88

您也可以使用以下方法自动将 vscode 配方包含到所有 buildout 中

修改/添加 ~/.buildout/default.cfg

[buildout]
_to_always_include_vscode = ${vscode:recipe}

[vscode]
recipe = collective.recipe.vscode
_to_remove_buildout_warning = ${buildout:_to_always_include_vscode}

链接

代码仓库

https://github.com/nazrulworld/collective.recipe.vscode

持续集成

https://travis-ci.org/nazrulworld/collective.recipe.vscode

问题跟踪器

https://github.com/nazrulworld/collective.recipe.vscode/issues

示例用法

使用标准设置安装vscode配方

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... develop =
...     %(test_dir)s/develop/vscodetest_pkg1
... eggs =
...     vscodetest_pkg1
...     zc.recipe.egg
...     zc.buildout
... parts = vscode
...
... [vscode]
... recipe = collective.recipe.vscode
... packages = %(test_dir)s/Products
... ignore-develop = False
... eggs = ${buildout:eggs}
... flake8-enabled = True
... flake8-path = ${buildout:directory}/bin/flake8
... black-enabled = True
... black-path = $project_path/bin/black
... black-args = --line-length 88
...              --skip-string-normalization
... """ % globals())
>>> output_lower = system(buildout + ' -c buildout.cfg').lower()
>>> "installing vscode." in output_lower
True
>>> 'tests/develop/vscodetest_pkg1' in output_lower
True
>>> ls(sample_buildout)
-  .installed.cfg
d  .vscode
d  bin
-  buildout.cfg
d  develop-eggs
d  eggs
d  parts
<BLANKLINE>
>>> import json
>>> import os
>>> from collective.recipe.vscode.recipes import mappings
>>> settings_dir = os.path.join(sample_buildout, ".vscode")
>>> vsc_settings = json.loads(read(settings_dir, 'settings.json'))
>>> len(vsc_settings[mappings['autocomplete-extrapaths']]) == 4
True
>>> mappings['flake8-enabled'] in vsc_settings
True
>>> vsc_settings[mappings['formatting-provider']] == "black"
True

VS Code设置，包含所有默认选项：

>>> os.unlink(os.path.join(settings_dir, 'settings.json'))
>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... develop =
...     %(test_dir)s/develop/vscodetest_pkg1
... eggs =
...     vscodetest_pkg1
...     zc.recipe.egg
... parts = vscode
...
... [vscode]
... recipe = collective.recipe.vscode
... eggs = ${buildout:eggs}
... """ % globals())
>>> output = system(buildout + ' -c buildout.cfg').lower()
>>> vsc_settings = json.loads(read(settings_dir, 'settings.json'))
>>> mappings['flake8-path'] not in vsc_settings
True
>>> len(vsc_settings[mappings['autocomplete-extrapaths']]) == 3
True

贡献者

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

• Matteo Parrucci

变更日志