Package Health Score

56 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.8.0	\|	03/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.0	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.5	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.5.0	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.0	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (25,827)

GitHub Stars: 391
Forks: 143
Contributors: 20

Direct Usage Popularity

The npm package html-to-docx receives a total of 25,827 downloads a week. As such, we scored html-to-docx popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package html-to-docx, we found that it has been starred 391 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the html-to-docx repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like html-to-docx is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 88
Open PR: 8
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of html-to-docx based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for html-to-docx is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 13 Direct
Versions: 53
Install Size: 4.8 MB
Dist-tags: 1
# of Files: 12
Maintainers: 1
TS Typings: No

html-to-docx has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

html-to-docx

html-to-docx is a js library for converting HTML documents to DOCX format supported by Microsoft Word 2007+, LibreOffice Writer, Google Docs, WPS Writer etc.

It was inspired by html-docx-js project but mitigates the problem of documents generated being non-compatiable with word processors like Google Docs and libreOffice Writer that doesn't support altchunks feature.

html-to-docx earlier used to use libtidy to clean up the html before parsing, but had to remove it since it was causing so many dependency issues due to node-gyp.

Disclaimer

Even though there is an instance of html-to-docx running in production, please ensure that it covers all the cases that you might be encountering usually, since this is not a complete solution.

Currently it doesn't work with browser directly, but it was tested against React.

Installation

Use the npm to install foobar.

npm install html-to-docx

Usage

await HTMLtoDOCX(htmlString, headerHTMLString, documentOptions, footerHTMLString)

full fledged examples can be found under example/

Parameters

htmlString <String> clean html string equivalent of document content.
headerHTMLString <String> clean html string equivalent of header. Defaults to <p></p> if header flag is true.
documentOptions
- orientation <"portrait"|"landscape"> defines the general orientation of the document. Defaults to portrait.
- pageSize Defaults to U.S. letter portrait orientation.
  - width <Number> width of the page for all pages in this section in TWIP. Defaults to 12240. Maximum 31680. Supports equivalent measurement in pixel, cm or inch.
  - height <Number> height of the page for all pages in this section in TWIP. Defaults to 15840. Maximum 31680. Supports equivalent measurement in pixel, cm or inch.
- margins
  - top <Number> distance between the top of the text margins for the main document and the top of the page for all pages in this section in TWIP. Defaults to 1440. Supports equivalent measurement in pixel, cm or inch.
  - right <Number> distance between the right edge of the page and the right edge of the text extents for this document in TWIP. Defaults to 1800. Supports equivalent measurement in pixel, cm or inch.
  - bottom <Number> distance between the bottom of text margins for the document and the bottom of the page in TWIP. Defaults to 1440. Supports equivalent measurement in pixel, cm or inch.
  - left <Number> distance between the left edge of the page and the left edge of the text extents for this document in TWIP. Defaults to 1800. Supports equivalent measurement in pixel, cm or inch.
  - header <Number> distance from the top edge of the page to the top edge of the header in TWIP. Defaults to 720. Supports equivalent measurement in pixel, cm or inch.
  - footer <Number> distance from the bottom edge of the page to the bottom edge of the footer in TWIP. Defaults to 720. Supports equivalent measurement in pixel, cm or inch.
  - gutter <Number> amount of extra space added to the specified margin, above any existing margin values. This setting is typically used when a document is being created for binding in TWIP. Defaults to 0. Supports equivalent measurement in pixel, cm or inch.
- title title of the document.
- subject subject of the document.
- creator creator of the document. Defaults to html-to-docx
- keywords > keywords associated with the document. Defaults to ['html-to-docx'].
- description description of the document.
- lastModifiedBy last modifier of the document. Defaults to html-to-docx.
- revision revision of the document. Defaults to 1.
- createdAt time of creation of the document. Defaults to current time.
- modifiedAt time of last modification of the document. Defaults to current time.
- headerType <"default"|"first"|"even"> type of header. Defaults to default.
- header flag to enable header. Defaults to false.
- footerType <"default"|"first"|"even"> type of footer. Defaults to default.
- footer flag to enable footer. Defaults to false.
- font font name to be used. Defaults to Times New Roman.
- fontSize size of font in HIP(Half of point). Defaults to 22. Supports equivalent measure in pt.
- complexScriptFontSize size of complex script font in HIP(Half of point). Defaults to 22. Supports equivalent measure in pt.
- table
  - row
    - cantSplit flag to allow table row to split across pages. Defaults to false.
