Fix Warning in ArgumentRenderer #1667

[mitsuruog]

Resolved

• Warning in ArgumentRenderer Warning in ArgumentRenderer #1667

I checked the behavior of the component of the original issue after I changed the name to optional and found that the following error occurred.

DoctrineError {name: "DoctrineError", message: "Unknown type undefined"}

What I have found in my research is that in the above cases, type.type in the returns is lost in getProps in this case.
returns should have NameExpression in type.type in my opinion.

// I saw this shape.
{ 
  description: 'return a Boolean Value', 
  type: { name: 'boolean' } 
}

// but it should be this shape.
{
  title: 'returns',
  description: 'return a Boolean Value',
  type: { type: 'NameExpression', name: 'boolean' }
}

[codecov]

Codecov Report

Merging #1671 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted Files	Coverage Δ
...lient/rsg-components/Argument/ArgumentRenderer.tsx	100.00% <ø> (ø)
src/loaders/utils/getProps.ts	98.61% <100.00%> (+0.03%)	⬆️
src/loaders/utils/resolveESModule.ts	100.00% <0.00%> (ø)

[sapegin]

Thanks for the pull request!

[sapegin]

Looks like this isn't different from the previous version, unless I'm missing something (in this case we should make it more clear).

We're returning method.returns if it's truthy, or returnTags[0].

[mitsuruog]

hmm... we need to make it more clear. in my case, method.returns have this object:

{ 
  description: 'return a Boolean Value', 
  type: { name: 'boolean' } 
}

and returnTags[0] have this object:

{
  title: 'returns',
  description: 'return a Boolean Value',
  type: { type: 'NameExpression', name: 'boolean' }
}

method.returns will have occurred DoctrineError when it does not have { type: 'NameExpression' }.
so I figured that merging both results would result in the intended object shape.
But I'm also sure I don't understand enough about this logic.

What should the correct object shape of results be?

[sapegin]

Now I'm even more confused. So now we're overwriting anything in method.returns with returnTags[0] but previously method.returns had higher priority.

If method.returns is missing the type, why not add it there? Something like this:

const getReturns = ({method, tags}) => {
                 if (method.returns) {
                       return {
                           ...method.returns,
                           type: { type: 'NameExpression', ...method.returns.type } 
                       }
                 }

		const returnTags = getMergedTag(
			tags as TagProps,
			JS_DOC_METHOD_RETURN_TAG_SYNONYMS
		) as TagParamObject[];

                 return returnTags[0];
}

[mitsuruog]

previously method.returns had higher priority.

I got it. I’ll add a change on the method.returns side.

[mitsuruog]

@sapegin please review me.

[sapegin]

🦄

[styleguidist-bot]

🎉 This PR is included in version 11.0.11 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