jeremykendall/phpctagger

为 composer 项目创建 ctags

0.0.7 2013-01-17 14:34 UTC

This package is auto-updated.

Last update: 2024-08-25 05:37:15 UTC


README

PHP Ctagger 是一个 Composer 脚本,它将为项目的可自动加载库以及该项目的依赖项创建一个 ctags 标签文件。标签文件将放置在项目的根目录下的 /tags 目录中。

安装

唯一支持的安装方法是使用 Composer。由于 PHP Ctagger 旨在用于开发环境(并且仅在 Composer 处于 dev 模式时才会创建标签文件),因此 PHP Ctagger 必须作为 dev 依赖项安装。将以下内容添加到您的 composer.json 中。

{
    "require-dev": {
        "jeremykendall/phpctagger": "dev-master"
    }
}

PHP Ctagger 利用 Composer 的 脚本 功能。为了使 PHP Ctagger 能够构建您的标签文件,脚本还必须添加到您的 composer.json 中。

{
    "scripts": {
        "post-install-cmd": [
            "PhpCtagger\\Composer\\Script\\Ctagger::ctag"
        ],
        "post-update-cmd": [
            "PhpCtagger\\Composer\\Script\\Ctagger::ctag"
         ]
    }
}

在这个例子中,脚本将在安装后和更新后运行。

完成上述步骤后,运行 composer update --dev 安装 PHP Ctagger 并构建您的标签文件。

ctags 版本

确保您正在运行 最新版本的 ctags。这对于 OSX 特别重要,因为默认情况下安装了错误的 ctags 版本

限制

这个初始实现非常简单,它只为在 /vendor/composer/autoload_namespaces.php 中有路径条目的库和依赖项创建标签。

Vim

为了使用您的新标签文件,vim 需要知道它的位置。请确保使用您最舒适的方式加载您的标签文件。我已经在我的 .vimrc 中放置了以下内容

set tags=tags

进行中

这个项目处于 alpha 阶段,我还不确定这甚至是否是一个好主意。到目前为止,玩起来很有趣,这是好事。欢迎拉取请求、新问题、评论和建设性批评。