davidrjenni/scip-php

SCIP Code Intelligence Protocol (SCIP) indexer for PHP

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

Requires

• php: ^8.2
• composer-runtime-api: ^2.2
• ext-json: *
• composer/class-map-generator: ^1.0
• google/protobuf: ^3.22
• jetbrains/phpstorm-stubs: ^2022.3
• nikic/php-parser: ^4.15

Requires (Dev)

• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-php-parser: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^10.0
• squizlabs/php_codesniffer: ^3.7

MIT

• codeintel
• scip

README

SCIP Code Intelligence Protocol (SCIP) indexer for PHP

This repository is indexed using itself and available on Sourcegraph.

And here is a Sourcegraph notebook with a demo and additional explanations.

Requirements

• scip-php must be run in the root directory of the project you want to index.
• It needs the composer.json and composer.lock files in the current working directory.
• Also, scip-php needs an up-to-date autoloader and the dependencies must be installed in the vendor directory.

Usage

Manual

Install scip-php with composer and the src binary. Then generate the SCIP index and upload it:

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

Private Sourcegraph Instance

To use a private Sourcegraph instance, set the SRC_ENDPOINT and SRC_ACCESS_TOKEN environment variables first.

Contributing

See the contributing guidelines.

Development

• Run composer lint to run all linters.
• Run composer test to run the unit tests.
• Run composer cover to generate a coverage report.

Inspecting the Output

• Install the scip cli from github.com/sourcegraph/scip.
• Run bin/scip-php to generate the SCIP index.
• Run scip snapshot to generate snapshot files which can be used for inspecting the output of the index.
• See the documentation for further functionality.

Bindings

The directory src/Bindings contains auto-generated bindings for SCIP. To update the bindings, download the protobuf schema for SCIP and regenerate the bindings:

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

The protobuf compiler protoc must be present to generate the bindings.

See github.com/sourcegraph/scip for further information.