Add function to remove JS code blocks from mdx files (#17)

* add function to remove JS code blocks from mdx files

* add `inlineCode` type to pluggin

* build

dist/index.js

@@ -30549,6 +30549,25 @@ var removeShortListItems = function removeShortListItems() {
       });
     });
   };
+};
+
+var removeJsItems = function removeJsItems() {
+  return function (tree) {
+    var visitNexParagraph = false;
+    unistUtilVisit(tree, 'root', function (listItemNode) {
+      unistUtilVisit(listItemNode, ['html', 'paragraph'], function (elementNode) {
+        if (visitNexParagraph && elementNode.type === 'paragraph') {
+          unistUtilVisit(elementNode, ['text', 'inlineCode'], function (textNode) {
+            textNode.value = '';
+          });
+        }
+
+        if (elementNode.type === 'html') {
+          visitNexParagraph = elementNode.value === '<!-- JS block -->' && !visitNexParagraph;
+        }
+      });
+    });
+  };
 }; // Returns scores for a given string
 
 
@@ -30585,7 +30604,7 @@ function averageObjectProperties(objects) {
 // text we want to analyze.
 
 function preprocessMarkdown(markdown) {
-  var remarker = remark().use(removeShortListItems).use(removeHeadings).use(removeAdmonitionHeadings).use(removeImageAltText).use(removeCodeBlocks).use(removePageMetadata).use(stripMarkdown);
+  var remarker = remark().use(removeShortListItems).use(removeHeadings).use(removeAdmonitionHeadings).use(removeImageAltText).use(removeCodeBlocks).use(removePageMetadata).use(removeJsItems).use(stripMarkdown);
   return remarker.processSync(markdown).contents // Remove any blank lines
   .replace(/\n+/g, "\n");
 } // Calculate the readabilty result for all files found in a given path glob.

src/readability.js

@@ -83,6 +83,22 @@ const removeShortListItems = () => (tree) => {
     });
 };
 
+const removeJsItems = () => (tree) => {
+    let visitNexParagraph = false;
+    visit(tree, 'root', (listItemNode) => {
+        visit(listItemNode, ['html', 'paragraph'], (elementNode) => {
+            if (visitNexParagraph && elementNode.type === 'paragraph') {
+                visit(elementNode, ['text', 'inlineCode'], (textNode) => {textNode.value = ''})
+            }
+            if (elementNode.type === 'html') {
+                visitNexParagraph =  elementNode.value === '<!-- JS block -->' && !visitNexParagraph;
+            }
+        })
+    })
+
+
+}
+
 // Returns scores for a given string
 function scoreText(text) {
     const colemanLiauIndex = readability.colemanLiauIndex(text);
@@ -125,6 +141,7 @@ export function preprocessMarkdown(markdown) {
         .use(removeImageAltText)
         .use(removeCodeBlocks)
         .use(removePageMetadata)
+        .use(removeJsItems)
         .use(strip);
 
     return remarker
@@ -137,7 +154,7 @@ export function preprocessMarkdown(markdown) {
 // This result contains readability scores for each file, and an overall average
 export function calculateReadability(globPath) {
     const filePaths = glob.sync(globPath);
-  
+
     const fileResults = filePaths.map((filePath) => {
         const markdown = fs.readFileSync(filePath);
         const stripped = preprocessMarkdown(markdown);

src/readability.test.js

@@ -92,6 +92,26 @@ Test 2.`
 Click the left button 
 Test 2.
 "
+`);
+    });
+
+    it('should strip js code parts from comment block', () => {
+        const stripped = preprocessMarkdown(`
+<!-- JS block -->
+import MenuGrid from '../../components/MenuGrid';
+const items = [
+    {title: 'Cashier strategies', to: '/docs/settings/cashier-strategies/' },
+    {title: 'Custom cashier properties', to: '/docs/settings/custom-cashier-property-sets/' },
+];
+
+<!-- JS block -->
+Some content. This is paragraph with const items = [];
+`);
+
+        expect(stripped).toMatchInlineSnapshot(`
+"
+Some content. This is paragraph with const items = \\\\[];
+"
 `);
     });
 });