mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-06 12:01:40 +08:00
Tim van der Lippe
c8f6ffd7c3
Also update the PRESUBMIT linter configuration to make sure it actually runs the linter when updating ESLint. Otherwise, it would not properly do the full linter check. R=jacktfranklin@chromium.org DISABLE_THIRD_PARTY_CHECK=Update ESLint Bug: 1068145 Change-Id: Ibf2de156366dc64c90ee1aced5537d2038e7a268 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/2137384 Commit-Queue: Tim van der Lippe <tvanderlippe@chromium.org> Reviewed-by: Jack Franklin <jacktfranklin@chromium.org>
117 lines
3.3 KiB
JavaScript
117 lines
3.3 KiB
JavaScript
/**
|
|
* @fileoverview `ConfigDependency` class.
|
|
*
|
|
* `ConfigDependency` class expresses a loaded parser or plugin.
|
|
*
|
|
* If the parser or plugin was loaded successfully, it has `definition` property
|
|
* and `filePath` property. Otherwise, it has `error` property.
|
|
*
|
|
* When `JSON.stringify()` converted a `ConfigDependency` object to a JSON, it
|
|
* omits `definition` property.
|
|
*
|
|
* `ConfigArrayFactory` creates `ConfigDependency` objects when it loads parsers
|
|
* or plugins.
|
|
*
|
|
* @author Toru Nagashima <https://github.com/mysticatea>
|
|
*/
|
|
"use strict";
|
|
|
|
const util = require("util");
|
|
|
|
/**
|
|
* The class is to store parsers or plugins.
|
|
* This class hides the loaded object from `JSON.stringify()` and `console.log`.
|
|
* @template T
|
|
*/
|
|
class ConfigDependency {
|
|
|
|
/**
|
|
* Initialize this instance.
|
|
* @param {Object} data The dependency data.
|
|
* @param {T} [data.definition] The dependency if the loading succeeded.
|
|
* @param {Error} [data.error] The error object if the loading failed.
|
|
* @param {string} [data.filePath] The actual path to the dependency if the loading succeeded.
|
|
* @param {string} data.id The ID of this dependency.
|
|
* @param {string} data.importerName The name of the config file which loads this dependency.
|
|
* @param {string} data.importerPath The path to the config file which loads this dependency.
|
|
*/
|
|
constructor({
|
|
definition = null,
|
|
error = null,
|
|
filePath = null,
|
|
id,
|
|
importerName,
|
|
importerPath
|
|
}) {
|
|
|
|
/**
|
|
* The loaded dependency if the loading succeeded.
|
|
* @type {T|null}
|
|
*/
|
|
this.definition = definition;
|
|
|
|
/**
|
|
* The error object if the loading failed.
|
|
* @type {Error|null}
|
|
*/
|
|
this.error = error;
|
|
|
|
/**
|
|
* The loaded dependency if the loading succeeded.
|
|
* @type {string|null}
|
|
*/
|
|
this.filePath = filePath;
|
|
|
|
/**
|
|
* The ID of this dependency.
|
|
* @type {string}
|
|
*/
|
|
this.id = id;
|
|
|
|
/**
|
|
* The name of the config file which loads this dependency.
|
|
* @type {string}
|
|
*/
|
|
this.importerName = importerName;
|
|
|
|
/**
|
|
* The path to the config file which loads this dependency.
|
|
* @type {string}
|
|
*/
|
|
this.importerPath = importerPath;
|
|
}
|
|
|
|
// eslint-disable-next-line jsdoc/require-description
|
|
/**
|
|
* @returns {Object} a JSON compatible object.
|
|
*/
|
|
toJSON() {
|
|
const obj = this[util.inspect.custom]();
|
|
|
|
// Display `error.message` (`Error#message` is unenumerable).
|
|
if (obj.error instanceof Error) {
|
|
obj.error = { ...obj.error, message: obj.error.message };
|
|
}
|
|
|
|
return obj;
|
|
}
|
|
|
|
// eslint-disable-next-line jsdoc/require-description
|
|
/**
|
|
* @returns {Object} an object to display by `console.log()`.
|
|
*/
|
|
[util.inspect.custom]() {
|
|
const {
|
|
definition: _ignore, // eslint-disable-line no-unused-vars
|
|
...obj
|
|
} = this;
|
|
|
|
return obj;
|
|
}
|
|
}
|
|
|
|
/** @typedef {ConfigDependency<import("../../shared/types").Parser>} DependentParser */
|
|
/** @typedef {ConfigDependency<import("../../shared/types").Plugin>} DependentPlugin */
|
|
|
|
module.exports = { ConfigDependency };
|