@tinymce/moxiedoc - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1-feature.20220428022539412.sha842dea6

CHANGELOG.md

@@ -9,2 +9,7 @@ # Changelog
 
+## 0.2.1 - 2022-04-29
+
+### Fixed
+- The `antora` template used the incorrect data for page introductions.
+
 ## 0.2.0 - 2022-04-05
@@ -11,0 +16,0 @@

dist/templates/antora/antora.converter.js

@@ -21,3 +21,3 @@ "use strict";
 // convert BRs found into asciidoc \n
-const encodeBR = (str) => str.replace(/<br\s*\/?>/g, '\n');
+const encodeBR = (str) => str.replace(/\s*<br\s*\/?>\s*/g, '\n');
 // convert <em> into __italics__ asciidoc
@@ -257,4 +257,8 @@ const encodeEM = (str) => str.replace(/<\/?em>/g, '__');
     // data.examples = data.examples || []
-    // summary
-    if (hasValue(data.summary)) {
+    // description
+    if (hasValue(data.desc)) {
+        tmp += '\n' + cleanup(data.desc) + '\n';
+    }
+    // summary if not part of the description
+    if (hasValue(data.summary) && (!hasValue(data.desc) || !data.desc.includes(data.summary))) {
         tmp += '\n' + cleanup(data.summary) + '\n';
@@ -261,0 +265,0 @@ }

dist/templates/antora/template.js

@@ -82,2 +82,3 @@ "use strict";
     data.desc = data.desc.replace(/\n/g, ' ');
+    data.summary = data.summary.replace(/\n/g, ' ');
     data.constructors = [];
@@ -84,0 +85,0 @@ data.methods = [];

package.json

 {
   "name": "@tinymce/moxiedoc",
-  "version": "0.2.0",
+  "version": "0.2.1-feature.20220428022539412.sha842dea6",
   "description": "A tool for generating API documentation",
@@ -5,0 +5,0 @@ "author": "Tiny Technologies, Inc",

src/templates/antora/antora.converter.ts

@@ -30,3 +30,3 @@ import { Return } from '../../lib/member';
 const encodeBR = (str: string): string =>
-  str.replace(/<br\s*\/?>/g, '\n');
+  str.replace(/\s*<br\s*\/?>\s*/g, '\n');
 
@@ -322,4 +322,9 @@ // convert <em> into __italics__ asciidoc
 
-  // summary
-  if (hasValue(data.summary)) {
+  // description
+  if (hasValue(data.desc)) {
+    tmp += '\n' + cleanup(data.desc) + '\n';
+  }
+
+  // summary if not part of the description
+  if (hasValue(data.summary) && (!hasValue(data.desc) || !data.desc.includes(data.summary))) {
     tmp += '\n' + cleanup(data.summary) + '\n';
@@ -326,0 +331,0 @@ }

src/templates/antora/template.ts

@@ -103,2 +103,3 @@ import * as fs from 'fs';
   data.desc = data.desc.replace(/\n/g, ' ');
+  data.summary = data.summary.replace(/\n/g, ' ');
 
@@ -105,0 +106,0 @@ data.constructors = [];

No alert changes

Improved metrics

Total package byte prevSize

346513

increased by0.28%

Lines of code

6686

increased by0.15%

No dependency changes