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
mocha@11.7.4 /Users/josh/repos/mocha
├─┬ eslint@8.56.0
│ └─┬ @eslint/eslintrc@2.1.4
│   └── strip-json-comments@3.1.1
├─┬ jsdoc@3.6.11
│ └── strip-json-comments@3.1.1
└─┬ markdownlint-cli@0.30.0
  └─┬ run-con@1.2.11
    └── strip-json-comments@3.1.1

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

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions