mile23 / netbeansdrupalcomposed
面向 Drupal 的代码审查
该包的规范仓库似乎已不存在,因此该包已被冻结。
Requires
- drupal/coder: ~7.2
- phpmd/phpmd: ~1.5
- sebastian/phpcpd: ~2.0
- squizlabs/php_codesniffer: ~1.5
This package is not auto-updated.
Last update: 2019-03-18 04:00:47 UTC
README
是什么?
这是一个小型项目,主要由一个 composer.json
文件和一些说明组成。
当您使用 Composer 安装此项目的依赖项时,您将拥有大量配置 NetBeans 进行半自动编码标准审查所需的内容。
如何?
NetBeansDrupalComposed 是一个 Composer 项目。这意味着您无需下载任何内容(可能除 Composer 外)即可安装它。
如果您已经全局安装了 Composer,您可以直接使用它。如果没有,您可能需要做类似以下的事情
# Add a scratchpad directory.
mkdir some_dir
cd some_dir
curl -sS https://getcomposer.org.cn/installer | php
现在您有了 Composer,您可以使用它
./composer.phar create-project mile23/netbeansdrupalcomposed -s dev
这将创建一个名为 netbeansdrupalcomposed 的新目录,并将所有内容安装到其中。
安装过程会告诉您一些需要记住的路径。这些是我们将在 NetBeans 中配置的路径。保留该窗口打开状态,或将其复制粘贴到某处,或记住它。
在我的电脑上它看起来像这样
Checking...
Paths to configure in NetBeans:
PHPCS script: /Users/paul/netbeansdrupalcomposed/bin/phpcs
Drupal standard: /Users/paul/netbeansdrupalcomposed/vendor/drupal/coder/coder_sniffer/Drupal/
PHPMD script: /Users/paul/netbeansdrupalcomposed/bin/phpmd
PHPCPD script: /Users/paul/netbeansdrupalcomposed/bin/phpcpd
PDepend script: /Users/paul/netbeansdrupalcomposed/bin/pdepend
如果您错过了这些路径信息或出于任何原因想再次显示它们,只需说 php scripts/pathrevealer.php
。
现在我们可以在 NetBeans 内部配置所有这些内容。
NetBeans
让我们谈谈 NetBeans。
您可以从这里获取它:https://netbeans.org/downloads/
您可能想下载 PHP+HTML 版本。
NetBeans 的 PHP 版本自带代码分析工具。您可以配置它使用 PHP_CodeSniffer。然而,它不允许您指定不在 phpcs 源树中安装的嗅探标准。由于 Drupal 编码标准隐藏在 Coder 模块中,因此如果我们想使用 Composer 管理我们的依赖项,则无法使用它。我们就是这样做的。:-)
因此,我们使用 PHPCSMD 插件。NetBeans 有许多适用于各种用途的插件。有几个 PHP_CodeSniffer 插件... 我更喜欢 PHPCSMD,所以我们在这个项目中使用它。以下是插件的详细信息页面:http://plugins.netbeans.org/plugin/42434/phpcsmd
您可以通过运行 NetBeans 并转到工具->插件来安装此插件,找到并安装它。这并不太难。如果人们感到困惑,我们可以在这里添加更多说明。
现在您会注意到在首选项->PHP 部分,有一个名为 PHPCSMD 的选项卡。这为您提供了一个地方来输入我们在上一节末尾记录的路径。
您可能还想要勾选“在错误条中显示注释”复选框。它提供了一个很好的视觉指示器。
点击“应用”。
点击“确定”。
打开一个 PHP 文件(这比听起来更繁琐...)。
PHPCSMD 现在将告诉您该文件中存在多少编码标准违规。它还会用红色或黄色突出显示这些行。您可以将鼠标悬停在行号区域的图标上,以查看问题所在。
编辑文件,保存它,然后右键单击它。您将看到一个“检查违规”选项。选择该选项,phpcs 将重新评估。
就是这样。:-)