feat(prettier-plugin-jsdoc): add function to render example tags

src/fns/renderExampleTag.js

@@ -0,0 +1,16 @@
+/**
+ * @typedef {import('../types').CommentTag} CommentTag
+ */
+
+/**
+ * Renders an `example` tag by just adding the code below the tag.
+ *
+ * @param {CommentTag} tag The tag to render.
+ * @returns {string[]}
+ */
+const renderExampleTag = (tag) => [
+  `@${tag.tag}`,
+  ...tag.description.split('\n'),
+];
+
+module.exports.renderExampleTag = renderExampleTag;

test/unit/fns/renderExampleTag.test.js

@@ -0,0 +1,23 @@
+jest.unmock('../../../src/fns/renderExampleTag');
+
+const { renderExampleTag } = require('../../../src/fns/renderExampleTag');
+
+describe('renderExampleTag', () => {
+  it('should ignore a tag that\'s not @example', () => {
+    // Given
+    const input = {
+      tag: 'example',
+      description: 'const fn = (msg) => console.log(msg);\nfn(\'hello world!\');',
+    };
+    const output = [
+      '@example',
+      'const fn = (msg) => console.log(msg);',
+      'fn(\'hello world!\');',
+    ];
+    let result = null;
+    // When
+    result = renderExampleTag(input);
+    // Then
+    expect(result).toEqual(output);
+  });
+});