Skip to content

Commit

Permalink
Updated changelog, bumped version and added prepack command
Browse files Browse the repository at this point in the history
  • Loading branch information
jjhbw committed Apr 13, 2020
1 parent 5ebbe42 commit 273c1bf
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
1 change: 1 addition & 0 deletions .npmignore
Expand Up @@ -33,3 +33,4 @@ coverage

# Project-specific
/src
/examples
15 changes: 15 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,18 @@
## 4.0.0 (2020-04-13)

* Removed Flow and switched entire codebase over to TypeScript. In the process a few minor soundness issues were fixed.

* **Breaking change** Removed dependency on Node filesystem APIs so the library no longer needs a separate node and browser entrypoint, simplifying maintenance and development. This has the following implications for the public API, justifying the version bump to 4.0.0:
* You can no longer provide image data as a path, and need to provide an `ArrayBuffer` or base64-encoded string instead.

* You can no longer provide a template as a filesystem path, and you'll need to read it into a Buffer first.

* Removed `output: 'buffer'` argument. The output of `createReport` is now always a `Uint8Array`, unless the debug argument `_probe` is specified.


The README and examples have also been updated to reflect the above changes.


## 3.1.1 (2019-8-20)

* Avoid issue when a single paragraph contains `END-IF/FOR` for a previous loop and `IF/FOR` for a new one (#72).
Expand Down
3 changes: 2 additions & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "docx-templates",
"version": "3.1.1",
"version": "4.0.0",
"description": "Template-based docx report creation",
"main": "lib/index.js",
"types": "lib/index.d.ts",
Expand All @@ -24,6 +24,7 @@
},
"scripts": {
"compile": "tsc",
"prepack": "yarn compile",
"travis": "yarn compile && yarn test",
"jest": "jest --watch --coverage",
"test": "yarn prettier-check && yarn testCovFull",
Expand Down

0 comments on commit 273c1bf

Please sign in to comment.