added version number

Author: stm2

crs/crs.js

@@ -55,6 +55,11 @@ function escapeHtml(str) {
     .replace(/'/g, ''');
 }
 
+// Library version (update when changing public shortcode behavior)
+const CRS_VERSION = '0.1.0';
+// Export version for external use (e.g., in layouts via require) and add as global data below
+module.exports.CRS_VERSION = CRS_VERSION;
+
 // Validation helper (stateless)
 function validateCrid(id) {
   if (typeof id !== 'string') return { ok: false, message: 'crid must be a string' };
@@ -385,6 +390,10 @@ class Report {
 }
 
 module.exports = function (eleventyConfig) {
+  // Provide version to all templates as 'crmapVersion'
+  if (eleventyConfig.addGlobalData) {
+    eleventyConfig.addGlobalData('crmapVersion', CRS_VERSION);
+  }
   // Usage: SECOND ARGUMENT IS OPTIONAL JSON OPTIONS STRING.
   //   {% crmap 'path/to/file.cr' %}                                          -> defaults (auto crid, details true, z 0, auto caption)
   //   {% crmap 'path/to/file.cr' '{}' %}                                     -> same as defaults
@@ -497,7 +506,7 @@ module.exports = function (eleventyConfig) {
 
       // <class = "cr-report" is used as a marker to include css/js in layout!
 
-  return `<script>window.crids = ${JSON.stringify(Array.from(pageState.crids))};<\/script>\n` +
+      return `<!-- crmap generated by crs.js version ${CRS_VERSION} -->\n` +
         `<figure class=\"cr-report\" data-crid=\"${crid}\">` +
         `<div class=\"cr-svg-wrapper\">${svg}</div>` +
         (caption ? `<figcaption class=\"cr-caption\">${escapeHtml(caption)}</figcaption>` : '') +
@@ -512,14 +521,14 @@ module.exports = function (eleventyConfig) {
   // Shortcode to output region details container for a given crid
 
   eleventyConfig.addShortcode('crmap_rdetails', function (crid, placeholder = null) {
-  // Access per-page state
-  let pageState = this && this.ctx ? this.ctx._crmapState : null;
-  let useCrid = crid;
-  if (!useCrid && pageState) useCrid = pageState.lastCrid;
+    // Access per-page state
+    let pageState = this && this.ctx ? this.ctx._crmapState : null;
+    let useCrid = crid;
+    if (!useCrid && pageState) useCrid = pageState.lastCrid;
     if (!useCrid) return '<div class="cr-error" style="color:#a00">crmap_rdetails: missing crid (no crmap rendered yet)</div>';
-  const v = validateCrid(useCrid.toString());
+    const v = validateCrid(useCrid.toString());
     if (!v.ok) return `<div class=\"cr-error\" style=\"color:#a00\">${v.message}</div>`;
-  if (!pageState || !pageState.crids.has(useCrid.toString())) {
+    if (!pageState || !pageState.crids.has(useCrid.toString())) {
       return `<div class=\"cr-error\" style=\"color:#a00\">Unknown crid '${useCrid}' (render map first)</div>`;
     }
     if (placeholder === null || placeholder === true) {
@@ -533,13 +542,13 @@ module.exports = function (eleventyConfig) {
   // Shortcode to output unit details container for a given crid
 
   eleventyConfig.addShortcode('crmap_udetails', function (crid, placeholder = null) {
-  let pageState = this && this.ctx ? this.ctx._crmapState : null;
-  let useCrid = crid;
-  if (!useCrid && pageState) useCrid = pageState.lastCrid;
+    let pageState = this && this.ctx ? this.ctx._crmapState : null;
+    let useCrid = crid;
+    if (!useCrid && pageState) useCrid = pageState.lastCrid;
     if (!useCrid) return '<div class="cr-error" style="color:#a00">crmap_udetails: missing crid (no crmap rendered yet)</div>';
-  const v = validateCrid(useCrid.toString());
+    const v = validateCrid(useCrid.toString());
     if (!v.ok) return `<div class=\"cr-error\" style=\"color:#a00\">${v.message}</div>`;
-  if (!pageState || !pageState.crids.has(useCrid.toString())) {
+    if (!pageState || !pageState.crids.has(useCrid.toString())) {
       return `<div class=\"cr-error\" style=\"color:#a00\">Unknown crid '${useCrid}' (render map first)</div>`;
     }
     if (placeholder === null || placeholder === true) {
@@ -553,13 +562,13 @@ module.exports = function (eleventyConfig) {
   // Shortcode to output unit commands container for a given crid
 
   eleventyConfig.addShortcode('crmap_commands', function (crid, placeholder = null) {
-  let pageState = this && this.ctx ? this.ctx._crmapState : null;
-  let useCrid = crid;
-  if (!useCrid && pageState) useCrid = pageState.lastCrid;
+    let pageState = this && this.ctx ? this.ctx._crmapState : null;
+    let useCrid = crid;
+    if (!useCrid && pageState) useCrid = pageState.lastCrid;
     if (!useCrid) return '<div class="cr-error" style="color:#a00">crmap_commands: missing crid (no crmap rendered yet)</div>';
-  const v = validateCrid(useCrid.toString());
+    const v = validateCrid(useCrid.toString());
     if (!v.ok) return `<div class=\"cr-error\" style=\"color:#a00\">${v.message}</div>`;
-  if (!pageState || !pageState.crids.has(useCrid.toString())) {
+    if (!pageState || !pageState.crids.has(useCrid.toString())) {
       return `<div class=\"cr-error\" style=\"color:#a00\">Unknown crid '${useCrid}' (render map first)</div>`;
     }
     if (placeholder === null || placeholder === true) {