AstroCompress 项目使用教程

AstroCompress 项目使用教程

AstroCompress 🗜️ AstroJS compression utilities. Compress CSS, HTML, JavaScript and more! 项目地址: https://gitcode.com/gh_mirrors/as/AstroCompress

1. 项目的目录结构及介绍

AstroCompress 是一个为 Astro 项目提供压缩工具的集成。项目的目录结构如下：

AstroCompress/
├── .github/                # GitHub 相关配置
├── docs/                   # 文档目录
├── .npmignore              # NPM 忽略文件
├── CHANGELOG.md            # 更新日志
├── CODE_OF_CONDUCT.md      # 行为准则
├── CONTRIBUTING.md         # 贡献指南
├── DEPENDENTS.md           # 依赖文件
├── LICENSE                 # 许可证文件
├── README.md               # 项目介绍
├── package.json            # 项目包配置
└── tsconfig.json           # TypeScript 配置

• .github/：包含 GitHub 工作流程和模板。
• docs/：存放项目的文档。
• .npmignore：定义在发布到 NPM 时应该忽略的文件。
• CHANGELOG.md：记录项目的版本更新和更改历史。
• CODE_OF_CONDUCT.md：项目的行为准则。
• CONTRIBUTING.md：指导如何为项目贡献代码。
• DEPENDENTS.md：记录项目依赖。
• LICENSE：项目的开源许可证。
• README.md：项目的介绍和说明。
• package.json：Node.js 项目配置文件，包含项目信息和脚本。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

AstroCompress 项目没有特定的启动文件。它作为一个 Astro 集成存在，需要通过 Astro CLI 来添加到项目中。

3. 项目的配置文件介绍

项目的配置主要通过 astro.config.ts 文件来进行。以下是一个基本的配置文件示例：

// astro.config.ts
export default {
  integrations: [
    (await import('@playform/compress')).default({
      // 默认的压缩选项
      CSS: true,
      HTML: {
        'html-minifier-terser': {
          removeAttributeQuotes: false,
        },
      },
      Image: true,
      JavaScript: true,
      SVG: true,
      // 自定义压缩路径
      Path: [
        './dist',
        './Compress',
      ],
      // 排除特定文件
      Exclude: [
        'File.png',
        (File: string) => File === './Target/Favicon/Image/safari-pinned-tab.svg',
      ],
      // 控制日志级别
      Logger: 2,
    }),
  ],
};

在这个配置文件中：

• integrations 数组包含了一个 AstroCompress 集成的配置。
• 可以启用或禁用 CSS、HTML、JavaScript、SVG 和图像的压缩。
• Path 属性允许指定压缩的路径。
• Exclude 属性允许指定排除压缩的文件。
• Logger 属性可以设置日志级别，控制输出信息的详细程度。

AstroCompress 🗜️ AstroJS compression utilities. Compress CSS, HTML, JavaScript and more! 项目地址: https://gitcode.com/gh_mirrors/as/AstroCompress