README

Travis-CI	Codacy 评分	代码覆盖率	风格-CI

概述

欢迎！ src-run/wonka-bundle 软件包提供以下功能

这是一个类和接口的集合，旨在简化Symfony软件包的开发，包括高级软件包配置、内核编译器传递等辅助工具。

分组

我们使用灵感来自Willy Wonka的命名规范来为软件包分组命名。此软件包是 wonka 组 的一部分，该组是一系列专注于“核心反射基础类”及相关功能的软件包。

如果您手头有太多时间，欢迎您研究一些关于这个特定组 无用的细节。

JTT

此软件包代表一个在 大量开源代码 集合中的单个项目，这些代码在“SR”命名空间下发布，包含许多框架无关的库、一系列Symfony软件包以及一些独立的发布。该项目由以下作者和维护者创建和维护：

• Rob Frawley 2nd
• 合作者

快速入门

安装

通过在 Composer CLI 中显式地要求它，或通过编辑您的 composer.json 文件来反映依赖关系并更新您的项目要求来获取代码。例如，要使用CLI显式地要求此项目，请使用以下命令。

$ composer require src-run/wonka-bundle

或者，要将此项目添加到您的“composer.json”文件中，请在“require”部分添加以下内容。

require: {
	"src-run/wonka-bundle": "dev-master"
}

注意：不推荐使用“dev-master”约束。请记住，这样做可能会允许包含向后不兼容、破坏性更改的发布被拉入。相反，使用语义版本控制和显式要求是良好的实践。例如，要要求版本1.0，您将使用 ^1.0。

要启用软件包，通过在软件包数组中实例化 ScribeWonkaBundle 来将其注册到您的Symfony应用程序内核中。

// app/AppKernel.php
class AppKernel extends Kernel {
    public function registerBundles() {
        $bundles = [
            // ...
            new SR\WonkaBundle\WonkaBundle(),
        ];
        // ...
    }
}

配置

可以通过使用Symfony控制台命令 app/console（假设使用Symfony全栈框架和软件包注册）来引用可用的配置值。此外，此软件包提供了一个裸控制台可执行文件，可以通过调用以下命令来调用。

bin/wonka config:dump-reference scribe_wonka

参考

API 文档

本包的API参考可在我们的文档网站上找到（参见下文“附加链接”部分中表格的“参考”行）。每次发生git push事件时，所有API文档都会自动与主分支进行编译。

针对特定版本的静态API参考计划已定，一旦此包成熟并达到1.0版本里程碑，将发布。.

上述API参考网站是使用名为Sami的可靠且功能完善的CLI工具自动生成的。它经过严格和定期的测试，并被用于一些大型项目，例如Symfony全栈框架（https://src.run/go/symfony-api>），以及一些小型项目，例如Twig（https://src.run/go/twig-api>）。有关在您自己的项目中使用Sami的详细信息，请参阅Sami的仓库页面。

示例/教程

目前，除了本README（本身也是从模板生成的）外，没有“人工编写”的文档。在包稳定、可用工时和外部用户的实际需求确定后，我们可能会发布一个Read the Docs页面，其中包括官方文档、教程和额外资源。

贡献

讨论

要提出一般性询问或讨论广泛的主题或想法，请在Freenode上寻找“robfrawley”。他总是乐于讨论语言级想法、项目的新方向、新兴技术，以及天气。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中提供尽可能多的信息。如果您几天内没有收到回复，请随时“ping”该主题（有时GitHub通知电子邮件会丢失）。

代码

您在利用此包时创建了额外的功能？太棒了：将它发送回上游！请不要犹豫，提交拉取请求！您的想象力以及我们CONTRIBUTING.md文件中概述的要求是唯一限制。

许可

本项目根据MIT许可证许可，这是一个FSF和OSI批准的、与GPL兼容的、宽松的免费软件许可证。有关更多信息，请参阅与源代码一起分发的LICENSE文件。

附加链接

项目	结果/状态
稳定版本
开发版本
许可证
参考