Opened 19 months ago

Last modified 18 months ago

#7225 closed change

Add jsdoc script to package.json in adblockpluscore — at Version 4

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.

Note

Since this change does not impact any of the behavior in the extension I propose we land this to master as we have done in adblockpluschrome

Change History (4)

comment:1 Changed 19 months ago by jsonesen

  • Status changed from new to reviewing

comment:2 Changed 19 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 19 months ago by mjethani

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

comment:4 Changed 19 months ago by mjethani

  • Description modified (diff)
Note: See TracTickets for help on using tickets.