lin3s / pattern-library-builder
库,提供了一个优雅且简单的方式来为前端组件开发模式库
v0.2.1
2018-07-12 12:22 UTC
Requires
- php: ^7.1
- symfony/framework-bundle: ^2.8 || ^3.0
- symfony/templating: ^2.8 || ^3.0
Requires (Dev)
- lin3s/php-cs-fixer-config: ^1.0
- phpspec/phpspec: ^3.3
- symfony/asset: ^3.3
- symfony/console: ^3.3
- symfony/debug-bundle: ^3.3
- symfony/twig-bundle: ^3.3
- symfony/var-dumper: ^3.3
- symfony/web-server-bundle: ^3.3
- symfony/yaml: ^3.3
This package is not auto-updated.
Last update: 2024-09-13 13:15:25 UTC
README
库,提供了一个优雅且简单的方式来为前端组件开发模式库
特性
- 由 YAML 配置驱动的模式库构建器
- 有观点且可扩展的默认模板
- 使用已存在的渲染器来列出颜色、排版、图标
- 在响应式视图中渲染 twig 模板,并使用自动生成的 twig "include" 方法和 HTML 输出
- 轻松创建您的渲染器以适应您的需求
- 独立 PHP 库,内置 Symfony 集成
安装
安装此扩展包最简单的方法是使用 Composer
$ composer require lin3s/pattern-library-builder
文档
所有文档存储在
docs
文件夹中。
测试
此库通过 PHPSpec(PHP 的 SpecBDD 框架)进行测试。
运行以下命令以启动测试
$ vendor/bin/phpspec run -fpretty
此外,您还可以轻松启动一个简单的应用程序来测试此扩展包提供的功能。
$ cd tests/Application && bin/console server:start --docroot=web $ open http://127.0.0.1:8000/design-system
贡献
此库遵循 PHP 编码标准,所以拉取请求需要执行 Fabien Potencier 的 PHP-CS-Fixer。此外,如果 PR 创建了非 PHP 文件,请记住您需要手动添加许可证头部。为了简化,我们提供了一个 Composer 脚本,该脚本封装了与此过程相关的所有命令。
$ composer run-script cs
还有关于为此扩展包贡献的方针。拉取请求必须逐步解释,以便于审查过程,以便接受和合并。新方法或代码改进必须与 PHPSpec 测试配对。