README

Serenata

免费、开源的PHP代码辅助服务器

Serenata是一个免费、开源的服务器，它通过在PHP代码库上执行静态分析来提供代码辅助，例如自动完成、代码检查、代码导航和工具提示。它通过与语言服务器协议通过套接字与其客户端进行通信来实现其目标。

Serenata之前被称为“PHP Integrator”。

请参阅维基以及网站，其中包含更多用户信息，包括希望实现客户端的开发者和通过编辑器和IDE使用服务器的程序员。

安装

稳定版

PHAR（推荐）

从发布页面下载您PHP版本的最新稳定PHAR。

Composer

composer create-project "serenata/serenata" serenata --prefer-dist --no-dev

不稳定版

您可以通过下载最新管道的工件或通过Composer安装最新主分支或从Git拉取来找到最新的不稳定的PHAR构建。

运行

大多数用户只需要通过他们喜欢的编辑器或IDE运行Serenata。有关可用的客户端及其安装方法的列表，请参阅网站。

如果您正在编写新的客户端，请阅读以下部分。

PHAR

php -d memory_limit=1024M distribution-7.x.phar --uri=tcp://127.0.0.1:11111

其中 x 是您下载PHAR的PHP版本。

Composer

php -d memory_limit=1024M <Serenata folder>/bin/console --uri=tcp://127.0.0.1:11111

命令行参数

端口

您可以选择任何您想要的端口，只要它不在您的系统上使用即可。

主机

127.0.0.1 将在 localhost 上运行，这意味着服务器只能从您的本地机器访问。这通常是您想要的。

您可以使用其他IP地址，如 0.0.0.0，以便服务器在网络或（例如Docker）容器内可访问。(这里适用通常的安全课程，因为网络中的任何人都可以连接到服务器并请求有关您的代码库的信息。)

性能

请参阅维基的这一部分。

在其他项目中使用

如果您希望将服务器部分作为您（现有）项目的一部分，并使用其中包含的类以供您自己的目的使用

composer require "serenata/serenata"

请注意，服务器主要被设计为应用程序，而不是库。但是，仍然可以自己实例化所需的类。

您可能还对Serenata套件中的其他库感兴趣。在将来，更多的代码可能会从服务器中分离出来，成为适当的、独立的库。

贡献

由于这个项目本身范围很大，存在很多潜力和工作领域，因此欢迎贡献！请查看我们的贡献指南。