kadokweb/minify

PHP 中的 CSS & JavaScript 压缩工具。删除空白字符,去除注释,合并文件(包括 @import 语句和 CSS 文件中的小资产),并优化/缩短一些常见的编程模式。

资助包维护!
kadokweb

1.0.0 2022-01-14 12:49 UTC

This package is auto-updated.

Last update: 2024-09-14 20:40:48 UTC


README

Build status Code coverage Code quality Latest version Downloads total License

捐赠/支持:支持

删除空白字符,去除注释,合并文件(包括 @import 语句和 CSS 文件中的小资产),并优化/缩短一些常见的编程模式,例如

JavaScript

  • object['property'] -> object.property
  • true, false -> !0, !1
  • while(true) -> for(;;)

CSS

  • @import url("http://path") -> @import "http://path"
  • #ff0000, #ff00ff -> red, #f0f
  • -0px, 50.00px -> 0, 50px
  • bold -> 700
  • p {} -> removed

并且它还附带了一个庞大的测试套件。

用法

CSS

use KadokWeb\Minify;

$sourcePath = '/path/to/source/css/file.css';
$minifier = new Minify\CSS($sourcePath);

// we can even add another file, they'll then be
// joined in 1 output file
$sourcePath2 = '/path/to/second/source/css/file.css';
$minifier->add($sourcePath2);

// or we can just add plain CSS
$css = 'body { color: #000000; }';
$minifier->add($css);

// save minified file to disk
$minifiedPath = '/path/to/minified/css/file.css';
$minifier->minify($minifiedPath);

// or just output the content
echo $minifier->minify();

JS

// just look at the CSS example; it's exactly the same, but with the JS class & JS files :)

方法

可用的方法,对于 CSS & JS 压缩器,包括

__construct(/_ 重载路径 _/)

对象构造函数接受 0、1 或多个文件路径,或者甚至是完整的 CSS/JS 内容,需要进行压缩。所有传递的 CSS/JS 将合并成一个压缩文件。

use KadokWeb\Minify;
$minifier = new Minify\JS($path1, $path2);

add($path, /_ 重载路径 _/)

这大致等同于构造函数。

$minifier->add($path3);
$minifier->add($js);

minify($path)

这将压缩文件内容,将结果保存到 $path 并返回结果内容。如果省略 $path 参数,则结果将不会写入任何地方。

注意:如果您有带有相对路径的 CSS(导入、图像等),您应始终指定目标路径!然后这些相对路径将根据新路径进行调整。

$minifier->minify('/target/path.js');

gzip($path, $level)

压缩并可选地保存到文件,就像 minify() 一样,但它还执行 gzencode() 以压缩内容。

$minifier->gzip('/target/path.js');

setMaxImportSize($size) (CSS 仅)

CSS 压缩器会自动嵌入引用的文件(如图像、字体等),以便它们不需要通过多个连接进行获取。

但是,对于非常大的文件,单独加载它们可能更好(如果它们被包含,这将增加 CSS 加载时间。)

此方法允许将导入到压缩 CSS 中的文件的最大大小设置为(以 KB 为单位)。默认大小为 5。

$minifier->setMaxImportSize(10);

setImportExtensions($extensions) (CSS 仅)

CSS 压缩器会自动嵌入引用的文件(如图像、字体等),以便它们不需要通过多个连接进行获取。

此方法允许指定文件的类型及其数据:MIME 类型。

默认嵌入的文件类型是 gif、png、jpg、jpeg、svg、apng、avif、webp、woff 和 woff2。

$extensions = array(
    'gif' => 'data:image/gif',
    'png' => 'data:image/png',
);

$minifier->setImportExtensions($extensions);

安装

如果您使用 Composer 管理项目的依赖项,只需将 kadokweb/minify 添加到您的 composer.json 文件中即可。

composer require KadokWeb/minify
"kadokweb/minify": "1.0.*"

虽然推荐使用 Composer,但您实际上可以 以任何方式包含这些文件

许可证

Minify 是 MIT 许可的。

挑战

如果你对我的博客上关于构建此项目时遇到的一些技术挑战感兴趣,你可能想看看我写的相关内容