`can-i-php` 开源项目入门指南

can-i-php 开源项目入门指南

can-i-php caniuse.com but for PHP - a searchable list of new and deprecated features in recent PHP versions 项目地址: https://gitcode.com/gh_mirrors/ca/can-i-php

本指南旨在帮助您快速了解并上手 Ross Wintle 开发的 can-i-php 项目。此项目相当于 PHP 版本的“Can I Use”，提供了一个可搜索的新特性和废弃功能列表，专为关注PHP 5.6以上版本特性支持情况的开发者设计。

1. 目录结构及介绍

can-i-php 的项目结构清晰，便于贡献和维护：

.
├── dist                    # 编译后的前端资源存放目录
├── images                  # 图片资源目录
├── src                     # 源代码目录，包括主要的JavaScript逻辑和HTML模板
│   ├── features.js         # 核心文件，包含了所有PHP新特性及其详细信息，按版本排序
│   └── ...
├── gitattributes           # Git属性配置文件
├── gitignore               # 忽略文件配置
├── prettierignore          # Prettier忽略格式化的文件清单
├── prettierrc.json         # Prettier的配置文件，用于代码风格统一
├── README.md               # 项目说明文档
├── _headers                # 用于设置HTTP头部的文件（如CORS）
├── build.sh                # 构建脚本，用于编译TailwindCSS等资源
├── watch.sh                # 文件监视脚本，实现资源变动自动重建
└── ...                     # 其他可能的辅助文件和配置

2. 项目启动文件介绍

该项目主要依赖于前端构建来展示数据，没有传统的服务器端启动文件。若要查看或运行项目，重点在于通过前端构建工具进行编译。虽然直接的“启动”概念不适用，但可以通过以下命令流程来预览项目：

• 构建步骤：
  1. 首先，克隆项目到本地。
  2. 在项目根目录下执行 npm install 来安装必要的依赖。
  3. 运行 ./build.sh 或者持续监视改动使用 ./watch.sh 来生成前端所需的静态资源。

完成后，您可以在浏览器中打开 dist 目录下的 index.html 来预览项目。

3. 项目的配置文件介绍

主要配置文件

• features.js - 这是项目的特色配置中心，它以JSON数组的形式存储了所有PHP新特性、被弃用或移除的信息。每个条目都包含了特性名、描述、关键词（用于搜索）、添加版本、废弃版本以及移除版本等关键信息，是理解和支持项目的核心。

• .prettierrc.json - 使用Prettier进行代码格式化，确保一致的代码风格。这并非直接影响项目运行的配置，但对于保持代码整洁有着重要作用。

• gitignore 和 prettierignore - 分别定义了Git和Prettier应忽略的文件或目录，对于日常开发和版本控制极为重要。

项目并未直接提供专门的配置文件来调整应用行为，其核心功能和展示逻辑主要由JavaScript源代码直接控制，这意味着修改逻辑或配置时，您将直接编辑相关 .js 文件。

通过上述指导，您现在应该对如何操作和理解 can-i-php 项目有了基本的认识。记得在贡献代码前遵循提供的构建流程和代码规范。

can-i-php caniuse.com but for PHP - a searchable list of new and deprecated features in recent PHP versions 项目地址: https://gitcode.com/gh_mirrors/ca/can-i-php