Skip to content

Restore class names of default-exported modules #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −0
Open

Restore class names of default-exported modules #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions lib/transform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ function transform (data) {
doclet = renameThisProperty(doclet)
doclet = removeMemberofFromModule(doclet)
doclet = convertIsEnumFlagToKind(doclet)
doclet = renameModuleExports(doclet)
return doclet
})

Expand Down Expand Up @@ -401,3 +402,15 @@ function removeEnumChildren (json) {
}
})
}

/**
* Default exports lose their module name, showing up as module.exports, which
* is not very friendly. This restores the module name if we have it.
*/
function renameModuleExports(doclet) {
if (doclet.name === 'module.exports' && doclet.longname.startsWith('module:')) {
doclet.name = doclet.longname.replace('module:','')
console.log(doclet)
}
return doclet
}