refactor: split into two files

europeana · Jun 10, 2024 · 1c20abb · 1c20abb
1 parent bdb5c10
commit 1c20abb
Show file tree

Hide file tree

Showing 16 changed files with 55 additions and 51 deletions.
diff --git a/packages/portal/src/components/DS4CH/DS4CHLandingHero.vue b/packages/portal/src/components/DS4CH/DS4CHLandingHero.vue
@@ -14,7 +14,7 @@
         <!-- eslint-disable vue/no-v-html -->
         <div
           class="hero-content-text-block"
-          v-html="parseMarkdownHtml(`# ${headline}\n${text}`)"
+          v-html="parseMarkdown(`# ${headline}\n${text}`)"
         />
         <!-- eslint-enable vue/no-v-html -->
         <SmartLink
@@ -42,7 +42,7 @@
 
 <script>
   import SmartLink from '@/components/generic/SmartLink';
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   const CSS_VARS_PRESETS = {
     small: { w: 576, h: 896, fit: 'fill', q: 100, f: 'right' },
@@ -107,7 +107,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/content/ContentCard.vue b/packages/portal/src/components/content/ContentCard.vue
@@ -122,7 +122,7 @@
   import ClientOnly from 'vue-client-only';
   import SmartLink from '../generic/SmartLink';
   import langAttributeMixin from '@/mixins/langAttribute';
-  import { stripMarkdown } from '@/utils/markdown.js';
+  import stripMarkdown from '@/utils/markdown/strip.js';
   import truncateMixin from '@/mixins/truncate';
   import { langMapValueForLocale } from '@europeana/i18n';
 

diff --git a/packages/portal/src/components/content/ContentPrimaryCallToAction.vue b/packages/portal/src/components/content/ContentPrimaryCallToAction.vue
@@ -9,7 +9,7 @@
     <!-- eslint-disable vue/no-v-html -->
     <div
       class="primary-cta-rich-text text-left"
-      v-html="parseMarkdownHtml(text)"
+      v-html="parseMarkdown(text)"
     />
     <!-- eslint-enable vue/no-v-html -->
     <SmartLink
@@ -26,7 +26,7 @@
 
 <script>
   import SmartLink from '../generic/SmartLink';
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   export default {
     name: 'ContentPrimaryCallToAction',
@@ -55,7 +55,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingEmbed.vue b/packages/portal/src/components/landing/LandingEmbed.vue
@@ -19,7 +19,7 @@
           <div
             v-if="text"
             class="text mb-3"
-            v-html="parseMarkdownHtml(text)"
+            v-html="parseMarkdown(text)"
           />
           <!-- eslint-enable vue/no-v-html -->
         </b-col>
@@ -46,7 +46,7 @@
 </template>
 
 <script>
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
   import EmbedHTML from '@/components/embed/EmbedHTML';
 
   export default {
@@ -104,7 +104,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingHero.vue b/packages/portal/src/components/landing/LandingHero.vue
@@ -7,7 +7,7 @@
         <header class="hero-content">
           <!-- eslint-disable vue/no-v-html -->
           <div
-            v-html="parseMarkdownHtml(`# ${headline}\n${text}`)"
+            v-html="parseMarkdown(`# ${headline}\n${text}`)"
           />
           <!-- eslint-enable vue/no-v-html -->
           <SmartLink
@@ -40,7 +40,7 @@
 <script>
   import ImageWithAttribution from '@/components/image/ImageWithAttribution';
   import SmartLink from '@/components/generic/SmartLink';
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   export default {
     name: 'LandingHero',
@@ -110,7 +110,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingIllustrationGroup.vue b/packages/portal/src/components/landing/LandingIllustrationGroup.vue
@@ -11,7 +11,7 @@
       <div
         v-if="text"
         class="text mb-3"
-        v-html="parseMarkdownHtml(text)"
+        v-html="parseMarkdown(text)"
       />
     <!-- eslint-enable vue/no-v-html -->
     </b-col>
@@ -66,7 +66,7 @@
 
 <script>
   import ImageOptimised from '@/components/image/ImageOptimised';
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
   import swiperMixin from '@/mixins/swiper';
   import { Grid, Keyboard, Lazy, Navigation, Pagination } from 'swiper';
 
@@ -170,7 +170,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingImageCard.vue b/packages/portal/src/components/landing/LandingImageCard.vue
@@ -32,7 +32,7 @@
       <!-- eslint-disable vue/no-v-html -->
       <div
         class="text"
-        v-html="parseMarkdownHtml(card.text)"
+        v-html="parseMarkdown(card.text)"
       />
       <!-- eslint-enable vue/no-v-html -->
       <SmartLink
@@ -54,7 +54,7 @@
 
 <script>
   import parityMixin from '@/mixins/parity.js';
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   const SRCSET_PRESETS = {
     small: { w: 512, h: 342, fit: 'fill' },
@@ -145,7 +145,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
   </script>

diff --git a/packages/portal/src/components/landing/LandingImageCardGroup.vue b/packages/portal/src/components/landing/LandingImageCardGroup.vue
@@ -13,7 +13,7 @@
           <div
             v-if="text"
             class="mb-3"
-            v-html="parseMarkdownHtml(text)"
+            v-html="parseMarkdown(text)"
           />
         <!-- eslint-enable vue/no-v-html -->
         </b-col>
@@ -35,7 +35,7 @@
 </template>
 
 <script>
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   export default {
     name: 'LandingImageCardGroup',
@@ -83,7 +83,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingInfoCard.vue b/packages/portal/src/components/landing/LandingInfoCard.vue
@@ -38,7 +38,7 @@
         class="text"
         :class="{ 'mb-3': card.link }"
         data-qa="landing info card text"
-        v-html="parseMarkdownHtml(card.text)"
+        v-html="parseMarkdown(card.text)"
       />
       <!-- eslint-enable vue/no-v-html -->
       <SmartLink
@@ -55,7 +55,7 @@
 </template>
 
 <script>
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   export default {
     name: 'LandingInfoCard',
@@ -83,7 +83,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingInfoCardGroup.vue b/packages/portal/src/components/landing/LandingInfoCardGroup.vue
@@ -11,7 +11,7 @@
       <div
         v-if="text"
         class="text mb-3"
-        v-html="parseMarkdownHtml(text)"
+        v-html="parseMarkdown(text)"
       />
     <!-- eslint-enable vue/no-v-html -->
     </b-col>
@@ -44,7 +44,7 @@
 </template>
 
 <script>
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   export default {
     name: 'LandingInfoCardGroup',
@@ -105,7 +105,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/landing/LandingSubSection.vue b/packages/portal/src/components/landing/LandingSubSection.vue
@@ -12,7 +12,7 @@
         <div
           v-if="text"
           class="text mx-auto mb-3"
-          v-html="parseMarkdownHtml(text)"
+          v-html="parseMarkdown(text)"
         />
         <!-- eslint-enable vue/no-v-html -->
       </div>
@@ -54,7 +54,7 @@
 
 <script>
   import contentfulMixin from '@/mixins/contentful.js';
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
 
   export default {
     name: 'LandingSubSection',
@@ -108,7 +108,7 @@
     },
 
     methods: {
-      parseMarkdownHtml
+      parseMarkdown
     }
   };
 </script>

diff --git a/packages/portal/src/components/story/StoryImageTextSlideScroller.vue b/packages/portal/src/components/story/StoryImageTextSlideScroller.vue
@@ -41,7 +41,7 @@
               >
                 <div
                   class="card-content"
-                  v-html="parseMarkdownHtml(slide.text)"
+                  v-html="parseMarkdown(slide.text)"
                 />
               </b-card>
               <!-- eslint-enable vue/no-v-html -->
@@ -54,7 +54,7 @@
 </template>
 
 <script>
-  import { parseMarkdownHtml } from '@/utils/markdown.js';
+  import parseMarkdown from '@/utils/markdown/parse.js';
   import ImageWithAttribution from '@/components/image/ImageWithAttribution';
   import { FULL_VIEWPORT_PRESETS } from '@/utils/contentful/imageCropPresets';
 
@@ -87,7 +87,7 @@
     },
 
     methods: {
-      parseMarkdownHtml,
+      parseMarkdown,
 
       appearDisappearSlideImage() {
         this.$refs.slideCards.forEach((card, index) => {

diff --git a/packages/portal/src/utils/markdown/parse.js b/packages/portal/src/utils/markdown/parse.js
@@ -0,0 +1,5 @@
+import { marked } from 'marked';
+
+export default (text) => {
+  return text ? marked.parse(text) : text;
+};
diff --git a/packages/portal/src/utils/markdown.js → packages/portal/src/utils/markdown/strip.js b/packages/portal/src/utils/markdown.js → packages/portal/src/utils/markdown/strip.js
@@ -4,10 +4,6 @@ const htmlRemovalPatternsFromTags = (tags) => {
   return [/\n$/].concat(tags.map((tag) => new RegExp(`</?${tag}.*?>`, 'gi')));
 };
 
-export const parseMarkdownHtml = (text) => {
-  return text ? marked.parse(text) : text;
-};
-
 /**
  * Strip markdown from text.
  * This method FIRST converts markdown to HTML, then removes HTML tags.
@@ -19,7 +15,7 @@ export const parseMarkdownHtml = (text) => {
  * @param {string[]} tags the HTML tags to be removed.
  * @return {String} text value with HTML breaks
  */
-export const stripMarkdown = (text, tags = ['']) => {
+export default (text, tags = ['']) => {
   text = marked.parse(text); // Marked adds newlines to the end of the string, and wraps it in a <p> tag.
   for (const pattern of htmlRemovalPatternsFromTags(tags)) {
     text = text.replace(pattern, '');

diff --git a/packages/portal/tests/unit/utils/markdown/parse.spec.js b/packages/portal/tests/unit/utils/markdown/parse.spec.js
@@ -0,0 +1,13 @@
+import parseMarkdown from '@/utils/markdown/parse.js';
+
+describe('utils/markdown/parse.js', () => {
+  describe('parseMarkdown', () => {
+    it('parses markdown into html', () => {
+      const markdown = '# Heading 1';
+
+      const html = parseMarkdown(markdown);
+
+      expect(html).toContain('<h1 id="heading-1">Heading 1</h1>');
+    });
+  });
+});
diff --git a/.../portal/tests/unit/utils/markdown.spec.js → ...l/tests/unit/utils/markdown/strip.spec.js b/.../portal/tests/unit/utils/markdown.spec.js → ...l/tests/unit/utils/markdown/strip.spec.js
@@ -1,16 +1,6 @@
-import { parseMarkdownHtml, stripMarkdown } from '@/utils/markdown.js';
-
-describe('utils/markdown', () => {
-  describe('parseMarkdownHtml', () => {
-    it('parses markdown into html', () => {
-      const markdown = '# Heading 1';
-
-      const html = parseMarkdownHtml(markdown);
-
-      expect(html).toContain('<h1 id="heading-1">Heading 1</h1>');
-    });
-  });
+import stripMarkdown from '@/utils/markdown/strip.js';
 
+describe('utils/markdown/strip.js', () => {
   describe('stripMarkdown', () => {
     describe('when the text is plain', () => {
       const textBefore = 'Contains only plain text.';