jsdoc/packages/jsdoc-template-legacy/plugins/markdown.js

/*
  Copyright 2010 the JSDoc Authors.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/
/**
 * Translate doclet descriptions from Markdown into HTML.
 */
import { getRenderer } from '../lib/markdown.js';

const tags = [
  'author',
  'classdesc',
  'description',
  'exceptions',
  'params',
  'properties',
  'returns',
  'see',
  'summary',
];
const render = getRenderer();

function shouldProcessString(tagName, text) {
  let shouldProcess = true;

  // we only want to process `@author` and `@see` tags that contain Markdown links
  if ((tagName === 'author' || tagName === 'see') && !text.includes('[')) {
    shouldProcess = false;
  }

  return shouldProcess;
}

/**
 * Process the Markdown source in a doclet. Handled properties can be bare strings, objects, or
 * arrays of objects.
 */
function process(doclet) {
  tags.forEach((tag) => {
    if (!Object.hasOwn(doclet, tag)) {
      return;
    }

    if (typeof doclet[tag] === 'string' && shouldProcessString(tag, doclet[tag])) {
      doclet[tag] = render(doclet[tag]);
    } else if (Array.isArray(doclet[tag])) {
      doclet[tag].forEach((value, index, original) => {
        const inner = {};

        inner[tag] = value;
        process(inner);
        original[index] = inner[tag];
      });
    } else if (doclet[tag]) {
      process(doclet[tag]);
    }
  });
}

export const handlers = {
  /**
   * Translate Markdown syntax within a doclet into HTML.
   */
  newDoclet({ doclet }) {
    process(doclet);
  },
};