davidrjenni/scip-php

SCIP 代码智能协议 (SCIP) 的 PHP 索引器

维护者

详细信息

github.com/davidrjenni/scip-php

源代码

问题

安装: 254

依赖关系: 0

建议者: 0

安全: 0

星星: 7

关注者: 5

分支: 2

开放问题: 1

v0.0.2 2023-04-23 18:03 UTC

Requires

Requires (Dev)

MIT b12e0593cfb72e703fdd71f4ad91869502eeb566

codeintelscip

This package is auto-updated.

Last update: 2024-10-01 12:50:44 UTC

README

CI Coverage OpenSSF Scorecard License: MIT Packagist Version PHP Version Docker Image Version Docker Image Size Contributors

SCIP 代码智能协议 (SCIP) 的 PHP 索引器

此存储库使用自身进行索引，并可在 Sourcegraph 上找到。

以下是一个包含 演示 和额外说明的 Sourcegraph 笔记本。

要求

  • scip-php 必须在您要索引的项目根目录中运行。
  • 它需要在当前工作目录中的 composer.json 和 composer.lock 文件。
  • 此外，scip-php 需要最新的自动加载器，并且依赖关系必须安装在 vendor 目录中。

用法

手动

使用 composer 和 src 二进制文件安装 scip-php。然后生成 SCIP 索引并将其上传

composer require --dev davidrjenni/scip-php
vendor/bin/scip-php
src code-intel upload

私有 Sourcegraph 实例

要使用私有 Sourcegraph 实例，首先设置 SRC_ENDPOINT 和 SRC_ACCESS_TOKEN 环境变量。

贡献

查看 贡献指南。

开发

  • 运行 composer lint 来运行所有检查器。
  • 运行 composer test 来运行单元测试。
  • 运行 composer cover 来生成覆盖率报告。

检查输出

  • 从 github.com/sourcegraph/scip 安装 scip cli。
  • 运行 bin/scip-php 生成 SCIP 索引。
  • 运行 scip snapshot 生成可用于检查索引输出的快照文件。
  • 有关更多功能，请参阅 文档。

绑定

目录 src/Bindings 包含 SCIP 的自动生成的绑定。要更新绑定，请下载 SCIP 的 protobuf 模式并重新生成绑定

wget -O src/Bindings/scip.proto https://raw.githubusercontent.com/sourcegraph/scip/main/scip.proto
composer gen-bindings

必须存在 protobuf 编译器 protoc 以生成绑定。

有关更多信息，请参阅 github.com/sourcegraph/scip。