README

这是一个 composer 包的启动包。它包括一个包含一些基本设置的 composer.json 文件和一个包含关于包的基本信息的 README.md 文件。样板文件还包括用于测试和代码质量的 phpunit 和 PHP_CodeSniffer。

包含

安装

使用 composer create-project

composer create-project siktec/composer-starter-pack
# Edit composer.json and README.md to fit your needs
composer install
# Run tests
composer test
# Good to start coding

使用 git

git clone https://github.com/siktec-lab/composer-starter-pack <project-name>

使用 Github 模板： 点击 'Use this template' 并遵循说明

Composer 脚本

composer test 运行 tests 文件夹中的 phpunit 测试，使用 phpunit.xml 配置文件
composer test-coverage 运行 tests 文件夹中的 phpunit 测试，使用 phpunit.xml 配置文件并在 coverage 文件夹中生成覆盖率报告
composer testdox 与 composer test 相同，但输出更易于阅读且具有颜色
composer phpcs 使用 phpcs.xml 配置文件运行 phpcs
composer phpcs-colors 与 composer phpcs 相同，但具有颜色
composer phpcs-fix 运行 phpcbf 以修复代码风格
composer phpcs-report 运行 phpcs 并将结果保存到 phpcs.result

$ composer run-script --list
scripts:
  php-version   Show php version
  test          Run phpunit tests configuration phpunit.xml
  test-coverage Run phpunit tests with coverage
  testdox       Run phpunit tests with testdox and colors
  phpcs         Run phpcs against /src
  phpcs-colors  Run phpcs with colors
  phpcs-fix     Run phpcbf against /src to check for fixes
  phpcs-report  Run phpcs and save result to phpcs.result

快速参考

安装/更新/删除包

    # Install all packages - composer install
    composer install

    # Install a package - composer require <package-name>
    composer require siktec/composer-starter-pack
    
    # Update a package - composer update <package-name>
    composer update siktec/composer-starter-pack
    composer update # Update all packages
    
    # Remove a package - composer remove <package-name>
    composer remove siktec/composer-starter-pack

列出/检查已安装内容

    # List all installed packages - composer show
    composer show
    composer show | grep package-name # Search for a package

    # List all installed packages with details - composer show -a
    composer show -a

    # Get details about a package - composer show <package-name>
    composer show siktec/composer-starter-pack

运行脚本

    # List all scripts with descriptions:
    composer run-script --list

    # Run a script - composer run-script <script-name> or composer <script-name>
    composer run-script test
    composer test

    # Run a script with arguments - composer <script-name> -- <arguments>
    # the -- is needed to pass arguments to the script as composer will try to parse the arguments as composer options
    composer test -- --filter testFunctionName

运行 composer 脚本： composer run-script <script-name> 或 composer <script-name>
带参数运行 composer 脚本： composer <script-name> -- <arguments>
带参数和选项运行 composer 脚本： composer <script-name> -- <arguments> --<options>

siktec / composer-starter-pack

维护者

详细信息

README

包含

更多信息

安装

Composer 脚本

快速参考