- pageNumber flag to enable page number in footer. Defaults to false. Page number works only if footer flag is set as true.
- skipFirstHeaderFooter flag to skip first page header and footer. Defaults to false.
- lineNumber flag to enable line numbering. Defaults to false.
- lineNumberOptions
  - start <Number> start of the numbering - 1. Defaults to 0.
  - countBy <Number> skip numbering in how many lines in between + 1. Defaults to 1.
  - restart <"continuous"|"newPage"|"newSection"> numbering restart strategy. Defaults to continuous.
- numbering
  - defaultOrderedListStyleType default ordered list style type. Defaults to decimal.
- decodeUnicode flag to enable unicode decoding of header, body and footer. Defaults to false.
- lang language localization code for spell checker to work properly. Defaults to en-US.
footerHTMLString <String> clean html string equivalent of footer. Defaults to <p></p> if footer flag is true.

Returns

<Promise<Buffer|Blob>>

Notes

Currently page break can be implemented by having div with classname "page-break" or style "page-break-after" despite the values of the "page-break-after", and contents inside the div element will be ignored. <div style="page-break-after: always;" class="page-break"></div>

CSS list-style-type for <ol> element are now supported. Just do something like this in the HTML:

  <ol style="list-style-type:lower-alpha;">
    <li>List item</li>
    ...
  </ol>

List of supported list-style-types:

upper-alpha, will result in A. List item
lower-alpha, will result in a. List item
upper-roman, will result in I. List item
lower-roman, will result in i. List item
lower-alpha-bracket-end, will result in a) List item
decimal-bracket-end, will result in 1) List item
decimal-bracket, will result in (1) List item
decimal, (the default) will result in 1. List item

Also you could add attribute data-start="n" to start the numbering from the n-th.

<ol data-start="2"> will start the numbering from ( B. b. II. ii. 2. )

Font family doesnt work consistently for all word processor softwares

Word Desktop work as intended
LibreOffice ignores the fontTable.xml file, and finds a font by itself
Word Online ignores the fontTable.xml file, and finds closest font in their font library

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to branch new branches off of develop for contribution.

Support

License

MIT

Contributors

Made with contrib.rocks.

html-to-docx dependencies

@oozcitak/util @oozcitak/dom color-name html-entities html-to-vdom image-size image-to-base64 jszip lodash mime-types nanoid virtual-dom xmlbuilder2

html-to-docx development dependencies

@commitlint/cli @commitlint/config-conventional @rollup/plugin-commonjs @rollup/plugin-json @rollup/plugin-node-resolve eslint eslint-config-airbnb-base eslint-config-prettier eslint-plugin-import eslint-plugin-prettier husky lint-staged prettier rollup rollup-plugin-cleaner rollup-plugin-node-builtins rollup-plugin-terser standard-version

FAQs

What is html-to-docx?

HTML to DOCX converter. Visit Snyk Advisor to see a full health score report for html-to-docx, including popularity, security, maintenance & community analysis.

Is html-to-docx popular?

The npm package html-to-docx receives a total of 25,827 weekly downloads. As such, html-to-docx popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is html-to-docx well maintained?

We found indications that html-to-docx is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is html-to-docx safe to use?

The npm package html-to-docx was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 14 November-2024, at 13:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (25,827)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

html-to-docx

Disclaimer

Installation

Usage

Parameters

Returns

Notes

Contributing

Support

License

Contributors

html-to-docx dependencies

html-to-docx development dependencies

FAQs

What is html-to-docx?

Is html-to-docx popular?

Is html-to-docx well maintained?

Is html-to-docx safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues