fix: the "caption" should place behind the tag of "example" (#15)

* chore: prettier * fix: the "caption" should place behind the tag of "example" * fix: handler multi caption tag Co-authored-by: Hossein Mohammadi <[email protected]>
hosseinmd · Dec 19, 2020 · b8d6e34 · b8d6e34
1 parent 0c0292a
commit b8d6e34
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 3 deletions.
diff --git a/src/stringify.ts b/src/stringify.ts
@@ -101,6 +101,15 @@ const stringify = (
 
  // Try to use prettier on @example tag description
  if (tag === EXAMPLE) {
+ const exampleCaption = description.match(
+ /<caption>(((?!(<\/caption>))[\s\S])*)<\/caption>/i,
+ );
+
+ if (exampleCaption) {
+ description = description.replace(exampleCaption[0], "");
+ tagString = `${tagString} ${exampleCaption[0]}`;
+ }
+
  try {
  const formattedExample = format(description || "", options);
  tagString += formattedExample.replace(/(^|\n)/g, "\n ");

diff --git a/tests/__snapshots__/main.test.js.snap b/tests/__snapshots__/main.test.js.snap
@@ -32,8 +32,18 @@ exports[`Big single word 1`] = `
 
 exports[`Example start by xml tag 1`] = `
 "/**
- * @example
- * <caption>TradingViewChart</caption>;
+ * @example <caption>TradingViewChart</caption>
+ * export default Something;
+ */
+"
+`;
+
+exports[`Example start by xml tag 2`] = `
+"/**
+ * @example <caption>TradingViewChart</caption>
+ * function Something() {
+ * return <caption>TradingViewChart</caption>;
+ * }
  * export default Something;
  */
 "

diff --git a/tests/main.test.js b/tests/main.test.js
@@ -367,12 +367,25 @@ test("Example start by xml tag", () => {
  const result = subject(`
  /**
  * @example <caption>TradingViewChart</caption>;
- *
+ * 
  * export default Something
  */
 `);
 
  expect(result).toMatchSnapshot();
+
+ const result1 = subject(`
+ /**
+ * @example <caption>TradingViewChart</caption>
+ *
+ * function Something(){
+ * return <caption>TradingViewChart</caption>
+ * }
+ * export default Something
+ */
+`);
+
+ expect(result1).toMatchSnapshot();
 });
 
 test("Bad defined name", () => {