azu / azu/jsdoc-to-assert

Problems with nested params

Open
#18 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
JavaScript
Stars
38
Forks
4
PR merge metrics
No merged PRs in 30d

Description

It seems to have problems with params like this:

```js
/**
* @param {object} thing
* @param {object[]} thing.stuff
* @param {string} thing.stuff[].name
* @param {number} thing.stuff[].index
*/
```

It seems to interpret everything from `thing.stuff` as `thing.stuff` and doesn't dive lower than that.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the JSDoc example from the issue and trace how nested parameter paths are parsed and converted into assertions. Done means properties under thing.stuff, including each item's name and index, are handled at their nested paths rather than being treated as one path.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.