Infer module names

documentationjs · Oct 12, 2015 · 4c2cc4d · 4c2cc4d
1 parent 5449757
commit 4c2cc4d
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 5 deletions.
diff --git a/lib/infer/name.js b/lib/infer/name.js
@@ -1,6 +1,7 @@
 'use strict';
 
-var types = require('ast-types');
+var types = require('ast-types'),
+  pathParse = require('parse-filepath');
 
 /**
  * Infers a `name` tag from the context,
@@ -33,6 +34,11 @@ module.exports = function () {
       return comment;
     }
 
+    if (comment.module) {
+      comment.name = comment.module.name || pathParse(comment.context.file).name;
+      return comment;
+    }
+
     if (comment.typedef) {
       comment.name = comment.typedef.name;
       return comment;

diff --git a/test/lib/infer/name.js b/test/lib/infer/name.js
@@ -4,15 +4,15 @@ var test = require('tap').test,
   parse = require('../../../lib/parsers/javascript'),
   inferName = require('../../../lib/infer/name')();
 
-function toComment(fn, filename) {
+function toComment(fn, file) {
   return parse({
-    file: filename,
+    file: file,
     source: fn instanceof Function ? '(' + fn.toString() + ')' : fn
   })[0];
 }
 
-function evaluate(fn, callback) {
-  return inferName(toComment(fn, callback));
+function evaluate(fn, file) {
+  return inferName(toComment(fn, file));
 }
 
 test('inferName', function (t) {
@@ -136,5 +136,38 @@ test('inferName', function (t) {
     return implicitName;
   }).name, 'explicitCallback', 'explicitCallback');
 
+  t.equal(evaluate(function () {
+    /**
+     * @module explicitModule
+     * @returns {undefined} baz
+     */
+    function implicitName() {}
+    return implicitName;
+  }).name, 'explicitModule');
+
+  t.equal(evaluate(function () {
+    /**
+     * @module {Function} explicitModule
+     * @returns {undefined} baz
+     */
+    function implicitName() {}
+    return implicitName;
+  }).name, 'explicitModule');
+
+  t.equal(evaluate(function () {
+    /**
+     * @module
+     * @returns {undefined} baz
+     */
+    function implicitName() {}
+    return implicitName;
+  }, '/path/inferred-from-file.js').name, 'inferred-from-file');
+
+  t.equal(evaluate(function () {
+    /**
+     * @module
+     */
+  }, '/path/inferred-from-file.js').name, 'inferred-from-file');
+
   t.end();
 });