jsdoc/packages/jsdoc-plugins/test/specs/escape-html.js

/*
  Copyright 2012 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.
*/

import path from 'node:path';

import { plugins } from '@jsdoc/core';

describe('escape-html plugin', () => {
  const __dirname = jsdoc.dirname(import.meta.url);
  let docSet;
  const parser = jsdoc.createParser();
  const pluginPath = path.join(__dirname, '../../escape-html.js');

  beforeAll(async () => {
    await plugins.installPlugins([pluginPath], parser, jsdoc.env);
    docSet = jsdoc.getDocSetFromFile(pluginPath, parser);
  });

  it('escapes `&`, `<`, and newlines in doclet descriptions', () => {
    const doclet = docSet.getByLongname('handlers.newDoclet')[0];

    expect(doclet.description).toBe(
      'Translate HTML tags in descriptions into safe ' +
        'entities. Replaces &lt;, &amp; and newlines'
    );
  });
});