codeceptjs/typings/jsdoc.namespace.js

Modern Era Acceptance Testing Framework for NodeJS

// Helps tsd-jsdoc to exports all typings into the CodeceptJS namespace,
// instead of the global.

let namespaceAdded = false;
const kinds = ['class', 'constant', 'function', 'typedef', 'interface'];
const namespace = 'CodeceptJS';

module.exports = {
  handlers: {
    beforeParse(event) {
      if (!namespaceAdded) {
        event.source += `/** @namespace ${namespace} */`;
        namespaceAdded = true;
      }
    },
    newDoclet: ({ doclet }) => {
      if (doclet.undocumented || doclet.memberof || !kinds.includes(doclet.kind)) return;
      doclet.memberof = namespace;
      doclet.longname = `${doclet.memberof}.${doclet.longname}`;
      if (doclet.scope === 'global') doclet.scope = 'static';
    },
  },
};