documentationjs / documentationjs/documentation

@internal tag crashes documentationjs if indexed type follows

Open
#1,335 1 comment 0 reactions 0 assignees View on GitHub
needs-testcase
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

```typescript
/** @internal */
export type AnyObj = { [key: string]: any };
```

this will crash documentation

```
$ npx documentation readme src/** --readme-file=API.md --section=API --parse-extension ts --shallow --resolve node --config documentation.yaml
TypeError: Cannot read property 'charAt' of undefined
at Of.inlineCode (/.../node_modules/remark-stringify/lib/visitors/inline-code.js:26:13)
```

This is an officially supported typescript tag.

Interestingly it only seems to happen when using an indexed object type like the above with the internal tag specifically

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.