Download the PHP package davidrjenni/scip-php without Composer
On this page you can find all versions of the php package davidrjenni/scip-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download davidrjenni/scip-php
More information about davidrjenni/scip-php
Files in davidrjenni/scip-php
Package scip-php
Short Description SCIP Code Intelligence Protocol (SCIP) indexer for PHP
License MIT
Informations about the package scip-php
scip-php
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
andcomposer.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:
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:
The protobuf compiler protoc
must be present to generate the bindings.
See github.com/sourcegraph/scip for further information.
All versions of scip-php with dependencies
ext-json Version *
composer-runtime-api Version ^2.2
composer/class-map-generator Version ^1.0
google/protobuf Version ^3.22
jetbrains/phpstorm-stubs Version ^2022.3
nikic/php-parser Version ^4.15