Merge pull request #120 from yanokwa/prepare-1.44.0

Prepare for 1.44.0
enketo · Sep 3, 2021 · f5e9c13 · f5e9c13
2 parents 8350043 + 48b46e5
commit f5e9c13
Show file tree

Hide file tree

Showing 12 changed files with 44 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,13 +2,18 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+[1.44.0] - 2021-09-02
+------------------------
+##### Changed
+- Upgraded node, npm, and other dependencies
+
 [1.43.0] - 2021-05-11
 ------------------------
 ##### Added
 - Support for `odk:setgeopoint`.
 
 ##### Changed
-- changed form id attribute to data-form-id to support spaces.
+- Changed form id attribute to data-form-id to support spaces.
 
 [1.42.0] - 2021-03-25
 ------------------------

diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ NodeJS library that transforms OpenRosa/ODK XForms into a format the Enketo unde
 
 ### Prerequisites
 
+1. Volta (optional, but recommended)
 1. Node.js 16 and npm 6 (Node.js 14 is also supported)
 
 ### Install as module

diff --git a/docs/api.js.html b/docs/api.js.html
@@ -185,7 +185,7 @@ <h1 class="page-title">api.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -69,7 +69,7 @@ <h1 id="enketo-transformer">Enketo Transformer</h1>
 <p><a href="https://enketo.github.io/enketo-transformer/">Technical Documentation</a></p>
 <h3 id="prerequisites">Prerequisites</h3>
 <ol>
-<li>nodeJS 12 and npm</li>
+<li>Node.js 16 and npm 6 (Node.js 14 is also supported)</li>
 </ol>
 <h3 id="install-as-module">Install as module</h3>
 <pre class="prettyprint source lang-bash"><code>npm install enketo-transformer --save
@@ -126,7 +126,22 @@ <h3 id="response-format">Response format</h3>
 <h3 id="test">Test</h3>
 <ul>
 <li>run tests with <code>npm test</code></li>
+<li>run tests in watch mode with <code>npm run test:watch</code></li>
+<li>Tests can be run in watch mode for <a href="https://en.wikipedia.org/wiki/Test-driven_development">TDD</a> workflows with <code>npm run test-watch</code>, and support for debugging in <a href="https://code.visualstudio.com/">VSCode</a> is provided. For instructions see [./#debugging-test-watch-mode-in-vscode](Debugging test watch mode in VSCode) below</li>
 </ul>
+<h4 id="debugging-test-watch-mode-in-vscode">Debugging test watch mode in VSCode</h4>
+<p>Basic usage:</p>
+<ol>
+<li>Go to VSCode's &quot;Run and Debug&quot; panel</li>
+<li>Select &quot;Test (watch + debug)&quot;</li>
+<li>Click the play button</li>
+</ol>
+<p>Optionally, you can add a keyboard shortcut to select launch tasks:</p>
+<ol>
+<li>Open the keyboard shortcuts settings (cmd+k cmd+s on Mac, ctrl+k ctrl+s on other OSes)</li>
+<li>Search for <code>workbench.action.debug.selectandstart</code></li>
+<li>Click the + button to add your preferred keybinding keybinding</li>
+</ol>
 <h3 id="develop">Develop</h3>
 <p>The script <code>npm run develop</code> runs the app on port 8085 and also serves test/forms on port 8081. You could test the transformation output by placing an XForm in test/forms and running
 http://localhost:8085/transform?xform=http://localhost:8081/autocomplete.xml</p>
@@ -135,6 +150,17 @@ <h3 id="develop">Develop</h3>
 <p>A vagrant configuration file and provisioning script is also included. Use DEBUG environment variable to see debug terminal output, e.g.:</p>
 <pre class="prettyprint source lang-bash"><code>DEBUG=api,transformer,markdown,language node app.js
 </code></pre>
+<h3 id="release">Release</h3>
+<p>Releases are done each time a dependent tool needs an <code>enketo-transformer</code> change. They are published by <a href="https://github.com/MartijnR">@Martijnr</a> and require the following steps:</p>
+<ul>
+<li>update <a href="https://github.com/enketo/enketo-transformer/blob/master/CHANGELOG.md">change log</a></li>
+<li>update version in <code>package.json</code></li>
+<li>update dependencies (<code>npm update</code> and then check if <code>node-libxslt</code> has been updated because it has caused problems in the past).</li>
+<li><code>npm audit fix</code></li>
+<li><code>npm run build-docs</code></li>
+<li>tag the release with the version</li>
+<li>publish with <code>npm publish</code></li>
+</ul>
 <h3 id="license">License</h3>
 <p>See <a href="./LICENSE">license document</a>.</p>
 <p>In addition, any product that uses enketo-transformer or parts thereof is required to have a &quot;Powered by Enketo&quot; footer, according to the specifications below, on all screens in which the output of enketo-xslt, or parts thereof, are used, unless explicity exempted from this requirement by Enketo LLC in writing. Partners and sponsors of the Enketo Project, listed on <a href="https://enketo.org/#about">https://enketo.org/#about</a> and on <a href="https://github.com/enketo/enketo-core#sponsors">https://github.com/enketo/enketo-core#sponsors</a> are exempted from this requirements and so are contributors listed in <a href="./package.json">package.json</a>.</p>
@@ -164,7 +190,7 @@ <h3 id="change-log">Change Log</h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/language.js.html b/docs/language.js.html
@@ -168,7 +168,7 @@ <h1 class="page-title">language.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/markdown.js.html b/docs/markdown.js.html
@@ -235,7 +235,7 @@ <h1 class="page-title">markdown.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-api.html b/docs/module-api.html
@@ -344,7 +344,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-language.html b/docs/module-language.html
@@ -1105,7 +1105,7 @@ <h5 class="subsection-title">Properties:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-markdown.html b/docs/module-markdown.html
@@ -1906,7 +1906,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-transformer.html b/docs/module-transformer.html
@@ -2442,7 +2442,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/transformer.js.html b/docs/transformer.js.html
@@ -533,7 +533,7 @@ <h1 class="page-title">transformer.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "enketo-transformer",
-    "version": "1.43.0",
+    "version": "1.44.0",
     "description": "Library/app that transforms ODK-compliant XForms into a format that Enketo can consume",
     "license": "Apache-2.0",
     "main": "src/transformer.js",