dankempster/template-php-component

用于开发新组件/包的模板工作区。包括travis-ci.org、Scrutinizer.com和Coveralls.io的配置。

维护者

详细信息

github.com/dankempster/template-php-component

源代码

问题

安装: 6

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

类型：项目

dev-master / 1.0.x-dev 2015-01-02 15:28 UTC

Requires

  • php: >=5.4

Requires (Dev)

MIT f3a40e79700789629064ad15a57f540a44820c88

coverallsscrutinizerworkspace templatetravis-ci

This package is auto-updated.

Last update: 2024-09-23 05:53:27 UTC

README

用法

使用composer安装模板

$ composer create-project dankempster/workspace-component myvendor-mycomponent/
$ cd myvendor-mycomponent/

替换发行文件

$ rm composer.json readme.md
$ mv composer.json.dist composer.json
$ touch readme.md

该模板使用示例包名Acme\Component。通过以下文件进行搜索和替换，将其替换为您的包名：

  • composer.json
    • acme/component - my-vendor/my-component
    • Acme\\Component\\ - MyVendor\\MyComponent\\
  • phpunit.xml.dist
    • Acme/Component - MyVendor/MyComponent

现在编写您自己的readme.md文件。

目录结构

结构简单且易于理解

|- docs/
|- src/
|- tests/
|- .gitignore.yml
|- .composer.json
|- phpunit.xml.dist
`- Readme.md

CI和SaaS

此模板还包括以下配置文件：

  • Travis CI
  • Scrutinizr
  • Coveralls

所有这些对开源项目都是免费的。

提示：还可以查看SensionInsight - 无需配置。

Travis CI

Travis CI是一个具有GitHub集成的托管持续集成服务。因此，当托管存储库审查拉取请求或推送时，Travis CI将启动构建并运行您的项目测试。

Scrutinizer

是一个代码质量分析工具，实际上是一套工具。与Travis CI一样，Scrutinizer与GitHub集成，因此当托管存储库收到任何推送或拉取请求时，将执行“检查”。此工作区不包含任何默认的Scrutinizer配置（我喜欢在我的帐户中使用全局配置），但Travis已配置（.travis.yml）将代码覆盖率报告（clover.xml）发送到Scrutinizer。

Coveralls

Coveralls是一个仅用于代码覆盖率可视化的辅助工具。此存储库使用satooshi/php-coveralls作为开发依赖项，在Travis构建后上传覆盖率报告到Coveralls。