@adobe/helix-md2jcr 1.0.0 → 1.0.4

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.0.4](https://github.com/adobe/helix-md2jcr/compare/v1.0.3...v1.0.4) (2025-01-28)
+
+
+### Bug Fixes
+
+* fix typo and silence eslint warning ([#41](https://github.com/adobe/helix-md2jcr/issues/41)) ([b1f9e51](https://github.com/adobe/helix-md2jcr/commit/b1f9e51dc08caef83ab092a4195d2f6a95a26af3))
+
+## [1.0.3](https://github.com/adobe/helix-md2jcr/compare/v1.0.2...v1.0.3) (2025-01-28)
+
+
+### Bug Fixes
+
+* remove private ([#39](https://github.com/adobe/helix-md2jcr/issues/39)) ([1358e6d](https://github.com/adobe/helix-md2jcr/commit/1358e6dda7950a25d4b8a99bb5e4fbbf87b4c0d5))
+
+## [1.0.2](https://github.com/adobe/helix-md2jcr/compare/v1.0.1...v1.0.2) (2025-01-28)
+
+
+### Bug Fixes
+
+* update docs for release ([#38](https://github.com/adobe/helix-md2jcr/issues/38)) ([223a94e](https://github.com/adobe/helix-md2jcr/commit/223a94e92b76eaa86d7fce670c4cec6ffed6065a))
+
+## [1.0.1](https://github.com/adobe/helix-md2jcr/compare/v1.0.0...v1.0.1) (2025-01-28)
+
+
+### Bug Fixes
+
+* update readme ([#37](https://github.com/adobe/helix-md2jcr/issues/37)) ([ae4ab74](https://github.com/adobe/helix-md2jcr/commit/ae4ab740a7629ad9a3c99da99ef3520304fe9032))
+
 # 1.0.0 (2025-01-28)
 
 

package/README.md

@@ -8,20 +8,49 @@
 [![GitHub issues](https://img.shields.io/github/issues/adobe/helix-md2jcr.svg)](https://github.com/adobe/helix-md2jcr/issues)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-## Installation
+## Development
+Install all dependencies by running:
+
+```bash
+npm install
+```
 
 ## Usage
+You can install the package via npm:
 
 ```bash
 npm install @adobe/helix-md2jcr
 ```
 
-## Converting Markdown to JCR XML document
+## Converting Markdown to JCR Nodes
+Running the following command will generate an XML file with the JCR structure alongside of the input file.
 
-just run:
+For example generating xml for the simple.md file, run:
+```bash
+node ./src/cli/convert2jcr.js test/fixtures/simple.md 
+```
+If you wish to see the output in the console, you can run the following command with the verbose flag -v
+```bash
+node ./src/cli/convert2jcr.js test/fixtures/simple.md -v
+```
 
+If you wish to see the decoded output in the console you can run the following command with the verbose and decode flags -v and -d:
 ```bash
-node ./src/cli/convert2jcr.js <file>
+node ./src/cli/convert2jcr.js test/fixtures/simple.md -v -d
 ```
 
-The converter will produce a `.xml` file with the generated document converted following the JCR XML schema.
+The converter will produce a `.xml` which is the generated document converted
+from markdown. This can be used to check for potential content changes due to conversion.
+
+## Baseline XML Files
+Running the ./baseline-tests.sh script will detect any md file under test/fixtures and execute the convert2jcr node script.  
+The script will generate new xml files beside the md files it locates. This is helpful when making changes to the converter
+and you want to see if the changes have any impact on the output.  By using git diff, you will see the new changes in the xml files.
+If you are satisfied with the changes, you can commit the new xml files.
+
+
+## Running Tests
+Simply execute the following command to run the tests:
+```bash
+npm test
+```

package/baseline-tests.sh

@@ -1,5 +1,34 @@
 #!/bin/bash
 
+# create a function that prints the usage of the script
+usage() {
+  echo "Usage: $0 [-v] [-d]"
+  echo "  -v: Verbose mode"
+  echo "  -d: Decode output mode"
+  exit 1
+}
+
+# verify that the command arguments are only -v or -d if any other commands are found exit with an error. If -d is present but -v is not present, exit with an error.
+while getopts ":vd" opt; do
+  case ${opt} in
+    v )
+      VERBOSE="true"
+      ;;
+    d )
+      DECODE="true"
+      ;;
+    \? )
+      echo "Invalid option: $OPTARG" 1>&2
+      usage
+      ;;
+    : )
+      echo "Invalid option: $OPTARG requires an argument" 1>&2
+      usage
+      ;;
+  esac
+done
+
+
 # Set the root directory to search for .md files
 MD_DIR="test/fixtures"
 
@@ -21,19 +50,22 @@ if [ -z "$MD_FILES" ]; then
   exit 1
 fi
 
+ARGS=""
+[ "$VERBOSE" = "true" ] && ARGS="$ARGS -v"
+[ "$DECODE" = "true" ] && ARGS="$ARGS -d"
+
 # Iterate over each .md file
 for MD_FILE in $MD_FILES; do
+  # if VERBOSE is true then echo a new line
+  [ "$VERBOSE" = "true" ] && echo
+
   # Execute the Node.js script with the .md file as an argument
-  echo "*******************************************************************************"
   echo "Processing $MD_FILE..."
-  echo "*******************************************************************************"
-  echo ""
 
-  if [ "$1" == "-d" ]; then
-    NODE_ENV=debug node "$NODE_SCRIPT" "$MD_FILE"
-  else
-    node "$NODE_SCRIPT" "$MD_FILE"
-  fi
+  # if VERBOSE is true then echo a new line
+  [ "$VERBOSE" = "true" ] && echo
+
+  node "$NODE_SCRIPT" "$MD_FILE" $ARGS
 
   # Check if the Node.js script executed successfully
   if [ $? -ne 0 ]; then
@@ -42,4 +74,5 @@ for MD_FILE in $MD_FILES; do
   fi
 done
 
+
 echo "All .md files have been processed successfully."

package/commitlint.config.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'footer-max-line-length': [0],
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",
@@ -9,7 +9,7 @@
     "lint": "eslint .",
     "semantic-release": "semantic-release",
     "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "mocha": {
     "spec": "test/*.test.js",
@@ -56,6 +56,8 @@
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.8",
     "@adobe/helix-mediahandler": "2.5.48",
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -65,7 +67,7 @@
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.31.0",
-    "husky": "9.1.7",
+    "husky": "^9.1.7",
     "junit-report-builder": "5.1.1",
     "lint-staged": "15.4.3",
     "mocha": "10.8.2",

package/src/cli/convert2jcr.js

@@ -39,11 +39,12 @@ async function readJsonFile(filePath) {
 /**
  * Convert a markdown file to JCR XML.
  * @param mdFile {string} The path to the markdown file.
+ * @param verbose - if true the XML will be printed to the console.
  * @param decodeXML - if true a file with the decoded XML will be created.
  * @returns {Promise<void>} A promise that resolves when the conversion is
  * complete, or rejects if the file is not a markdown file.
  */
-async function convert(mdFile, decodeXML = false) {
+async function convert(mdFile, verbose = false, decodeXML = false) {
   if (!mdFile.endsWith('.md')) {
     return Promise.reject(new Error('File must be a markdown file'));
   }
@@ -51,7 +52,6 @@ async function convert(mdFile, decodeXML = false) {
   const dir = path.dirname(mdFile);
   const base = path.basename(mdFile, '.md');
   const fileJcrXML = path.resolve(dir, `${base}.xml`);
-  const decodedXML = path.resolve(dir, `${base}-decoded.xml`);
 
   let modelJson;
   let definitionJson;
@@ -96,8 +96,12 @@ async function convert(mdFile, decodeXML = false) {
 
   const xml = await md2jcr(md, opts);
 
-  if (decodeXML) {
-    writeFile(decodedXML, decode(xml));
+  if (verbose) {
+    if (!decodeXML) {
+      console.log(xml);
+    } else if (decodeXML) {
+      console.log(decode(xml));
+    }
   }
 
   return writeFile(fileJcrXML, xml);
@@ -115,13 +119,16 @@ async function run(inPath) {
 
   const files = [];
   if ((await stat(dirOrFilePath)).isDirectory()) {
-    files.push(...await readdir(dirOrFilePath));
+    const items = await readdir(dirOrFilePath);
+    items
+      .filter((item) => item.endsWith('.md'))
+      .forEach((item) => files.push(path.resolve(dirOrFilePath, item)));
   } else {
     files.push(dirOrFilePath);
   }
 
   for (const file of files) {
-    await convert(file, process.argv.includes('-d'));
+    await convert(file, process.argv.includes('-v'), process.argv.includes('-d'));
   }
 }
 

package/src/mdast2jcr/hb/partials/grid-table.js

@@ -29,6 +29,8 @@ import image from './supports/image.js';
 import FieldGroupFieldResolver from '../../domain/FieldGroupFieldResolver.js';
 import ModelHelper from '../../domain/ModelHelper.js';
 
+/* eslint-disable no-console */
+
 /**
  * @typedef {import('../../index.d.ts').FieldDef} Field
  * @typedef {import('../../index.d.ts').DefinitionDef} Definition
@@ -250,9 +252,9 @@ function extractProperties(mdast, model, mode, component, fields, properties) {
       extractKeyValueProperties(row, model, fieldResolver, fieldGroup, properties);
     } else {
       // for each cell in the row, process the nodes that exist in the cell
-      let processsing = false;
+      let processing = false;
       for (const cell of cells) {
-        if (mode === 'blockItem' && !processsing) {
+        if (mode === 'blockItem' && !processing) {
           fieldGroup = fieldsCloned.shift();
         }
 
@@ -260,7 +262,7 @@ function extractProperties(mdast, model, mode, component, fields, properties) {
         if (nodes.length === 0) {
           // throw away the field that was associated with the cell
           fieldGroup.fields.shift();
-          processsing = true;
+          processing = true;
           // if there are no nodes in the cell, then we need to skip it
         } else {
           while (nodes.length > 0) {

package/src/mdast2jcr/index.js

@@ -86,9 +86,5 @@ export default async function mdast2jcr(mdast, options = {}) {
     lineSeparator: '\n',
   });
 
-  if (process.env.NODE_ENV === 'debug') {
-    console.log(xml);
-  }
-
   return xml;
 }