CSS 解析器与序列化工具使用文档

本文档将详细介绍如何安装和使用 CSS 解析器与序列化工具，包括安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

首先，确保您的系统中已经安装了 Node.js。然后，使用以下命令通过 npm 安装 CSS 解析器：

npm install css

2. 项目使用说明

以下是如何使用 CSS 解析器的基本示例：

const css = require('css');

// 解析 CSS 字符串
const obj = css.parse('body { font-size: 12px; }');

// 将 AST 转换回 CSS 字符串
const cssString = css.stringify(obj);

3. 项目 API 使用文档

css.parse(code, [options])

此函数接收一个 CSS 字符串并返回一个抽象语法树（AST）对象。

options 参数如下：

• silent: 如果设置为 true，则在解析错误时不会抛出异常，而是将错误收集在 parsingErrors 属性中。
• source: 指定包含 css 的文件的路径，有助于提供更详细的错误信息和源映射。

css.stringify(object, [options])

此函数接收一个 AST 对象（由 css.parse 生成）并返回一个 CSS 字符串。

options 参数如下：

• indent: 用于缩进输出的字符串，默认为两个空格。
• compress: 如果设置为 true，则会省略注释和多余的空白。
• sourcemap: 如果设置为 true，则返回一个包含源映射的 CSS 输出。当生成源映射时，建议使用 css.parse 的 source 选项。
• inputSourcemaps: 默认启用，读取输入文件中引用的源映射。如果需要禁用，可以设置为 false。

示例

const ast = css.parse('body { font-size: 12px; }', { source: 'source.css' });

const css = css.stringify(ast);

const result = css.stringify(ast, { sourcemap: true });
console.log(result.code); // CSS 字符串
console.log(result.map); // 源映射对象

错误处理

解析过程中抛出的错误具有以下属性：

• message: 完整的错误消息，包括源位置。
• reason: 不包含位置的错误消息。
• filename: 如果传入了 options.source，则为该值，否则为 undefined。
• line: 错误发生的行号。
• column: 错误发生的列号。
• source: 无法解析的代码片段。

如果设置了 silent 选项，则错误会被收集在 parsingErrors 属性中。

4. 项目安装方式

项目安装方式已在“安装指南”部分详细说明，使用 npm 命令安装即可：

npm install css

通过本文档，用户应能够顺利安装、使用 CSS 解析器，并了解其 API 的使用方法。