locomotivemtl / charcoal-contrib-tinify
用于优化 JPG 和 PNG 资产的炭黑服务提供商。
0.1.3.2
2021-08-16 15:27 UTC
Requires
- php: >=5.6.0 || >=7.0
- locomotivemtl/charcoal-admin: >= 0.16.1
- tinify/tinify: ^1.5
Requires (Dev)
- php-coveralls/php-coveralls: ^2.0
- phpunit/phpunit: ^5.7 || ^6.5
- squizlabs/php_codesniffer: ^3.0
README
一个炭黑模块,用于向炭黑添加 tinify 集成。
目录
安装
首选(也是唯一支持)的方法是使用 Composer
$ composer require locomotivemtl/charcoal-contrib-tinify
依赖关系
必需
- PHP 5.6+:建议使用PHP 7。
- locomotivemtl/charcoal-admin ^0.14.1
- tinify/tinify ^1.5
PSR
配置
在您的项目配置文件中,像这样引入 tinify 模块:
{ "modules": { "charcoal/tinify/tinify": {} } }
定义一个 API 密钥,最好在 admin.json 配置文件中定义,因为它只在 CMS 中使用。您可以在 https://tinyjpg.com/developers 生成密钥。
{ "apis": { "tinify": { "key": "3FYkvsXPt7VlZbwHsMnHvmZg2g9jW8dJ" } } }
用法
待办事项
- 添加一个脚本来通过 cron 调度压缩任务。
开发
要安装开发环境
$ composer install
要运行脚本(phplint,phpcs 和 phpunit)
$ composer test
API 文档
- 自动生成的
phpDocumentor
API 文档可在以下位置找到
https://locomotivemtl.github.io/charcoal-contrib-tinify/docs/master/ - 自动生成的
apigen
API 文档可在以下位置找到
https://codedoc.pub/locomotivemtl/charcoal-contrib-tinify/master/
开发依赖项
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
编码风格
charcoal-contrib-tinify 模块遵循炭黑编码风格
- PSR-1
- PSR-2
- PSR-4,因此自动加载由 Composer 提供。
- phpDocumentor 注释。
- phpcs.xml.dist 和 .editorconfig 用于编码标准。
可以使用
composer phpcs
执行编码风格验证/强制执行。还有一个自动修复程序可用,使用composer phpcbf
。
致谢
许可证
炭黑根据 MIT 许可证授权。有关详细信息,请参阅LICENSE。