Closed Bug 1498604 Opened 3 years ago Closed 1 month ago
'./mach doc' should not require globally installed jsdoc (vendor it)
47 bytes, text/x-phabricator-request
|Details | Review|
Bug 1498604 - Make './mach doc' use jsdoc installed into node_modules rather than the system. r?Mossop!,ahal!
48 bytes, text/x-phabricator-request
|Details | Review|
Currently, running `./mach doc` requires to have jsdoc installed globally. However there's nothing that tells the developer this. It also doesn't give control over which version is used, so a developer could be on an out-of-date or too new version and get strange errors. Lastly it is one thing that requires node to be installed globally in our docker images, rather than using the node that the build system will use. https://searchfox.org/mozilla-central/rev/28fe656de6a022d1fc01bbd3811023fca99cf223/taskcluster/docker/lint/system-setup.sh#46-58 Given the current moves to have vendor node_modules, and node as part of the build system. I think we should either: 1) Add jsdoc as a vendored item in node_modules (after other bugs are done, e.g. bug 1491021 and bug 1491028). 2) Somehow install jsdoc into .mozbuild & use that version. I'm leaning towards the first option here, as that seems easier to set up and more consistent with how we're running everything.
Vendoring it in sounds like the right plan to me.
Severity: normal → enhancement
Summary: './mach doc' should not require globally installed jsdoc → './mach doc' should not require globally installed jsdoc (vendor it)
Pushed by firstname.lastname@example.org: https://hg.mozilla.org/integration/autoland/rev/2d5fff240adc Update the message to use mach npm now.r=dmose
Assignee: shivams2799 → standard8
Pushed by email@example.com: https://hg.mozilla.org/integration/autoland/rev/53d4fb9f562f Make './mach doc' use jsdoc installed into node_modules rather than the system. r=mossop,ahal
Pushed by firstname.lastname@example.org: https://hg.mozilla.org/integration/autoland/rev/3425029be980 Make './mach doc' use jsdoc installed into node_modules rather than the system. r=mossop,ahal
Iteration: --- → 89.2 - Apr 5 - Apr 18
Points: --- → 5
Priority: -- → P2
Status: ASSIGNED → RESOLVED
Closed: 1 month ago
Resolution: --- → FIXED
Target Milestone: --- → 89 Branch
You need to log in before you can comment on or make changes to this bug.