feat: add React Component Generator Guide with usage instructions and prompts explanation

Author: mayank1513

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-      - run: npm i -g pnpm && pnpm i
+      - run: npm i -g pnpm && pnpm i --no-frozen-lockfile
         name: Install dependencies
       - name: Run unit tests
         run: pnpm test

README.md

@@ -72,7 +72,32 @@ Compared to the default scaffold from create-turbo, this template offers:
 - GitHub actions/workflows to auto-publish your package when the version changes
 - GitHub action/workflow + pre-install scripts to automatically rebrand your repo on creation
 
-### 🤩 Don't forget to star [this repository](https://github.com/react18-tools/turborepo-template)!
+## 🧱 Generate New Components
+
+This project uses [`plop`](https://plopjs.com/) to scaffold reusable React components under the `lib` or `packages/shared` directory.
+
+To generate a new component, run:
+
+```bash
+pnpm plop
+```
+
+You’ll be prompted to choose:
+
+- The **target package** (`lib` or `packages/shared`)
+- The **component name** (e.g., `Card`, or nested like `forms/Input`)
+- Whether it’s a **client component** (adds `"use client"` directive)
+- Whether to include a **`.module.scss` file**
+- Whether to generate a **test stub**
+- An optional **description** (used as JSDoc)
+
+🧠 The generator:
+
+- Creates a folder with `.tsx`, optional `.module.scss`, and `.test.tsx`
+- Updates `index.ts` files recursively
+- Adds `exports` to `package.json` automatically
+
+## 🤩 Don't forget to star [this repository](https://github.com/react18-tools/turborepo-template)!
 
 Looking for a hands-on course to get started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React, and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescript/?referralCode=851A28F10B254A8523FE)
 

component-generator.md

@@ -0,0 +1,36 @@
+# 🧱 React Component Generator Guide
+
+This generator helps you scaffold components consistently.
+
+### Usage
+
+```bash
+pnpm plop rc
+```
+
+### Prompts Explained
+
+| Prompt                | Description                                     |
+| --------------------- | ----------------------------------------------- |
+| Package Path          | Target package to add the component to          |
+| Component Name        | Supports nested paths like `form/InputText`     |
+| Is Client Component   | Adds `"use client"` directive                   |
+| Create .module.scss   | Adds a scoped SCSS module                       |
+| Create Unit Test File | Adds a Jest + React Testing Library stub        |
+| Description           | Added to the top of the component file as JSDoc |
+
+### Example Output
+
+For a component named `form/InputText`, files generated:
+
+```
+lib/src/client/form/input-text/
+  ├── input-text.tsx
+  ├── input-text.module.scss
+  ├── input-text.test.tsx
+  └── index.ts             <-- export file
+```
+
+Nested `index.ts` files are created as needed, and exports are appended.
+
+The generator also modifies your `package.json` to expose these components.