Initial commit

frontend/webapp/node_modules/eslint-plugin-react/lib/rules/no-string-refs.js

@@ -0,0 +1,117 @@
+/**
+ * @fileoverview Prevent string definitions for references and prevent referencing this.refs
+ * @author Tom Hastjarjanto
+ */
+
+'use strict';
+
+const componentUtil = require('../util/componentUtil');
+const docsUrl = require('../util/docsUrl');
+const report = require('../util/report');
+const testReactVersion = require('../util/version').testReactVersion;
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+const messages = {
+  thisRefsDeprecated: 'Using this.refs is deprecated.',
+  stringInRefDeprecated: 'Using string literals in ref attributes is deprecated.',
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    docs: {
+      description: 'Disallow using string references',
+      category: 'Best Practices',
+      recommended: true,
+      url: docsUrl('no-string-refs'),
+    },
+
+    messages,
+
+    schema: [{
+      type: 'object',
+      properties: {
+        noTemplateLiterals: {
+          type: 'boolean',
+        },
+      },
+      additionalProperties: false,
+    }],
+  },
+
+  create(context) {
+    const checkRefsUsage = testReactVersion(context, '< 18.3.0'); // `this.refs` is writable in React 18.3.0 and later, see https://github.com/facebook/react/pull/28867
+    const detectTemplateLiterals = context.options[0] ? context.options[0].noTemplateLiterals : false;
+    /**
+     * Checks if we are using refs
+     * @param {ASTNode} node The AST node being checked.
+     * @returns {boolean} True if we are using refs, false if not.
+     */
+    function isRefsUsage(node) {
+      return !!(
+        (componentUtil.getParentES6Component(context, node) || componentUtil.getParentES5Component(context, node))
+        && node.object.type === 'ThisExpression'
+        && node.property.name === 'refs'
+      );
+    }
+
+    /**
+     * Checks if we are using a ref attribute
+     * @param {ASTNode} node The AST node being checked.
+     * @returns {boolean} True if we are using a ref attribute, false if not.
+     */
+    function isRefAttribute(node) {
+      return node.type === 'JSXAttribute'
+        && !!node.name
+        && node.name.name === 'ref';
+    }
+
+    /**
+     * Checks if a node contains a string value
+     * @param {ASTNode} node The AST node being checked.
+     * @returns {boolean} True if the node contains a string value, false if not.
+     */
+    function containsStringLiteral(node) {
+      return !!node.value
+        && node.value.type === 'Literal'
+        && typeof node.value.value === 'string';
+    }
+
+    /**
+     * Checks if a node contains a string value within a jsx expression
+     * @param {ASTNode} node The AST node being checked.
+     * @returns {boolean} True if the node contains a string value within a jsx expression, false if not.
+     */
+    function containsStringExpressionContainer(node) {
+      return !!node.value
+        && node.value.type === 'JSXExpressionContainer'
+        && node.value.expression
+        && ((node.value.expression.type === 'Literal' && typeof node.value.expression.value === 'string')
+        || (node.value.expression.type === 'TemplateLiteral' && detectTemplateLiterals));
+    }
+
+    return {
+      MemberExpression(node) {
+        if (checkRefsUsage && isRefsUsage(node)) {
+          report(context, messages.thisRefsDeprecated, 'thisRefsDeprecated', {
+            node,
+          });
+        }
+      },
+
+      JSXAttribute(node) {
+        if (
+          isRefAttribute(node)
+          && (containsStringLiteral(node) || containsStringExpressionContainer(node))
+        ) {
+          report(context, messages.stringInRefDeprecated, 'stringInRefDeprecated', {
+            node,
+          });
+        }
+      },
+    };
+  },
+};