Issue 5560 - Specify the JSDoc dependency explicitly

build.py

 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 import os
 import sys
 import re
 import subprocess
 import shutil
 import buildtools
@@ skipping 393 matching lines @@
         return
     targetDir = args[0]
 
     source_dir = os.path.join(baseDir, 'lib')
     sources = [source_dir]
 
     # JSDoc struggles wih huge objects: https://github.com/jsdoc3/jsdoc/issues/976
     if type == 'chrome':
         sources = [os.path.join(source_dir, filename) for filename in os.listdir(source_dir) if filename != 'publicSuffixList.js']
 
-    config = os.path.join(os.path.dirname(__file__), 'jsdoc.conf')
-    command = ['jsdoc', '--destination', targetDir, '--configure', config] + sources
+    buildtools_path = os.path.dirname(__file__)
+    config = os.path.join(buildtools_path, 'jsdoc.conf')
+
+    command = ['npm', 'run-script', 'jsdoc', '--', '--destination', targetDir,
+               '--configure', config] + sources
     if any(opt in ('-q', '--quiet') for opt, _ in opts):
-        process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        process = subprocess.Popen(command, stdout=subprocess.PIPE,
+                                   stderr=subprocess.PIPE, cwd=buildtools_path)
         stderr = process.communicate()[1]
         retcode = process.poll()
         if retcode:
             sys.stderr.write(stderr)
             raise subprocess.CalledProcessError(command, retcode)
     else:
-        subprocess.check_call(command)
+        subprocess.check_call(command, cwd=buildtools_path)
 
 
 def runReleaseAutomation(baseDir, scriptName, opts, args, type):
     keyFile = None
     downloadsRepo = os.path.join(baseDir, '..', 'downloads')
     for option, value in opts:
         if option in ('-k', '--key'):
             keyFile = value
         elif option in ('-d', '--downloads'):
             downloadsRepo = value
@@ skipping 73 matching lines @@
 
 with addCommand(showDescriptions, 'showdesc') as command:
     command.shortDescription = 'Print description strings for all locales'
     command.description = 'Display description strings for all locales as specified in the corresponding meta.properties files.'
     command.addOption('Only include the given locales', short='l', long='locales', value='l1,l2,l3')
     command.params = '[options]'
     command.supportedTypes = ('gecko')
 
 with addCommand(generateDocs, 'docs') as command:
     command.shortDescription = 'Generate documentation (requires node.js)'
-    command.description = 'Generate documentation files and write them into the specified directory. This operation requires JsDoc 3 to be installed.'
+    command.description = 'Generate documentation files and write them into the specified directory.'

[tlucas, 2017/08/30 17:33:21]

nit: While at it, how do you feel about limiting line length to 79 characters?
(PEP-8)

[kzar, 2017/08/31 10:54:35]

Done.

     command.addOption('Suppress JsDoc output', short='q', long='quiet')
     command.params = '[options] <directory>'
     command.supportedTypes = ('gecko', 'chrome')
 
 with addCommand(runReleaseAutomation, 'release') as command:
     command.shortDescription = 'Run release automation'
     command.description = 'Note: If you are not the project owner then you '        "probably don't want to run this!\n\n"        'Runs release automation: creates downloads for the new version, tags '        'source code repository as well as downloads and buildtools repository.'
     command.addOption('File containing private key and certificates required to sign the release.', short='k', long='key', value='file', types=('chrome', 'safari', 'edge'))
     command.addOption('Directory containing downloads repository (if omitted ../downloads is assumed)', short='d', long='downloads', value='dir')
     command.params = '[options] <version>'
@@ skipping 70 matching lines @@
                 if option in ('-h', '--help'):
                     usage(scriptName, type, command)
                     sys.exit()
             commands[command](baseDir, scriptName, opts, args, type)
         else:
             print 'Command %s is not supported for this application type' % command
             usage(scriptName, type)
     else:
         print 'Command %s is unrecognized' % command
         usage(scriptName, type)