Opened on 01/18/2019 at 03:37:54 PM
Closed on 01/29/2019 at 08:55:53 AM
Last modified on 02/07/2019 at 03:24:06 AM
#7225 closed change (fixed)
Add jsdoc script to package.json in adblockpluscore
| Reported by: | jsonesen | Assignee: | jsonesen |
|---|---|---|---|
| Priority: | P3 | Milestone: | |
| Module: | Core | Keywords: | |
| Cc: | mjethani, sebastian, kzar, tlucas | Blocked By: | |
| Blocking: | Platform: | Unknown / Cross platform | |
| Ready: | yes | Confidential: | no |
| Tester: | Unknown | Verified working: | no |
| Review URL(s): |
https://gitlab.com/eyeo/adblockplus/adblockpluscore/merge_requests/16 |
||
Description (last modified by mjethani)
Background
As part of the effort to move our build process away from its python dependency it would be helpful to stop using a subprocess orchestrated by python, and in its place have an npm script "docs" to do this.
What to change
- Add .jsdoc.conf to root dir of repo (we use long names in the navigation panel of the generated docs). It would be really cool to configure this inline without needing to add a new file, but I have not found an option for the jsdoc cli to configure from command opts.
- Update package.json to have the jsdoc call jsdoc --configure .jsdoc.conf --destination docs lib as well as include the jsdoc dependency.
Attachments (0)
Change History (9)
comment:1 Changed on 01/18/2019 at 03:38:18 PM by jsonesen
- Status changed from new to reviewing
comment:2 Changed on 01/18/2019 at 04:23:21 PM by mjethani
comment:3 Changed on 01/18/2019 at 04:24:16 PM by mjethani
- Milestone Adblock-Plus-3.4.3-for-Chrome-Opera-Firefox deleted
- Priority changed from Unknown to P3
comment:5 follow-up: ↓ 6 Changed on 01/18/2019 at 04:32:39 PM by mjethani
We don't normally set the milestone for adblockpluscore issues (since adblockpluscore is not "released" per se).
Since all the other configuration files (.hgignore, .gitignore, .eslintrc.json, .gitlab-ci.yml, etc.) are dotfiles, let's rename jsdoc.conf to .jsdoc.conf as well. What do you think? If you agree, please update the issue description and the patch.
comment:6 in reply to: ↑ 5 Changed on 01/18/2019 at 04:54:43 PM by jsonesen
Replying to mjethani:
We don't normally set the milestone for adblockpluscore issues (since adblockpluscore is not "released" per se).
Since all the other configuration files (.hgignore, .gitignore, .eslintrc.json, .gitlab-ci.yml, etc.) are dotfiles, let's rename jsdoc.conf to .jsdoc.conf as well. What do you think? If you agree, please update the issue description and the patch.
Hm, that's a good catch, I had not considered the existing convention. I actually think I will ask about doing this in abpchrome as well. I will update the issue description and push a new patch.
comment:7 Changed on 01/28/2019 at 06:21:10 PM by abpbot
A commit referencing this issue has landed:
Issue 7225 - Add jsdoc script to package.json
comment:8 Changed on 01/29/2019 at 08:55:53 AM by mjethani
- Description modified (diff)
- Ready set
- Resolution set to fixed
- Status changed from reviewing to closed
comment:9 Changed on 02/07/2019 at 03:24:06 AM by abpbot
A commit referencing this issue has landed:
Issue 7225 - Add jsdoc script to package.json
Every change that is in master should also be in next, this keeps it simple. Let's land this on next. We will soon merge next into master anyway.
If there's a good reason to have this in master sooner, I can just graft it from next.