Opened 10 months ago

Closed 10 months ago

Last modified 10 months ago

#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.

Change History (9)

comment:1 Changed 10 months ago by jsonesen

  • Status changed from new to reviewing

comment:2 Changed 10 months ago by mjethani

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.

comment:3 Changed 10 months ago by mjethani

  • Milestone Adblock-Plus-3.4.3-for-Chrome-Opera-Firefox deleted
  • Priority changed from Unknown to P3

comment:4 Changed 10 months ago by mjethani

  • Description modified (diff)

comment:5 follow-up: Changed 10 months ago 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.

Last edited 10 months ago by mjethani (previous) (diff)

comment:6 in reply to: ↑ 5 Changed 10 months ago 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 10 months ago by abpbot

A commit referencing this issue has landed:
Issue 7225 - Add jsdoc script to package.json

comment:8 Changed 10 months ago by mjethani

  • Description modified (diff)
  • Ready set
  • Resolution set to fixed
  • Status changed from reviewing to closed

comment:9 Changed 10 months ago by abpbot

A commit referencing this issue has landed:
Issue 7225 - Add jsdoc script to package.json

Note: See TracTickets for help on using tickets.