Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fdawgs/node-unrtf
Asynchronous node.js wrapper for the UnRTF RTF conversion program
https://github.com/fdawgs/node-unrtf
async converter html latex nodejs ps rtf rtf-converter rtf-to-html rtf-to-latex rtf-to-ps rtf-to-text rtf-to-wpml text txt unrtf wpml
Last synced: 10 days ago
JSON representation
Asynchronous node.js wrapper for the UnRTF RTF conversion program
- Host: GitHub
- URL: https://github.com/fdawgs/node-unrtf
- Owner: Fdawgs
- License: mit
- Created: 2020-10-21T08:52:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T18:42:59.000Z (24 days ago)
- Last Synced: 2024-12-18T23:11:15.557Z (11 days ago)
- Topics: async, converter, html, latex, nodejs, ps, rtf, rtf-converter, rtf-to-html, rtf-to-latex, rtf-to-ps, rtf-to-text, rtf-to-wpml, text, txt, unrtf, wpml
- Language: Rich Text Format
- Homepage: https://npmjs.com/package/node-unrtf
- Size: 1.97 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> **Note**
> An UnRTF v0.19.3 Windows binary is included with this module which, due to its age, has several issues,
> such as the [inability to convert RTF documents generated from 2007 onwards](https://github.com/Fdawgs/node-unrtf/issues/83), and a [bug in the
> `noPictures` option that still generates pictures](https://github.com/Fdawgs/node-unrtf/issues/81).
> It is recommended that whatever application is using the `node-unrtf` module is run in a Linux environment using the latest
> available UnRTF binaries, which do not have these bugs.
# node-unrtf
[](https://github.com/Fdawgs/node-unrtf/releases/latest/)
[](https://npmjs.com/package/node-unrtf)
[](https://github.com/Fdawgs/node-unrtf/actions/workflows/ci.yml)
[](https://coveralls.io/github/Fdawgs/node-unrtf?branch=main)
[](https://github.com/prettier/prettier)
> Asynchronous node.js wrapper for the UnRTF RTF conversion program
## Overview
[UnRTF](https://gnu.org/software/unrtf/) is a CLI program that allows for the manipulation and extraction of data from RTF documents such as converting RTF files to HTML or TXT.
The `node-unrtf` module provides an asynchronous node.js wrapper around said CLI program for easier use.
## Installation
Install using `npm`:
```bash
npm i node-unrtf
```
### Linux and macOS/Darwin support
For Linux and Mac users, you will need to download the `unrtf` binary separately.
An example of downloading the binary on a Debian system:
```
sudo apt-get install unrtf
```
For macOS, the binary can be installed with [Homebrew](https://brew.sh/):
```
brew install unrtf
```
## Example usage
Please refer to the [JSDoc comments in the source code](./src/index.js) or the [generated type definitions](https://www.npmjs.com/package/node-unrtf?activeTab=code) for information on the available options.
### Async Await
Example of an `async` `await` call to convert an RTF file to HTML in an ESM environment:
```js
import { UnRTF } from "node-unrtf";
const file = "test_document.rtf";
const unRtf = new UnRTF();
const options = {
outputHtml: true,
};
const res = await unRtf.convert(file, options);
console.log(res);
```
### Promise chaining
Example of calling unRTF.convert with a promise chain in a CJS environment:
```js
const { UnRTF } = require("node-unrtf");
const file = "test_document.rtf";
const unRtf = new UnRTF("/usr/bin");
const options = {
outputHtml: true,
};
unRTF
.convert(file, options)
.then((res) => {
console.log(res);
return res;
})
.catch((err) => {
console.error(err);
throw err;
});
```
### Removing images generated by UnRTF
As mentioned in the note block at the top of this README, the `noPictures` option does not remove images
when used with UnRTF < v0.20.4 and will write them to the current working directory.
To remove images generated by UnRTF it is recommended to use a globbing module such as [glob](https://www.npmjs.com/package/glob) in conjunction with the `node:fs/promises` module to find and remove them:
```js
import { unlink } from "node:fs/promises";
import { UnRTF } from "node-unrtf";
import { glob } from "glob";
const file = "test_resources/test_files/test-rtf-complex.rtf";
const unRtf = new UnRTF();
const options = {
outputHtml: true,
noPictures: true,
};
await unRtf.convert(file, options);
const files = await glob("*.{emf,wmf}");
await Promise.all(files.map((filed) => unlink(filed)));
```
## Contributing
Contributions are welcome, and any help is greatly appreciated!
See [the contributing guide](https://github.com/Fdawgs/.github/blob/main/CONTRIBUTING.md) for details on how to get started.
Please adhere to this project's [Code of Conduct](https://github.com/Fdawgs/.github/blob/main/CODE_OF_CONDUCT.md) when contributing.
## License
`node-unrtf` is licensed under the [MIT](./LICENSE) license.