# lexifer

> A highly customizable wordgen for conlangers

Latest version **1.2.5** (published 2024-07-21) · MIT license · 0 weekly downloads

## Install

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

Provides the command `lexifer`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2024-07-21 |
| First published | 2021-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^12.22.0 \|\| ^14.17.0 \|\| >16.12.0 |
| Dependencies | 1 |
| Unpacked size | 106.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | bbrk24 |
| Maintainers | bbrk24 |
| Keywords | wordgen, lexifer |

## Links

- npm: https://www.npmjs.com/package/lexifer
- Repository: https://github.com/bbrk24/lexifer-ts
- Issues: https://github.com/bbrk24/lexifer-ts/issues
- npm.io page: https://npm.io/package/lexifer

## Dependencies (1)

- [yargs](https://npm.io/package/yargs.md) ^17.3.0

## Recent versions

- 1.2.5 (latest) — 2024-07-21
- 1.2.4 — 2024-06-28
- 1.2.3 — 2022-04-17
- 1.2.2 — 2022-04-05
- 1.2.1 — 2022-04-02
- 1.2.0 — 2021-12-31
- 1.1.4 — 2021-12-08
- 1.1.3 — 2021-11-11
- 1.1.2 — 2021-10-25

## README

# lexifer

[![version][1]][2] [![license][3]][4] [![issue count][5]][6]
[![git activity][7]][8]

This is a TypeScript implementation of William Annis's [Lexifer][9].

**For full documentation, see [the docs here][10].**

To compile this, run the build shell script. This can be run directly, or with
`yarn prepack`. Windows users may NOT use powershell, and will have to install
a proper shell terminal.  
To run only the tests, use `yarn test`.

## Using Lexifer in your project

To use Lexifer in your project, install it as with any other dependency:

```sh
# with npm
npm i -S lexifer

# with yarn
yarn add lexifer
```

And then, in your script:

```ts
// in CommonJS
const lexifer = require('lexifer');

// in TypeScript with --module commonjs, node12, or nodenext
import lexifer = require('lexifer');

// in ES modules
import lexifer from 'lexifer';
```

Lexifer comes bundled with its own type declarations. However, these
declarations are not parsed properly by TypeScript v3.5 and earlier. If you're
using Lexifer in a TypeScript project, you must be using TypeScript v3.6 or
later.

To use your project as a lexifer frontend, use the default export:

```js
import lexifer from 'lexifer';

console.log(
    lexifer(
        // ...inputs
    )
);
```

Other utilities, such as `lexifer.ClusterEngine`, are also exposed. See [the
API documentation][11] for full details.

[1]: https://img.shields.io/npm/v/lexifer
[2]: https://www.npmjs.com/package/lexifer "npm package"
[3]: https://img.shields.io/npm/l/lexifer
[4]: https://github.com/bbrk24/lexifer-ts/blob/master/LICENSE "license text"
[5]: https://img.shields.io/github/issues-raw/bbrk24/lexifer-ts
[6]: https://github.com/bbrk24/lexifer-ts/issues "issues page"
[7]: https://img.shields.io/github/commit-activity/m/bbrk24/lexifer-ts
[8]: https://github.com/bbrk24/lexifer-ts/commits "commit log"
[9]: https://github.com/wmannis/lexifer
[10]: ./docs/README.md
[11]: ./docs/api.md

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