INI 格式解析与序列化工具技术文档

1. 安装指南

环境要求

• Node.js 版本 >= 12.x

安装步骤

1. 打开终端或命令行工具。
2. 使用 npm 或 yarn 安装该工具：

npm install ini-parser-serializer

或

yarn add ini-parser-serializer

2. 项目使用说明

基本使用

该工具允许你读取、修改和写入 INI 格式的文件。以下是一个基本的使用示例：

import { writeFile, readFile } from 'node:fs/promises';
import { stringify, parse } from 'ini-parser-serializer';

// 读取 INI 文件
let text = await readFile('./Original.ini', {
    encoding: 'utf-8'
});

// 解析文本数据为对象
const config = parse(text);

// 修改数据对象
config.scope = 'local';
config.database.database = 'use_another_database';
config.paths.default.tmpdir = '/tmp';
delete config.paths.default.datadir;
config.paths.default.array.push('fourth value');

// 将数据对象序列化为 INI 格式
text = stringify(config, {
    section: 'section'
});

// 写入修改后的 INI 文件
await writeFile('./Modified.ini', text);

示例 INI 文件

; 这是一个被忽略的注释
scope = global

[database]
user = dbuser
password = dbpassword
database = use_this_database

[paths.default]
datadir = /var/lib/data
array[] = first value
array[] = second value
array[] = third value

修改后的 INI 文件

[section]
scope=local
[section.database]
user=dbuser
password=dbpassword
database=use_another_database
[section.paths.default]
tmpdir=/tmp
array[]=first value
array[]=second value
array[]=third value
array[]=fourth value

3. 项目 API 使用文档

parse

将给定的 INI 字符串转换为嵌套的数据对象。

const object = parse(`<INI Text>`);

stringify

将给定的数据对象编码为 INI 格式的字符串。

stringify(object, {
    whitespace: false, // 是否在 `=` 前后插入空格
    align: false,      // 是否对齐 `=` 字符
    section: 'section', // 全局项的标识符
    sort: false,       // 是否按字母顺序排序
    newline: false,    // 是否在每个节头后插入换行符
    platform: 'win32', // 使用的换行符平台
    bracketedArray: true // 是否在数组键后附加 `[]`
});

safe / unsafe

将给定的字符串转换为在 INI 文件中安全使用的键或值，或反向操作。

safe(`"unsafe string"`); // -> \"unsafe string\"
unsafe(`\\"safe string\\"`); // -> "safe string"

4. 项目安装方式

通过 npm 或 yarn 安装：

npm install ini-parser-serializer

或

yarn add ini-parser-serializer

安装完成后，你可以在项目中导入并使用该工具。