Merge branch '227598-make-list-bullet-char-configurable' into 'master'

Static Site Editor: Allow to configure unordered lists bullet chars

See merge request gitlab-org/gitlab!36820

app/assets/javascripts/vue_shared/components/rich_content_editor/services/build_html_to_markdown_renderer.js

+/* eslint-disable @gitlab/require-i18n-strings */
 import { defaults, repeat } from 'lodash';
 
 const DEFAULTS = {
   subListIndentSpaces: 4,
+  unorderedListBulletChar: '-',
 };
 
 const countIndentSpaces = text => {
@@ -11,9 +13,12 @@ const countIndentSpaces = text => {
 };
 
 const buildHTMLToMarkdownRender = (baseRenderer, formattingPreferences = {}) => {
-  const { subListIndentSpaces } = defaults(formattingPreferences, DEFAULTS);
-  // eslint-disable-next-line @gitlab/require-i18n-strings
+  const { subListIndentSpaces, unorderedListBulletChar } = defaults(
+    formattingPreferences,
+    DEFAULTS,
+  );
   const sublistNode = 'LI OL, LI UL';
+  const unorderedListItemNode = 'UL LI';
 
   return {
     TEXT_NODE(node) {
@@ -47,6 +52,11 @@ const buildHTMLToMarkdownRender = (baseRenderer, formattingPreferences = {}) =>
 
       return reindentedList;
     },
+    [unorderedListItemNode](node, subContent) {
+      const baseResult = baseRenderer.convert(node, subContent);
+
+      return baseResult.replace(/^(\s*)([*|-])/, `$1${unorderedListBulletChar}`);
+    },
   };
 };
 

changelogs/unreleased/227598-make-list-bullet-char-configurable.yml

+---
+title: Set default bullet char character as - when generating markdown in Static Site Editor
+merge_request: 36820
+author:
+type: other

spec/frontend/vue_shared/components/rich_content_editor/services/build_html_to_markdown_renderer_spec.js

@@ -47,4 +47,24 @@ describe('HTMLToMarkdownRenderer', () => {
       expect(baseRenderer.convert).toHaveBeenCalledWith(NODE, list);
     });
   });
+
+  describe('UL LI visitor', () => {
+    it.each`
+      listItem           | unorderedListBulletChar | result             | bulletChar
+      ${'* list item'}   | ${undefined}            | ${'- list item'}   | ${'default'}
+      ${'  - list item'} | ${'*'}                  | ${'  * list item'} | ${'*'}
+      ${'  * list item'} | ${'-'}                  | ${'  - list item'} | ${'-'}
+    `(
+      'uses $bulletChar bullet char in unordered list items when $unorderedListBulletChar is set in config',
+      ({ listItem, unorderedListBulletChar, result }) => {
+        htmlToMarkdownRenderer = buildHTMLToMarkdownRenderer(baseRenderer, {
+          unorderedListBulletChar,
+        });
+        baseRenderer.convert.mockReturnValueOnce(listItem);
+
+        expect(htmlToMarkdownRenderer['UL LI'](NODE, listItem)).toBe(result);
+        expect(baseRenderer.convert).toHaveBeenCalledWith(NODE, listItem);
+      },
+    );
+  });
 });