diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /devtools/shared/compatibility/helpers.js | |
parent | Initial commit. (diff) | |
download | firefox-esr-upstream.tar.xz firefox-esr-upstream.zip |
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/shared/compatibility/helpers.js')
-rw-r--r-- | devtools/shared/compatibility/helpers.js | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/devtools/shared/compatibility/helpers.js b/devtools/shared/compatibility/helpers.js new file mode 100644 index 0000000000..d69e92a929 --- /dev/null +++ b/devtools/shared/compatibility/helpers.js @@ -0,0 +1,112 @@ +/* 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/. */ + +"use strict"; + +// This file might be required from a node script (./bin/update.js), so don't use +// Chrome API here. + +/** + * Return the compatibility table from given compatNode and specified terms. + * For example, if the terms is ["background-color"], + * this function returns compatNode["background-color"].__compat. + * + * @return {Object} compatibility table + * { + * description: {String} Description of this compatibility table. + * mdn_url: {String} Document in the MDN. + * support: { + * $browserName: {String} $browserName is such as firefox, firefox_android and so on. + * [ + * { + * added: {String} + * The version this feature was added. + * removed: {String} Optional. + * The version this feature was removed. Optional. + * prefix: {String} Optional. + * The prefix this feature is needed such as "-moz-". + * alternative_name: {String} Optional. + * The alternative name of this feature such as "-moz-osx-font-smoothing" of "font-smooth". + * notes: {String} Optional. + * A simple note for this support. + * }, + * ... + * ], + * }, + * status: { + * experimental: {Boolean} If true, this feature is experimental. + * standard_track: {Boolean}, If true, this feature is on the standard track. + * deprecated: {Boolean} If true, this feature is deprecated. + * } + * } + */ +function getCompatTable(compatNode, terms) { + let targetNode = getCompatNode(compatNode, terms); + + if (!targetNode) { + return null; + } + + if (!targetNode.__compat) { + for (const field in targetNode) { + // TODO: We don't have a way to know the context for now. + // Thus, use first context node as the compat table. + // e.g. flex_context of align-item + // https://github.com/mdn/browser-compat-data/blob/master/css/properties/align-items.json#L5 + if (field.endsWith("_context")) { + targetNode = targetNode[field]; + break; + } + } + } + + return targetNode.__compat; +} + +/** + * Return a compatibility node which is target for `terms` parameter from `compatNode` + * parameter. For example, when check `background-clip: content-box;`, the `terms` will + * be ["background-clip", "content-box"]. Then, follow the name of terms from the + * compatNode node, return the target node. Although this function actually do more + * complex a bit, if it says simply, returns a node of + * compatNode["background-clip"]["content-box""] . + */ +function getCompatNode(compatNode, terms) { + for (const term of terms) { + compatNode = getChildCompatNode(compatNode, term); + if (!compatNode) { + return null; + } + } + + return compatNode; +} + +function getChildCompatNode(compatNode, term) { + term = term.toLowerCase(); + + let child = null; + for (const field in compatNode) { + if (field.toLowerCase() === term) { + child = compatNode[field]; + break; + } + } + + if (!child) { + return null; + } + + if (child._aliasOf) { + // If the node is an alias, returns the node the alias points. + child = compatNode[child._aliasOf]; + } + + return child; +} + +module.exports = { + getCompatNode, + getCompatTable, +}; |