Merge pull request #809 from yanokwa/prepare-6.0.0

Prepare for 6.0.0

CHANGELOG.md

@@ -3,6 +3,11 @@ Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+[6.0.0] - 2021-09-17
+---------------------
+##### Changed
+- Upgraded node, npm, and other dependencies
+
 [5.18.1] - 2021-07-13
 ---------------------
 ##### Changed

docs/Form.html

@@ -425,7 +425,7 @@ <h4 class="name" id=".requiredTransformerVersion"><span class="type-signature">(
 
     <dt class="tag-default">Default Value:</dt>
     <dd class="tag-default"><ul class="dummy">
-            <li>1.43.0</li>
+            <li>2.0.0</li>
         </ul></dd>
 
 

docs/index.html

@@ -62,8 +62,7 @@ <h3> </h3>
 
 
     <section class="readme usertext">
-        <article><p><img src="https://img.shields.io/badge/coverage-100%25-brightgreen.svg" alt="coverage-shield-badge-1">
-<a href="http://badge.fury.io/js/enketo-core"><img src="https://badge.fury.io/js/enketo-core.svg" alt="npm version"></a> <a href="https://travis-ci.org/enketo/enketo-core"><img src="https://travis-ci.com/enketo/enketo-core.svg?branch=master" alt="Build Status"></a> <a href="https://david-dm.org/enketo/enketo-core"><img src="https://david-dm.org/enketo/enketo-core/status.svg" alt="Dependency Status"></a> <a href="https://david-dm.org/enketo/enketo-core?type=dev"><img src="https://david-dm.org/enketo/enketo-core/dev-status.svg" alt="devDependency Status"></a> <a href="https://www.codacy.com/app/martijnr/enketo-core?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=enketo/enketo-core&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/dc1c5aaa9267d75cbd2d6714d2b4fa32" alt="Codacy Badge"></a></p>
+        <article><p><a href="http://badge.fury.io/js/enketo-core"><img src="https://badge.fury.io/js/enketo-core.svg" alt="npm version"></a> <a href="https://travis-ci.org/enketo/enketo-core"><img src="https://travis-ci.com/enketo/enketo-core.svg?branch=master" alt="Build Status"></a> <a href="https://david-dm.org/enketo/enketo-core"><img src="https://david-dm.org/enketo/enketo-core/status.svg" alt="Dependency Status"></a> <a href="https://david-dm.org/enketo/enketo-core?type=dev"><img src="https://david-dm.org/enketo/enketo-core/dev-status.svg" alt="devDependency Status"></a> <a href="https://www.codacy.com/app/martijnr/enketo-core?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=enketo/enketo-core&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/dc1c5aaa9267d75cbd2d6714d2b4fa32" alt="Codacy Badge"></a></p>
 <h1 id="enketo-core">Enketo Core</h1>
 <p>The engine that powers <a href="https://enketo.org">Enketo Smart Paper</a> and various third party tools including <a href="https://enketo.org/about/adoption/">this selection</a>.</p>
 <p>Enketo's form engine is compatible with tools in the ODK ecosystem and complies with its <a href="https://getodk.github.io/xforms-spec/">XForms specification</a> though not all features in that specification have been implemented yet.</p>

docs/js_form.js.html

@@ -1237,7 +1237,7 @@ <h1 class="page-title">js/form.js</h1>
  * @type {string}
  * @default
  */
-Form.requiredTransformerVersion = '1.43.0';
+Form.requiredTransformerVersion = '2.0.0';
 
 export { Form, FormModel };
 </code></pre>

docs/tutorial-20-development.html

@@ -54,8 +54,8 @@ <h3 id="how-to-develop-enketo-core">How to develop Enketo Core</h3>
 <li>install prerequisites:</li>
 </ol>
 <ul>
-<li><a href="https://nodejs.org/">Node</a> version 12.x</li>
-<li><a href="https://docs.npmjs.com/cli/">npm CLI</a> version 6.x - comes bundled with Node, make sure it's not version 7.x, as it will not work</li>
+<li>Volta (optional, but recommended)</li>
+<li>Node.js 16 and npm 6 (Node.js 14 is also supported)</li>
 <li><a href="https://gruntjs.com/getting-started">grunt-cli</a></li>
 </ul>
 <ol start="2">
@@ -71,7 +71,7 @@ <h3 id="notes-for-javascript-developers">Notes for JavaScript Developers</h3>
 <li>When creating new functions/Classes, make sure to describe them with JSDoc comments.</li>
 <li>JavaScript style see <a href="./eslintrc.json">ESLint</a> config files. The check is added to the grunt <code>test</code> task. You can also manually run <code>grunt eslint:fix</code> to fix style issues.</li>
 <li>Testing is done with Mocha and Karma (all: <code>grunt karma</code>, headless: <code>grunt karma:headless</code>, browsers: <code>grunt karma:browsers</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>
+<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 <a href="./#debugging-test-watch-mode-in-vscode">Debugging test watch mode in VSCode</a> below</li>
 <li>When making a pull request, please add tests where relevant</li>
 </ul>
 <h4 id="debugging-test-watch-mode-in-vscode">Debugging test watch mode in VSCode</h4>
@@ -104,14 +104,17 @@ <h3 id="notes-for-css-developers">Notes for CSS Developers</h3>
 <h3 id="release-a-new-version">Release a new version</h3>
 <p>Documentation is auto-generated and is re-built for each new release. Do not commit updated documentation in non-release commits. The process to follow for each release that includes various helpful checks is:</p>
 <ol>
-<li>Change some code.</li>
-<li>Build documentation: <code>npm run build-docs</code>.</li>
-<li>Bump the version tag in <code>package.json</code> file (we follow <a href="https://semver.org/">semantic versioning</a>).</li>
-<li>Merge all your changes to <code>master</code> (through PR).</li>
-<li>Add git tag of new version.</li>
-<li>Publish module to NPM: <code>npm run publish-please</code></li>
+<li>Check <a href="https://github.com/enketo/enketo-transformer/security/dependabot">Dependabot alerts</a> for vulnerabilities</li>
+<li>Update dependencies: <code>npm update</code>. If enketo-transformer is updated, bump the version in <code>src/js/form.js</code></li>
+<li><code>npm audit fix</code></li>
+<li>Make sure tests pass: <code>npm run test</code> and <code>npm run test-browsers</code></li>
+<li>Beautiful code: <code>npm run beautify</code></li>
+<li>Build documentation: <code>npm run build-docs</code></li>
+<li>Bump the version tag in <code>package.json</code> file (we follow <a href="https://semver.org/">semantic versioning</a>). Bump to major version if downstream has to make changes.</li>
+<li>Merge all your changes to <code>master</code> (through PR)</li>
+<li>Add git tag of new version</li>
+<li>Publish module to NPM: <code>npm publish</code></li>
 </ol>
-<p>We use <a href="https://github.com/inikulin/publish-please">publish-please</a> - a tool that does various checks before publishing to NPM repository. It runs the test suite, beautifies the code, builds documentation (to check if there are any unbuilt changes), checks for any uncommitted changes and more. It basically verifies that you didn't miss any of the required steps. If you want to test it without publishing, use a flag: <code>npx publish-please --dry-run</code>.</p>
 </article>
 
 </section>