DevTools: prepare to unify Network and CPU throttling UI

third_party/WebKit/Source/devtools/scripts/extract_module/extract_module.js

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 'use strict';
 const fs = require('fs');
 const path = require('path');
 
 const utils = require('../utils');
 
 const FRONTEND_PATH = path.resolve(__dirname, '..', '..', 'front_end');
 const BUILD_GN_PATH = path.resolve(__dirname, '..', '..', 'BUILD.gn');
 const SPECIAL_CASE_NAMESPACES_PATH = path.resolve(__dirname, '..', 'special_case_namespaces.json');
 
+/*
+ * ==========================================
+ * START EDITING HERE - TRANSFORMATION INPUTS
+ * ==========================================
+ */
+
 const APPLICATION_DESCRIPTORS = [
   'inspector.json',
   'toolbox.json',
   'unit_test_runner.json',
   'formatter_worker.json',
   'heap_snapshot_worker.json',
   'utility_shared_worker.json',
 ];
 
-// Replace based on specified transformation
+/*
+ * If the transformation removes all the files of a module:
+ * ['text_editor']
+ */
 const MODULES_TO_REMOVE = [];
 
+/**
+ * If moving to a new module:
+ * {file: 'common/Text.js', new: 'a_new_module'}
+ *
+ * If moving to an existing module:
+ * {file: 'ui/SomeFile.js', existing: 'common'}
+ */
 const JS_FILES_MAPPING = [
-  {file: 'common/Text.js', new: 'text_utils'},
-  {file: 'common/TextUtils.js', new: 'text_utils'},
-  {file: 'common/TextRange.js', new: 'text_utils'},
+  {file: 'mobile_throttling/NetworkPriorities.js', new: 'network_priorities'},
 ];
 
+/**
+ * List all new modules here:
+ * mobile_throttling: {
+ *   dependencies: ['sdk'],
+ *   dependents: ['console'],
+ *   applications: ['inspector.json'],
+ *   autostart: false,
+ * }
+ */
 const MODULE_MAPPING = {
-  text_utils: {
-    dependencies: [],
-    dependents: ['common'],
+  network_priorities: {
+    dependencies: ['protocol', 'common'],
+    dependents: ['network', 'timeline'],
     applications: ['inspector.json'],
-    autostart: true,  // set to autostart because of extensions
+    autostart: false,
   },
 };
 
+/**
+ * If an existing module will have a new dependency on an existing module:
+ * console: ['new_dependency']
+ */
 const NEW_DEPENDENCIES_BY_EXISTING_MODULES = {
     // resources: ['components'],
 };
 
+/**
+ * If an existing module will no longer have a dependency on a module:
+ * console: ['former_dependency']
+ */
 const REMOVE_DEPENDENCIES_BY_EXISTING_MODULES = {};
 
+/*
+ * ==========================================
+ * STOP EDITING HERE
+ * ==========================================
+ */
+
 const DEPENDENCIES_BY_MODULE = Object.keys(MODULE_MAPPING).reduce((acc, module) => {
   acc[module] = MODULE_MAPPING[module].dependencies;
   return acc;
 }, {});
 
 const APPLICATIONS_BY_MODULE = Object.keys(MODULE_MAPPING).reduce((acc, module) => {
   acc[module] = MODULE_MAPPING[module].applications;
   return acc;
 }, {});
 
@@ skipping 572 matching lines @@
   if (newModules.length === 0)
     return;
   let includeNewModules = (acc, line) => {
     if (line.includes('{') && line.endsWith('}')) {
       line += ',';
       acc.push(line);
       return acc.concat(newModules.map((m, i) => {
         // Need spacing to preserve indentation
         let string;
         if (MODULE_MAPPING[m].autostart)
-          string = `        { "name": "${m}", "type": "autostart"}`;
+          string = `        { "name": "${m}", "type": "autostart" }`;
         else
           string = `        { "name": "${m}" }`;
         if (i !== newModules.length - 1)
           string += ',';
         return string;
       }));
     }
     return acc.concat([line]);
   };
   let removeModules = (acc, line) => MODULES_TO_REMOVE.every(m => !line.includes(m)) ? acc.concat([line]) : acc;
@@ skipping 30 matching lines @@
   return string.split('')
       .map(function(char) {
         var charCode = char.charCodeAt(0);
         return charCode > 127 ? unicodeCharEscape(charCode) : char;
       })
       .join('');
 }
 
 if (require.main === module)
   extractModule();