mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-12 17:45:49 +08:00
Mandy Chen
465b4f7931
This PR adds devtools frontend localizability check to the presubmit script as reqeusted in https://chromium-review.googlesource.com/c/chromium/src/+/1504254. The new script, check_localizability.js, which run on frontend files changed as part of the devtools presubmit check. In addition, you can run $ npm run check-loc inside devtools/ to run the check on all frontend js files. **Note: Errors identified will be fixed and submitted as a separate PR. ** check_localizability.js usage: $ node check_localizability.js [-a | <.js file path>*] -a: scan all devtools frontend js files <.js file path>*: List of .js files with space-separated absolute paths Localizability violations that it scans for: - First argument to Common.UIString / UI.formatLocalized is not a string - Conditional argument (e.g. cond ? trueCase : falseCase) found in Common.UIString / UI.formatLocalized / ls tagged template literal - String concatenation is used with Common.UIString / UI.formatLocalized / ls`` - A specific argument to function is not localized (i.e. not wrapped in Common.UIString / UI.formatLocalized / ls``) - Currently, the script checks the third argument to createInput() Here are a few examples of errors the script can output: third_party\blink\renderer\devtools\front_end\resources\IndexedDBViews.js Line 1456: string concatenation should be changed to variable substitution with ls: ' (' + Common.UIString('Key path: ') third_party\blink\renderer\devtools\front_end\timeline\TimelineUIUtils.js Line 559-560: conditional(s) found in Common.UIString( '%s [%s\u2026%s]', url, event.args['beginData']['startLine'] + 1, endLine >= 0 ? endLine + 1 : ''). Please extract conditional(s) out of the localization call. Change-Id: I3243787ad5920b9b873f2feac7ed50a9c69bbe7e Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1524993 Reviewed-by: Dmitry Gozman <dgozman@chromium.org> Reviewed-by: Joel Einbinder <einbinder@chromium.org> Commit-Queue: Mandy Chen <mandy.chen@microsoft.com> Cr-Original-Commit-Position: refs/heads/master@{#643161} Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src Cr-Mirrored-Commit: f1c8d4f5752ed8ab43babb602fa86121f8b14dbb
DevTools Scripts
Development workflow scripts
These are scripts that can be useful to run independently as you're working on Chrome DevTools front-end.
The 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.
Overview
Folders
- build - Python package for generating DevTools debug and release mode
- chrome_debug_launcher - automagically finds Chrome Canary and launches it with debugging flags (e.g. remote debugging port)
- closure - see section on Closure Compiler below
- gulp - experimental build process written in node.js & gulp to remove the dependency on Chromium-specific build tools (i.e. gn and ninja)
- hosted_mode - run DevTools on a localhost development server
- jsdoc_validator - enforces the use of Closure type annotations
- local_node - installs a local runtime of node.js
Python Scripts
- convert_svg_images_to_png.py - manually run when adding svg images
- compile_frontend.py - runs closure compiler to do static type analysis
- Note: the compiled outputs are not actually used to run DevTools
- lint_javascript.py - run eslint
- optimize_png_images.py - manually run when adding png images
Node.js scripts
The 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).
Closure
DevTools 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.