Skip to content

🛠 Repo: Bump jsdoc from 3 to 4 #5485

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Tooling Suggestion Checklist

Overview

Mocha has a devDependency right now on a 4-year-old version of jsdoc:

"jsdoc": "^3.6.7",

This isn't a problem on its own. jsdoc@3 works as-is. But it pulls in old dependencies that bloat our local node_modules size. For example, in #5484, we see it pulling in strip-json-comments@3:

$ npm ls strip-json-comments@3
[email protected] /Users/josh/repos/mocha
├─┬ [email protected]
│ └─┬ @eslint/[email protected]
│   └── [email protected]
├─┬ [email protected]
│ └── [email protected]
└─┬ [email protected]
  └─┬ [email protected]
    └── [email protected]

I think it'd be a good idea in general to bump it to the latest major version.

Additional Info

In theory it'd be nice to automatically upgrade all devDependencies. #5055 is blocked for now: #5055 (comment).

JSDoc only recently started using semantic versioning, so there may be difficult-to-find breaking changes: https://github.com/jsdoc/jsdoc/blob/main/CHANGES.md

💖

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: repository toolingconcerning ease of contributionstatus: in triagea maintainer should (re-)triage (review) this issue

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions