A simple ini parser that save comments and spaces
ini parser sh
npm
npm install js-ini-parser
yarn
yarn add js-ini-parser
pnpm
pnpm install js-ini-parser
`
Import:
`js
// ESM
import { parseIni } from "js-ini-parser";
// CommonJS
const { parseIni } = require("js-ini-parser");
`
Usage
$3
- parseIni(text, options)
- stringifyIni(object, options)
$3
`js
import { parseIni } from "js-ini-parser";
const ini =
;
const options = {
allowGlobalSection: true,
globalSectionName: 'global'
}
const parsed = parseIni(ini, options);
console.log(parsed);
`
$3
`ts
import * as fs from "node:fs/promises";
import { parseIni } from "js-ini-parser";
const options = {
allowGlobalSection: true,
globalSectionName: 'global'
}
const fileContent = await fs.readFile("./config.ini", "utf-8");
const parsed = parseIni(fileContent, options);
`
$3
`ts
import { parse, stringify } from "js-ini-parser";
const ini =
;
const options = {
allowGlobalSection: true,
globalSectionName: 'global'
}
const parsed = parseIni(ini, options);
// edit object
parsed.server.host = 'localhost'
// convert to text
const text = stringifyIni(parsed, {})
`
Contributing
- Clone this repository
- Install dependencies using pnpm install
- Run interactive tests using pnpm dev`