README

超级谨慎的 "Hello-World"

这个仓库是一个用于娱乐的过度谨慎的 Hello-World PHP 脚本。它包含以下测试和 CI 来仅显示 "Hello-World!"。

测试

支持的 PHP 版本以进行测试
- PHP v7.1, 7.2, 7.3, 7.4, 8.0 (, 夜间版)
- 详细信息见： .travis.yml
  - 注意：夜间构建版本（PHP8-dev）可能在 TravisCI 上失败。
单元测试 & 代码覆盖率
- PHPUnit
编码标准合规性
- PHP_CodeSniffer (PSR-2, PSR-12)
- PHP Mess Detector (避免复杂性)
PHP 静态分析
- PHPStan
- PSalm
- Phan
基准测试
- PHPBench
本地测试的 Docker
- 详细信息见： docker-compose.yml

使用的 CI

此仓库使用以下 CI。在使用之前，请首先注册您的仓库。

TravisCI：用于运行测试。
COVERALLS：用于代码覆盖率。
Scrutinizer CI：用于代码质量。

将此包用作模板/模板

如何

如何将其用作模板

TL; DR

复制，初始化项目，烟雾测试，添加 CI 的访问令牌，然后就可以开始了！

TS; DR

创建一个新副本。

选择以下命令中适合您的一个。

请注意，您需要指定项目名称。这将也是您的 "包名"。

# For composer user with NO Docker
composer create-project keinos/hello-world-tpl MyNewProject
cd MyNewProject

# For Docker and docker-compose user (No PHP nor composer user)
git clone https://github.com/KEINOS/TPL-PHP-HelloWorld.git MyNewProject
cd MyNewProject

初始化。

运行以下命令以初始化您的项目。这将重写包和 vendor 名称。例如：MyVendorName
```
rm -rf .git
git init
./.devcontainer/initialize_package.php MyVendorName
```
功能测试。

在开始之前，运行测试以检查其基本测试功能。
```
composer test -- --all --verbose
```
初始提交。

提交您的第一个更改。
```
git add .
git commit -m 'initial commit'
```
将仓库推送到 GitHub 并将其注册到以下 CI。
- TravisCI
- COVERALLS
将 COVERALLS.env.sample 重命名为 COVERALLS.env，位于 ./tests/conf 下。
从 COVERALLS 的设置中获取您的访问令牌，并将其放置/替换到 COVERALLS.env 中。
再次运行测试以查看 COVERALLS 的功能。
如果本地测试通过，则提交更改并推送。
如果 CI 上的测试通过，则开始构建您的项目。

通过 Docker 开发

此仓库可以通过 Docker 开发。运行

composer dev

或者，如果您使用 Visual Studio Code（即 VS Code）并且有 Docker，则 "Remote - Containers" 扩展 可用。

在这种情况下，您不需要在本地环境中安装包或甚至 PHP。

将 Microsoft 的 "Remote - Containers" 扩展添加到您的 VS Code 中。
git clone 此仓库到本地。
删除 .git 目录，并使用 git init 初始化一个新的。
通过以下方式在容器中打开文件夹：按 F1 -> "Remote-Containers: Reopen in Container"。

致谢

这个仓库受到了以下内容的极大启发

这个PHP模板引擎太谨慎了 @ Qiita

keinos / hello-world-tpl

维护者

详细信息