fix readme and build warning

Author: bluebill1049

.gitignore

@@ -4,6 +4,7 @@
 .DS_Store
 .AppleDouble
 .LSOverride
+.idea
 
 # Icon must end with two \r
 Icon
@@ -192,4 +193,4 @@ dist
 .tern-port
 
 # Stores VSCode versions used for testing VSCode extensions
-.vscode-test
+.vscode-test

README.md

@@ -30,13 +30,11 @@ import { useForm } from "react-hook-form";
 import { TextField, Checkbox } from "@material-ui/core";
 
 type FormValues = {
-  uncontrolled: string;
-  controlled: string;
+  flatType: string;
   nested: {
-    uncontrolled: { test: string };
-    controlled: { test: boolean }[];
+    objectType: { test: string };
+    arrayType: { test: boolean }[];
   };
-  error: string;
 };
 
 export default function App() {
@@ -47,51 +45,46 @@ export default function App() {
 
   return (
     <form onSubmit={onSubmit}>
-      {/* Uncontrolled Component */}
       <TypedController
-        as="textarea"
-        name={["nested", "uncontrolled", "test"]}
+        name="flat"
         defaultValue=""
-        rules={{ required: true }}
+        render={(props) => <TextField {...props} />}
       />
-      
-      {/* Controlled Component */}
+
       <TypedController
-        name="controlled"
+        as="textarea"
+        name={["nested", "objectType", "test"]}
         defaultValue=""
-        render={(props) => <TextField {...props} />}
+        rules={{ required: true }}
       />
-      
+
       <TypedController
-        name={["nested", "controlled", 0, "test"]}
+        name={["nested", "arrayType", 0, "test"]}
         defaultValue={false}
-        rules={{
-          validate: (value) => value, // (parameter) value: boolean
-        }}
         render={(props) => <Checkbox {...props} />}
       />
-      
+
       {/* ❌: Type '"notExists"' is not assignable to type 'DeepPath<FormValues, "notExists">'. */}
       <TypedController
         as="input"
-        name="notExists" 
+        name="notExists"
         defaultValue=""
       />
-      
-      {/* ❌: Type '(string | number)[]' is not assignable to type 'DeepPath<FormValues, ["nested", "controlled", 0, "notExists"]>'. */}
+
+      {/* ❌: Type '(string | number)[]' is not assignable to type 'DeepPath<FormValues, ["nested", "objectType", 0, "notExists"]>'. */}
       <TypedController
         as="input"
-        name={["nested", "controlled", 0, "notExists"]}
+        name={["nested", "objectType", 0, "notExists"]}
         defaultValue=""
       />
-      
+
       {/* ❌: Type 'true' is not assignable to type 'string | undefined'. */}
       <TypedController
         as="input"
-        name="error"
+        name="flatType"
         defaultValue={true}
       />
-      
+
       <input type="submit" />
     </form>
   );

package.json

@@ -90,8 +90,7 @@
       "npm run lint:fix"
     ],
     "*.{md,json}": [
-      "prettier --write",
-      "git add"
+      "prettier --write"
     ]
   }
 }