docx-rs

docx-rs copied to clipboard

A .docx file `writer` with Rust/WebAssembly.

Installation

Rust

[dependencies]
docx-rs = "0.4"

Browser/Node.js

$ yarn add docx-wasm

Example

Rust

use docx_rs::*;

pub fn hello() -> Result<(), DocxError> {
    let path = std::path::Path::new("./hello.docx");
    let file = std::fs::File::create(path).unwrap();
    Docx::new()
        .add_paragraph(Paragraph::new().add_run(Run::new().add_text("Hello")))
        .build()
        .pack(file)?;
    Ok(())
}

Browser

import { saveAs } from "file-saver";

// // Note that a dynamic `import` statement here is required due to webpack/webpack#6615,
import("docx-wasm").then((w) => {
  const { buffer } = new w.Docx()
    .addParagraph(
      new w.Paragraph().addRun(new w.Run().addText("Hello world!!"))
    )
    .build();
  saveAs(new Blob([buffer]), "hello.docx");
});

Node.js

const w = require("docx-wasm");
const { writeFileSync } = require("fs");

const { buffer } = new w.Docx()
  .addParagraph(new w.Paragraph().addRun(new w.Run().addText("Hello world!!")))
  .build();

writeFileSync("hello.docx", buffer);

More examples

• Minimum
• Indent
• Alignment
• Font
• Numbering
• Table
• Comment
• Image
• History

Development

Requirements

• Node.js 16+
• yarn 1+
• wasm-pack0.10.1 (https://rustwasm.github.io/wasm-pack/)
• insta (https://github.com/mitsuhiko/insta)

Examples

You can run example with following code. Please see examples directory.

$ cargo run --example [EXAMPLE_NAME]

For Example if you want to run hello example. Please run following command.

$ cargo run --example hello

So you can see output file in output directory.

Testing

Rust

Please run following command.

make lint && make test

If snapshot testing is failed, fix code or update snapshot files. (See https://insta.rs/).

$ cargo-insta review

Then re run test.

$ make test

Wasm

Please run following command.

$ cd docx-wasm && yarn install && yarn test

If snapshot testing is failed, fix code or update snapshot files. (See https://jestjs.io/docs/snapshot-testing).

$ yarn test -- --updateSnapshot

Features

• [x] Paragraph
  • [x] Alignment
  • [x] Indent
  • [x] Numbering
• [x] Run
  • [x] Bold
  • [x] Size
  • [x] Font
  • [x] Color
  • [x] Highlight
  • [x] Underline
  • [x] vanish
  • [x] Italic
  • [x] TextBorder
• [x] Break
• [x] Header
• [x] Footer
• [x] Comment
• [x] Image
• [x] Style
• [x] Table
• [x] HIstory
• [x] Table of contents
• [ ] Section
• [ ] Textbox