# harlaw

> Transform DSL (Lingvo Dictionary File) files to JSON. Formatting options available for custom output.

Latest version **1.1.12** (published 2024-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install harlaw
pnpm add harlaw
yarn add harlaw
bun add harlaw
```

## Health

**Score 40/100 (D)** — status: stable.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.1.12 |
| Published | 2024-11-19 |
| First published | 2020-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 0 |
| Unpacked size | 28.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | stscoundrel |
| Maintainers | stscoundrel |

## Links

- npm: https://www.npmjs.com/package/harlaw
- Repository: https://github.com/stscoundrel/harlaw
- npm.io page: https://npm.io/package/harlaw

## Recent versions

- 1.1.12 (latest) — 2024-11-19
- 1.1.11 — 2024-09-28
- 1.1.10 — 2024-04-05
- 1.1.9 — 2023-06-18
- 1.1.8 — 2023-04-15
- 1.1.7 — 2022-11-03
- 1.1.6 — 2022-09-10
- 1.1.5 — 2022-08-02
- 1.1.4 — 2022-07-01
- 1.1.3 — 2022-06-02
- 1.1.2 — 2022-05-06
- 1.1.1 — 2022-01-06
- 1.1.0 — 2021-11-10
- 1.0.6 — 2021-09-25
- 1.0.5 — 2021-05-13
- … 6 more at https://npm.io/package/harlaw/versions

## README

# Harlaw

Transform DSL (Lingvo Dictionary File) files to JSON. Formatting options available for custom output.

There are many dictionaries available as .dsl, but very few in easily consumable formats. Harlaw formats the dsl files to json with decent search/replace/remove options.

Also available for [Rust](https://github.com/stscoundrel/harlaw-rs)

### Install

`npm install harlaw`

### Usage


With default settings:

```javascript
import { toJson } from 'harlaw';

const input = `${__dirname}/dsl/myDictionary.dsl`
const output = `${__dirname}/json/myResult.json`

await toJson(input, output);

```
By default, Harlaw performs HTML transform to Lingvo markup. For example, `[b]` becomes `<strong/>` and `[i]` becomes `<i>`.

You can also pass on settings array to remove all extra markup:

```javascript
import { toJson, noMarkupSettings } from 'harlaw'

const input = `${__dirname}/dsl/myDictionary.dsl`
const output = `${__dirname}/json/myResult.json`

await toJson(input, output, noMarkupSettings)

```

For custom formatting needs, you can also pass on completely custom settings object:

```javascript
import { toJson } from 'harlaw';

const input = `${__dirname}/dsl/myDictionary.dsl`
const output = `${__dirname}/json/myResult.json`

const mySettings = {
  replaces: [ // Any key & value pair you with replaced.
    { search: '[b]', replace: '<strong>' },
    { search: '[/b]', replace: '</strong>' },
    { search: '[i]', replace: '<i>' },
    { search: '[/i]', replace: '</i>' },
    { search: '[p]', replace: '<span>' },
    { search: '[/p]', replace: '</span>' },
    { search: '{-}', replace: '-' },
    { search: '[ref]', replace: '<span class="reference">' },
    { search: '[/ref]', replace: '</span>' },
  ],
  removes: [ // Any elements to be replaced with ''
    '\\', '[/m]', '[m1]', '[m2]', '[m3]', '[m4]', '[m5]', '[m6]', '[m7]', '[m8]', '[m9]', '[m10]', '\t', '[u]', '[/u]',
  ],
}

await toJson(input, output, mySettings)

```


If you don't want physical json file, but would rather just do something with data, use `toArray`

```javascript
import { toArray } from 'harlaw';

const input = `${__dirname}/dsl/myDictionary.dsl`

const mySettings = {
	//optional
}

const dictionary = await toArray(input, mySettings)

console.log(dictionary)

```

### Custom read settings.

Sometimes default settings for Node do not parse files correctly. For example, the file might be encoded in non-standard format. This might mean you need to pass custom settings for file reading.

You can use custom read options by passing readOptions object to settings. It will be passed to [createReadStream](https://nodejs.org/api/fs.html#fs_fs_createreadstream_path_options).


```javascript
import { toJson, toArray } from 'harlaw';

const input = `${__dirname}/dsl/myDictionary.dsl`
const output = `${__dirname}/json/myResult.json`

const mySettings = {
  replaces: { /* optional */ },
  removes: { /* optional */ },
  readSettings: {
    encoding: 'utf16le',
    // any other valid option.
  },
}

// Works with JSON.
await toJson(input, output, mySettings)

// ...And with array.
const dictionary = await toArray(input, mySettings)

console.log(dictionary)

```


#### What's in the name?

In G.R.R Martins "A Song Of Ice And Fire", there is a character named Rodrik Harlaw. He is mockingly called "The Reader". That is what my Harlaw does too; reads things no one else cares about.

---
_Source: https://npm.io/package/harlaw · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._