use readonly props to satisfy eslint rule

dotnize · Nov 24, 2024 · de1414e · de1414e
1 parent 8401223
commit de1414e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/app/components/DefaultCatchBoundary.tsx b/app/components/DefaultCatchBoundary.tsx
@@ -8,7 +8,7 @@ import {
 } from "@tanstack/react-router";
 import { Button } from "./ui/button";
 
-export function DefaultCatchBoundary({ error }: ErrorComponentProps) {
+export function DefaultCatchBoundary({ error }: Readonly<ErrorComponentProps>) {
   const router = useRouter();
   const isRoot = useMatch({
     strict: false,

diff --git a/app/components/ui/button.tsx b/app/components/ui/button.tsx
@@ -1,11 +1,11 @@
 import { Slot } from "@radix-ui/react-slot";
-import { type VariantProps, cva } from "class-variance-authority";
+import { cva, type VariantProps } from "class-variance-authority";
 import * as React from "react";
 
 import { cn } from "~/lib/utils";
 
 const buttonVariants = cva(
-  "inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50",
+  "inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0",
   {
     variants: {
       variant: {
@@ -37,7 +37,7 @@ export interface ButtonProps
   asChild?: boolean;
 }
 
-const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
+const Button = React.forwardRef<HTMLButtonElement, Readonly<ButtonProps>>(
   ({ className, variant, size, asChild = false, ...props }, ref) => {
     const Comp = asChild ? Slot : "button";
     return (

diff --git a/app/routes/__root.tsx b/app/routes/__root.tsx
@@ -57,7 +57,7 @@ function RootComponent() {
   );
 }
 
-function RootDocument({ children }: { children: React.ReactNode }) {
+function RootDocument({ children }: { readonly children: React.ReactNode }) {
   return (
     <html>
       <head>

diff --git a/eslint.config.js b/eslint.config.js
@@ -47,4 +47,10 @@ export default tseslint.config(
     },
     ...react.configs["recommended-type-checked"],
   },
+  {
+    rules: {
+      // You can override any rules here
+      // "@eslint-react/prefer-read-only-props": "off",
+    },
+  },
 );
-Original file line number
+Diff line change
@@ Expand Up / @@ -57,7 +57,7 @@ function RootComponent() { @@
       );
     }
-    function RootDocument({ children }: { children: React.ReactNode }) {
+    function RootDocument({ children }: { readonly children: React.ReactNode }) {
       return (
         <html>
           <head>
@@ Expand Down @@