precommit hook builds README on hooks documentation changes

Author: YashTotale

CHANGELOG.md

@@ -7,7 +7,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 **Table of Contents**
 
 - [[Unreleased]](#unreleased)
-- [[v1.4.0] - (2020-12-02)](#v140---2020-12-02)
+- [[v1.4.0] - (2020-12-03)](#v140---2020-12-03)
 - [[v1.3.2] - (2020-12-02)](#v132---2020-12-02)
   - [Added](#added)
 - [[v1.3.1] - (2020-11-30)](#v131---2020-11-30)
@@ -38,7 +38,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 
 ---
 
-## [v1.4.0] - (2020-12-02)
+## [v1.4.0] - (2020-12-03)
 
 ---
 

README.md

@@ -39,6 +39,12 @@ _Table Of Contents_
     - [Demo](#demo-2)
     - [Props](#props-2)
     - [Example](#example-2)
+- [Hooks](#hooks)
+  - [useHashScroll](#usehashscroll)
+    - [Summary](#summary-3)
+    - [Demo](#demo-3)
+    - [Params](#params)
+    - [Example](#example-3)
 - [Contributing](#contributing)
 - [More Info (Badges)](#more-info-badges)
 
@@ -333,6 +339,22 @@ const App = () => {
 
 ---
 
+## Hooks
+
+### useHashScroll
+
+#### Summary
+
+Creates a ref that scrolls to its assigned element when a specified hash is present in the url
+
+#### Demo
+
+#### Params
+
+#### Example
+
+---
+
 ## Contributing
 
 - Go to the [github repository](https://github.com/YashTotale/react-hash-scroll)

docs/Hooks/useHashScroll.md

@@ -0,0 +1,11 @@
+### useHashScroll
+
+#### Summary
+
+Creates a ref that scrolls to its assigned element when a specified hash is present in the url
+
+#### Demo
+
+#### Params
+
+#### Example

scripts/precommit.ts

@@ -156,35 +156,43 @@ const checkReadme = async () => {
 
     const docsDir = join(ROOT_DIR, "docs");
 
-    const componentsPath = "docs/Components/";
+    const docsPath = "docs/";
 
-    if (staged.includes(componentsPath)) {
-      const componentsDir = join(docsDir, "Components");
+    if (staged.includes(docsPath)) {
+      const createReadme = async (name: string) => {
+        const path = docsPath + name + "/";
 
-      const files = await readDir(join(componentsDir));
+        if (staged.includes(path)) {
+          const dir = join(docsDir, name);
 
-      for (const file of files) {
-        if (staged.includes(`${componentsPath}${file}`)) {
-          const readme = await getReadme();
+          const files = await readDir(dir);
 
-          const titleIndex = readme.indexOf(`### ${parse(file).name}`);
+          for (const file of files) {
+            if (staged.includes(`${path}${file}`)) {
+              const readme = await getReadme();
 
-          const endIndex = readme.indexOf("---", titleIndex);
+              const titleIndex = readme.indexOf(`### ${parse(file).name}`);
 
-          const fileContents = await readFile(
-            join(componentsDir, file),
-            "utf-8"
-          );
+              const endIndex = readme.indexOf("---", titleIndex);
 
-          const newReadme =
-            readme.substring(0, titleIndex) +
-            fileContents +
-            "\n" +
-            readme.substring(endIndex);
+              const fileContents = await readFile(join(dir, file), "utf-8");
 
-          await writeFile(readmeDest, newReadme);
+              const newReadme =
+                readme.substring(0, titleIndex) +
+                fileContents +
+                "\n" +
+                readme.substring(endIndex);
+
+              await writeFile(readmeDest, newReadme);
+            }
+          }
         }
-      }
+      };
+
+      await createReadme("Components");
+
+      await createReadme("Hooks");
+
       await gitAdd(readmeDest);
     }