src-run / cocoa-transformer-library
简单的转换器和可缓存的转换器接口,附带抽象实现。
Requires
- php: ~7.0
Requires (Dev)
- codacy/coverage: ~1.0
- friendsofphp/php-cs-fixer: ~1.0
- fzaninotto/faker: ~1.6
- phpunit/phpunit: ~5.7
- psr/cache: ~1.0
- satooshi/php-coveralls: ~1.0
- sllh/php-cs-fixer-styleci-bridge: ~2.1
- symfony/cache: ~3.2
Suggests
- psr/cache: Required for the cacheable transformer implementation.
README
概览
欢迎! src-run/cocoa-transformer-library
包提供以下功能
简单的字符串转换器接口,附带抽象实现。
分组
我们使用灵感来自Willy Wonka的命名规范来命名我们的包分组名称。本包是cocoa分组的一部分,该分组是一组以“核心反射基类”和相关信息功能为重点的包。
如果您手头时间充裕,欢迎研究一些关于这个特定分组的无用细节。
JTT
本包代表了一个大量开源代码集合中的一个项目,这些代码在“SR”命名空间下发布,包括许多与框架无关的库、一系列Symfony扩展包以及一些独立发布。该项目由以下人员编写和维护:
快速入门
安装
通过Composer CLI显式要求获取代码,或者通过编辑您的composer.json文件来反映依赖关系并更新您的项目要求。例如,要使用CLI显式要求此项目,请使用以下命令。
$ composer require src-run/cocoa-transformer-library
或者,要将此项目添加到您的“composer.json”文件中,请在“require”部分添加以下内容。
require: { "src-run/cocoa-transformer-library": "dev-master" }
注意:不建议使用“dev-master”约束。请意识到这样做可能会允许引入具有向后不兼容的、破坏性更改的版本。相反,使用语义版本化和显式要求是良好的实践。例如,要要求版本1.0,您将使用^1.0
。
参考
API文档
本包的API参考文档可在我们的文档网站上找到(请参阅以下“附加链接”部分的“参考”行中的表格)。所有API文档都针对master分支自动编译,每当发生git push事件时。
计划为特定版本提供静态API参考,并在本包成熟并达到版本1里程碑时发布。.
上述API参考网站是使用称为Sami的可靠且成熟的CLI工具自动生成的。它经过严格和定期的测试,并用于一些大型项目,如Symfony Full-Stack Framework <see: https://src.run/go/symfony-api>,以及一些小型项目,如Twig <see: https://src.run/go/twig-api>。请参考Sami的存储库页面以了解如何在您的项目中使用它。
示例/教程
目前,除本README(本身也是从模板生成的)之外,没有“人工编写的”文档。待包稳定、可用人力以及外部用户实际需求后,我们可能会发布一个Read the Docs页面,包含官方文档、教程和额外资源。
贡献
讨论
对于一般咨询或讨论广泛的话题或想法,请在 Freenode 上寻找“robfrawley”。他总是乐于讨论语言级别的想法、项目可能的新的发展方向、新兴技术,以及天气。
问题
要报告问题或请求新功能,请使用项目问题跟踪器。在任何错误报告中提供尽可能多的信息。如果您几天内没有收到回复,请随时“ping”该话题(有时 Github 通知电子邮件会遗漏)。
代码
您在利用这个包时创建了额外的功能?太好了:将其发送回上游!请毫不犹豫地提交拉取请求!您的想象力以及我们在CONTRIBUTING.md文件中概述的要求是唯一的限制。
许可协议
本项目采用MIT 许可协议,这是一个FSF-和OSI-批准的、与GPL兼容的开源软件许可协议。请参阅与源代码一同分发的LICENSE文件以获取更多信息。