@nsis/nlf

Parser and stringifier for NSIS Language Files

Usage no npm install needed!

<script type="module">
  import nsisNlf from 'https://cdn.skypack.dev/@nsis/nlf';
</script>

README

nlf

npm npm CI David

Parser and stringifier for NSIS Language Files (.nlf)

Installation

yarn add @nsis/nlf || npm install @nsis/nlf

Usage

// ECMAScript Import
import * as NLF from "@nsis/nlf";

// CommonJS Require
const NLF = require("@nsis/nlf");

Example usage in script:

// Read an NSIS Language File
const languageFile = fs.readFileSync(
  "Contrib/Language files/English.nlf",
  "utf8"
);

const languageObj = NLF.parse(languageFile);
const languageNew = NLF.stringify(languageObj);

Methods

parse

Usage: parse(string, options)

Parses an NSIS Language File, constructing an object or JSON string that's easy to query

options.stringify

Type: boolean

Return a stringified object

options.minify

Type: boolean

Minifies a stringified object, requires options.stringify to be true

stringify

Usage: stringify(Object|string)

Converts an NSIS Language File object or JSON string to an .nlf string

Related

  • nlf-cli - command-line tool to convert NLF files

License

This work is licensed under The MIT License