2020-08-25 23:57:08 +00:00
|
|
|
/**
|
|
|
|
* @author Toru Nagashima <https://github.com/mysticatea>
|
|
|
|
* See LICENSE file in root directory for full license.
|
|
|
|
*/
|
2022-11-10 10:43:16 +00:00
|
|
|
import KEYS from "./visitor-keys.js";
|
2020-08-25 23:57:08 +00:00
|
|
|
|
2022-11-10 10:43:16 +00:00
|
|
|
/**
|
|
|
|
* @typedef {{ readonly [type: string]: ReadonlyArray<string> }} VisitorKeys
|
|
|
|
*/
|
2020-08-25 23:57:08 +00:00
|
|
|
|
|
|
|
// List to ignore keys.
|
|
|
|
const KEY_BLACKLIST = new Set([
|
|
|
|
"parent",
|
|
|
|
"leadingComments",
|
|
|
|
"trailingComments"
|
|
|
|
]);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check whether a given key should be used or not.
|
|
|
|
* @param {string} key The key to check.
|
|
|
|
* @returns {boolean} `true` if the key should be used.
|
|
|
|
*/
|
|
|
|
function filterKey(key) {
|
|
|
|
return !KEY_BLACKLIST.has(key) && key[0] !== "_";
|
|
|
|
}
|
|
|
|
|
2022-11-10 10:43:16 +00:00
|
|
|
/**
|
|
|
|
* Get visitor keys of a given node.
|
|
|
|
* @param {object} node The AST node to get keys.
|
|
|
|
* @returns {readonly string[]} Visitor keys of the node.
|
|
|
|
*/
|
|
|
|
export function getKeys(node) {
|
|
|
|
return Object.keys(node).filter(filterKey);
|
|
|
|
}
|
2020-08-25 23:57:08 +00:00
|
|
|
|
2022-11-10 10:43:16 +00:00
|
|
|
// Disable valid-jsdoc rule because it reports syntax error on the type of @returns.
|
|
|
|
// eslint-disable-next-line valid-jsdoc
|
|
|
|
/**
|
|
|
|
* Make the union set with `KEYS` and given keys.
|
|
|
|
* @param {VisitorKeys} additionalKeys The additional keys.
|
|
|
|
* @returns {VisitorKeys} The union set.
|
|
|
|
*/
|
|
|
|
export function unionWith(additionalKeys) {
|
|
|
|
const retv = /** @type {{
|
|
|
|
[type: string]: ReadonlyArray<string>
|
|
|
|
}} */ (Object.assign({}, KEYS));
|
2020-08-25 23:57:08 +00:00
|
|
|
|
2022-11-10 10:43:16 +00:00
|
|
|
for (const type of Object.keys(additionalKeys)) {
|
|
|
|
if (Object.prototype.hasOwnProperty.call(retv, type)) {
|
|
|
|
const keys = new Set(additionalKeys[type]);
|
2020-08-25 23:57:08 +00:00
|
|
|
|
2022-11-10 10:43:16 +00:00
|
|
|
for (const key of retv[type]) {
|
|
|
|
keys.add(key);
|
2020-08-25 23:57:08 +00:00
|
|
|
}
|
|
|
|
|
2022-11-10 10:43:16 +00:00
|
|
|
retv[type] = Object.freeze(Array.from(keys));
|
|
|
|
} else {
|
|
|
|
retv[type] = Object.freeze(Array.from(additionalKeys[type]));
|
|
|
|
}
|
2020-08-25 23:57:08 +00:00
|
|
|
}
|
2022-11-10 10:43:16 +00:00
|
|
|
|
|
|
|
return Object.freeze(retv);
|
|
|
|
}
|
|
|
|
|
|
|
|
export { KEYS };
|