summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/lib/rules/no-restricted-globals.js
diff options
context:
space:
mode:
authorMichaël Zasso <targos@protonmail.com>2017-12-22 16:53:42 +0100
committerMichaël Zasso <targos@protonmail.com>2018-01-11 09:48:05 +0100
commit3dc30632755713179f345f4af024bd904c6162d0 (patch)
treef28c4f6dd6dfc5992edf301449d1a371d229755b /tools/node_modules/eslint/lib/rules/no-restricted-globals.js
parenta2c7085dd4a8e60d1a47572aca8bb6fcb7a32f88 (diff)
downloadandroid-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.gz
android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.bz2
android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.zip
tools: move eslint from tools to tools/node_modules
This is required because we need to add the babel-eslint dependency and it has to be able to resolve "eslint". babel-eslint is required to support future ES features such as async iterators and import.meta. Refs: https://github.com/nodejs/node/pull/17755 PR-URL: https://github.com/nodejs/node/pull/17820 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'tools/node_modules/eslint/lib/rules/no-restricted-globals.js')
-rw-r--r--tools/node_modules/eslint/lib/rules/no-restricted-globals.js120
1 files changed, 120 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/lib/rules/no-restricted-globals.js b/tools/node_modules/eslint/lib/rules/no-restricted-globals.js
new file mode 100644
index 0000000000..75428fc174
--- /dev/null
+++ b/tools/node_modules/eslint/lib/rules/no-restricted-globals.js
@@ -0,0 +1,120 @@
+/**
+ * @fileoverview Restrict usage of specified globals.
+ * @author Benoît Zugmeyer
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+const DEFAULT_MESSAGE_TEMPLATE = "Unexpected use of '{{name}}'.",
+ CUSTOM_MESSAGE_TEMPLATE = "Unexpected use of '{{name}}'. {{customMessage}}";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+ meta: {
+ docs: {
+ description: "disallow specified global variables",
+ category: "Variables",
+ recommended: false
+ },
+
+ schema: {
+ type: "array",
+ items: {
+ oneOf: [
+ {
+ type: "string"
+ },
+ {
+ type: "object",
+ properties: {
+ name: { type: "string" },
+ message: { type: "string" }
+ },
+ required: ["name"],
+ additionalProperties: false
+ }
+ ]
+ },
+ uniqueItems: true,
+ minItems: 0
+ }
+ },
+
+ create(context) {
+
+ // If no globals are restricted, we don't need to do anything
+ if (context.options.length === 0) {
+ return {};
+ }
+
+ const restrictedGlobalMessages = context.options.reduce((memo, option) => {
+ if (typeof option === "string") {
+ memo[option] = null;
+ } else {
+ memo[option.name] = option.message;
+ }
+
+ return memo;
+ }, {});
+
+ /**
+ * Report a variable to be used as a restricted global.
+ * @param {Reference} reference the variable reference
+ * @returns {void}
+ * @private
+ */
+ function reportReference(reference) {
+ const name = reference.identifier.name,
+ customMessage = restrictedGlobalMessages[name],
+ message = customMessage
+ ? CUSTOM_MESSAGE_TEMPLATE
+ : DEFAULT_MESSAGE_TEMPLATE;
+
+ context.report({
+ node: reference.identifier,
+ message,
+ data: {
+ name,
+ customMessage
+ }
+ });
+ }
+
+ /**
+ * Check if the given name is a restricted global name.
+ * @param {string} name name of a variable
+ * @returns {boolean} whether the variable is a restricted global or not
+ * @private
+ */
+ function isRestricted(name) {
+ return restrictedGlobalMessages.hasOwnProperty(name);
+ }
+
+ return {
+ Program() {
+ const scope = context.getScope();
+
+ // Report variables declared elsewhere (ex: variables defined as "global" by eslint)
+ scope.variables.forEach(variable => {
+ if (!variable.defs.length && isRestricted(variable.name)) {
+ variable.references.forEach(reportReference);
+ }
+ });
+
+ // Report variables not declared at all
+ scope.through.forEach(reference => {
+ if (isRestricted(reference.identifier.name)) {
+ reportReference(reference);
+ }
+ });
+
+ }
+ };
+ }
+};