jsdoc/packages/jsdoc/test/specs/documentation/modules.js

describe('module names', () => {
  const path = require('path');

  let doclets;
  const env = jsdoc.deps.get('env');
  let srcParser = null;

  beforeEach(() => {
    env.opts._ = [path.normalize(`${__dirname}/../../fixtures/modules/data`)];
    env.sourceFiles = [];
    srcParser = jsdoc.createParser();
    require('jsdoc/src/handlers').attachTo(srcParser);
  });

  it('should create a name from the file path when no documented module name exists', () => {
    const filename = path.resolve(__dirname, '../../fixtures/modules/data/mod-1.js');

    env.sourceFiles.push(filename);
    doclets = srcParser.parse(filename);

    expect(doclets.length).toBeGreaterThan(1);
    expect(doclets[0].longname).toBe('module:mod-1');
  });

  // Windows-specific test
  if (/^win/.test(require('os').platform())) {
    it('should always use forward slashes when creating a name from the file path', () => {
      const { Doclet } = require('jsdoc/doclet');
      let doclet;

      env.sourceFiles = [
        'C:\\Users\\Jane Smith\\myproject\\index.js',
        'C:\\Users\\Jane Smith\\myproject\\lib\\mymodule.js',
      ];
      env.opts._ = [];

      doclet = new Doclet(
        '/** @module */',
        {
          lineno: 1,
          filename: 'C:\\Users\\Jane Smith\\myproject\\lib\\mymodule.js',
        },
        jsdoc.deps
      );

      expect(doclet.name).toBe('lib/mymodule');
    });
  }

  it('should use the documented module name if available', () => {
    const filename = path.resolve(__dirname, '../../fixtures/modules/data/mod-2.js');

    env.sourceFiles.push(filename);
    doclets = srcParser.parse(filename);

    expect(doclets.length).toBeGreaterThan(1);
    expect(doclets[0].longname).toBe('module:my/module/name');
  });
});