Uncaught TypeError: Cannot read property 'names' of undefined

[dannyrb]

This bit of code:

.addFilter("$returns", function(symbol) {
        var returns = Array.isArray(symbol) ? symbol : symbol.returns;
        return DocmaWeb.Utils.getFormattedTypeList(docma.apis, returns, {
            delimeter: "|",
            descriptions: true,
            links: templateOpts.symbols.autoLink
        })
    })

Is called, and returns value is: [{description: "Object"}]

When this line is executed:

docma/lib/web/DocmaWeb.Utils.js

Line 1130 in 464fe5b

var types = item.type.names;

item is {description: "Object"} has a type of undefined, which causes this error.

[dannyrb]

I'm able to fix this issue by doing a find and replace for all instances of:

find:
@returns Object

replace:
@returns {Object}

We should probably emit a warning if no type is specified for @returns?

[onury]

Thanks for reporting.

Well that's actually invalid JSDoc but still we should watch for it. But shouldn't give warnings which would bloat the code too much. It'd be best to validate/lint jsdoc while writing it (via editors, plugins, etc) anyway..

I'm adding conditionals to watch out for this. I'll let you know shortly.

[dannyrb]

@onury, out of curiosity, what does your typical dev setup look like for enforcing valid JSDoc?

[onury]

Language	Linter	Rule	VSCode
JavaScript	ESLint	valid-jsdoc	extension
TypeScript	TSLint	jsdoc-format	extension

I use VSCode for editor and use/install proper extensions for linting while I write.

I include .eslintrc.json or tslint.json with the project's root. In the npm scripts section of the package.json, I make sure also my build command is preceded with the proper lint command.

[onury]

Fixed with Docma v3.0.0.