blob: 0a89e46603e84793c00817bb2a28099b8264ad6a [file] [log] [blame] [view]
Blink Reformat4c46d092018-04-07 15:32:371# DevTools Scripts
2
3## Development workflow scripts
4
5These are scripts that can be useful to run independently as you're working on Chrome DevTools front-end.
6
7The newer scripts such as for testing and hosted mode are written in Node.js, which has become the standard toolchain for web apps. The older scripts such as building (e.g. bundling and minifying) are written in Python, which has first-class support in Chromium's infrastructure.
8
9## Overview
10
11### Folders
12
13- build - Python package for generating DevTools debug and release mode
14- chrome_debug_launcher - automagically finds Chrome Canary and launches it with debugging flags (e.g. remote debugging port)
15- closure - see section on Closure Compiler below
16- gulp - experimental build process written in node.js & gulp to remove the dependency on Chromium-specific build tools (i.e. gn and ninja)
17- hosted_mode - run DevTools on a localhost development server
18- jsdoc_validator - enforces the use of Closure type annotations
19- local_node - installs a local runtime of node.js
20
21### Python Scripts
22- convert_svg_images_to_png.py - manually run when adding svg images
23- compile_frontend.py - runs closure compiler to do static type analysis
24 - Note: the compiled outputs are not actually used to run DevTools
25- lint_javascript.py - run eslint
26- optimize_png_images.py - manually run when adding png images
27
28### Node.js scripts
29
30The easiest way to run the node.js scripts is to use `npm run` which displays all the commands. For more information on the specific `npm run` commands, take a look at the primary devtools front-end readme (`../readme.md`).
31
32## Closure
33
34DevTools manually rolls the closure compiler to ./closure. If you manually roll closure compiler, you will need to re-generate the closure_runner (in ./closure) and jsdoc_validator custom jars using the python scripts in their respective directory.