Squeezeit - Python CSS 和 JavaScript 压缩工具技术文档

1. 安装指南

Squeezeit 是一个用于压缩和合并 CSS 和 JavaScript 文件的 Python 工具。以下是安装步骤：

1. 下载项目：首先，从 GitHub 下载 Squeezeit 项目。

2. 安装依赖：确保你的系统已经安装了 Python 和 setup.py 所需的依赖。

3. 安装 Squeezeit：在项目根目录下运行以下命令进行安装：

   python setup.py install
   

4. 验证安装：安装完成后，可以通过运行 squeezeit --help 来验证是否安装成功。

2. 项目的使用说明

Squeezeit 通过 YAML 配置文件来管理 CSS 和 JavaScript 文件的压缩与合并。以下是使用步骤：

1. 创建配置文件：在项目根目录下创建一个 config.yaml 文件，用于指定源文件目录、输出目录等配置。

2. 配置 bundle 文件：在 config.yaml 中指定的 bundles 目录下，创建 YAML 文件来定义每个 bundle 的内容。

3. 运行 Squeezeit：在命令行中运行以下命令来执行压缩和合并操作：

   squeezeit /path/to/config.yaml
   

4. 查看输出：Squeezeit 会在指定的输出目录中生成压缩后的文件，并生成一个 info.yaml 文件，包含每个 bundle 的详细信息。

3. 项目 API 使用文档

Squeezeit 主要通过命令行工具进行操作，没有提供直接的 API 接口。以下是命令行工具的使用方法：

• 基本用法：

  squeezeit /path/to/config.yaml
  

  该命令会根据 config.yaml 中的配置，压缩和合并指定的 CSS 和 JavaScript 文件。

• 查看帮助：

  squeezeit --help
  

  该命令会显示 Squeezeit 的使用帮助信息。

4. 项目安装方式

Squeezeit 的安装方式非常简单，只需通过 setup.py 进行安装即可。以下是详细步骤：

1. 下载项目：从 GitHub 下载 Squeezeit 项目。

2. 进入项目目录：

   cd /path/to/squeezeit
   

3. 安装项目：

   python setup.py install
   

4. 验证安装：

   squeezeit --help
   

   如果安装成功，会显示 Squeezeit 的使用帮助信息。

5. 配置文件详解

5.1 主配置文件 config.yaml

config.yaml 是 Squeezeit 的主配置文件，用于指定源文件目录、输出目录等配置。以下是一个示例配置：

# 主 bundle 配置
# 所有路径都是相对于此文件的

# 日志级别（标准 Python 日志级别：DEBUG, INFO, WARNING 或 CRITICAL）
logging: INFO

# 指定 bundle YAML 文件的目录（这些文件指定了你的 bundle 及其内容）
bundles: ./config/

# 输出 bundle 和 bundle 信息文件的目录
output: ./bundles/

# 源文件目录
css: ./css/
javascript: ./js/

# bundle 文件名是否包含内容的 MD5 哈希值（例如：[bundlename]-[md5 hash].js - 参见 bundle 信息文件）
hashfilenames: true

5.2 Bundle 配置文件

Bundle 配置文件位于 config.yaml 中指定的 bundles 目录下，用于定义每个 bundle 的内容。以下是一个示例配置：

# 路径是相对于 'source file' 目录的
includes:
    css:
        - clear.css
        - fonts.css
        - bootstrap.css
        - main.css
    javascript:
        - jquery/core.js # 你也可以使用子文件夹
        - main.js

5.3 Bundle 信息文件

Squeezeit 会在输出目录中生成一个 info.yaml 文件，包含每个 bundle 的详细信息。以下是一个示例：

media:
    css:
        md5: 3c716f5993efd3257fe17b219c6b6ecd # MD5 是从合并后的数据生成的，在压缩之前
        output:
            gz: media-3c716f5993efd3257fe17b219c6b6ecd.min.css.gz
            min: media-3c716f5993efd3257fe17b219c6b6ecd.min.css
            raw: media-3c716f5993efd3257fe17b219c6b6ecd.css
        size:
            gz: 328
            min: 704
            raw: 821
    javascript:
        md5: 9581d699b54badf07d4e1f60f77dca7d
        output:
            gz: media-9581d699b54badf07d4e1f60f77dca7d.min.js.gz
            min: media-9581d699b54badf07d4e1f60f77dca7d.min.js
            raw: media-9581d699b54badf07d4e1f60f77dca7d.js
        size:
            gz: 33142
            min: 93837
            raw: 93939

6. 总结

Squeezeit 是一个简单易用的 Python 工具，能够有效地压缩和合并 CSS 和 JavaScript 文件。通过合理的配置，你可以轻松地管理网站的前端资源，提升页面加载速度。希望本文档能帮助你更好地理解和使用 Squeezeit。