Add jsx-dollar rule to react-x plugin

Author: Rel1cx

apps/website/content/docs/rules/meta.json

@@ -2,6 +2,7 @@
   "pages": [
     "overview",
     "---X Rules---",
+    "jsx-dollar",
     "jsx-key-before-spread",
     "jsx-no-comment-textnodes",
     "jsx-no-duplicate-props",

packages/plugins/eslint-plugin-react-x/src/rules/jsx-dollar.mdx

@@ -0,0 +1,108 @@
+---
+title: jsx-dollar
+---
+
+**Full Name in `@eslint-react/eslint-plugin`**
+
+```plain copy
+@eslint-react/jsx-dollar
+```
+
+**Full Name in `eslint-plugin-react-x`**
+
+```plain copy
+react-x/jsx-dollar
+```
+
+**Features**
+
+`🔧`
+
+## Description
+
+Prevents unnecessary dollar signs (`$`) from being inserted before an expression in JSX.
+
+This can happen when refactoring from a template literal to JSX and forgetting to remove the dollar sign. This results in an unintentional `$` being rendered in the output.
+
+```tsx
+import React from "react";
+
+function MyComponent({ user }) {
+  return `Hello ${user.name}`;
+}
+```
+
+When refactored to JSX, it might look like this:
+
+```tsx
+import React from "react";
+
+function MyComponent({ user }) {
+  return <>Hello ${user.name}</>;
+}
+```
+
+In this example, the `$` before `{user.name}` is unnecessary and will be rendered as part of the output.
+
+## Examples
+
+### Failing
+
+```tsx
+import React from "react";
+
+function MyComponent({ user }) {
+  return <div>Hello ${user.name}</div>;
+  //          ^^^^^^^^^^^^^^
+  //          - Possible unnecessary '$' character before expression.
+}
+```
+
+### Passing
+
+```tsx
+import React from "react";
+
+function MyComponent({ user }) {
+  return `Hello ${user.name}`;
+}
+```
+
+```tsx
+import React from "react";
+
+function MyComponent({ user }) {
+  return <div>Hello {user.name}</div>;
+}
+```
+
+```tsx
+import React from "react";
+
+function MyComponent({ price }) {
+  return <div>${price}</div>;
+}
+```
+
+### Legitimate uses
+
+If you legitimately need to output a dollar sign before an expression (for example, to display a price), you can wrap it in a template literal or use a string literal.
+
+```tsx
+import React from "react";
+
+function MyComponent({ price }) {
+  // 🟢 Good: This is a legitimate use of the '$' character.
+  return <div>{`$${price}`}</div>;
+}
+
+function AnotherComponent({ price }) {
+  // 🟢 Good: Another legitimate way to display a price.
+  return <div>${price}</div>;
+}
+```
+
+## Implementation
+
+- [Rule Source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/jsx-dollar.ts)
+- [Test Source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/jsx-dollar.spec.ts)

packages/plugins/eslint-plugin-react-x/src/rules/jsx-dollar.spec.ts

@@ -5,6 +5,24 @@ import rule, { RULE_NAME } from "./jsx-dollar";
 
 ruleTester.run(RULE_NAME, rule, {
   invalid: [
+    {
+      code: tsx`
+        const MyComponent = () => <>Hello \${user.name}</>
+      `,
+      errors: [
+        {
+          messageId: "jsxDollar",
+          suggestions: [
+            {
+              messageId: "removeDollarSign",
+              output: tsx`
+                const MyComponent = () => <>Hello {user.name}</>
+              `,
+            },
+          ],
+        },
+      ],
+    },
     {
       code: tsx`
         const App = (props) => {
@@ -30,6 +48,9 @@ ruleTester.run(RULE_NAME, rule, {
   ],
   valid: [
     ...allValid,
+    tsx`
+      const MyComponent = () => \`Hello \${user.name}\`
+    `,
     tsx`
       const App = (props) => {
           return [<div key="1">1</div>]
@@ -40,5 +61,25 @@ ruleTester.run(RULE_NAME, rule, {
           return <div>Hello $</div>;
       };
     `,
+    tsx`
+      const App = (props) => {
+          return <div>Hello {props.name}</div>;
+      };
+    `,
+    tsx`
+      import React from "react";
+
+      function MyComponent({ price }) {
+        // 🟢 Good: This is a legitimate use of the '$' character.
+        return <div>{\`$\${price}\`}</div>;
+      }
+    `,
+    tsx`
+      import React from "react";
+      function AnotherComponent({ price }) {
+        // 🟢 Good: Another legitimate way to display a price.
+        return <div>\${price}</div>;
+      }
+    `,
   ],
 });

packages/plugins/eslint-plugin-react-x/src/rules/jsx-dollar.ts

@@ -1,4 +1,3 @@
-import * as AST from "@eslint-react/ast";
 import type { RuleContext, RuleFeature } from "@eslint-react/shared";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
@@ -11,7 +10,9 @@ export const RULE_NAME = "jsx-dollar";
 
 export const RULE_FEATURES = [] as const satisfies RuleFeature[];
 
-export type MessageID = CamelCase<typeof RULE_NAME> | "removeDollarSign";
+export type MessageID = CamelCase<typeof RULE_NAME> | RuleSuggestMessageID;
+
+export type RuleSuggestMessageID = "removeDollarSign";
 
 export default createRule<[], MessageID>({
   meta: {
@@ -23,8 +24,7 @@ export default createRule<[], MessageID>({
     fixable: "code",
     hasSuggestions: true,
     messages: {
-      jsxDollar:
-        "Possible misused dollar sign in text node. If you want to explicitly display '$' character i.e. show price, you can use template literals.",
+      jsxDollar: "Possible unnecessary '$' character before expression.",
       removeDollarSign: "Remove the dollar sign '$' before the expression.",
     },
     schema: [],
@@ -35,10 +35,14 @@ export default createRule<[], MessageID>({
 });
 
 export function create(context: RuleContext<MessageID, []>): RuleListener {
+  /**
+   * Visitor function for JSXElement and JSXFragment nodes
+   * @param node The JSXElement or JSXFragment node to be checked
+   */
   const visitorFunction = (node: TSESTree.JSXElement | TSESTree.JSXFragment) => {
     for (const [index, child] of node.children.entries()) {
-      if (child.type !== T.JSXText) continue;
-      if (!child.raw.endsWith("$")) continue;
+      if (child.type !== T.JSXText || child.raw === "$" || !child.raw.endsWith("$")) continue;
+      // Ensure the next sibling is a JSXExpressionContainer
       if (node.children[index + 1]?.type !== T.JSXExpressionContainer) continue;
       context.report({
         messageId: "jsxDollar",

packages/plugins/eslint-plugin/README.md

@@ -186,8 +186,8 @@ ESLint React is not affiliated with Meta Corporation or [facebook/react](https:/
 
 Contributions are welcome!
 
-Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/main/.github/CONTRIBUTING.md).
+Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/jsx-dollar/.github/CONTRIBUTING.md).
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/main/LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/jsx-dollar/LICENSE) file for details.