templatise agents md (#391)

Author: technophile-04

.changeset/silly-carrots-hide.md

@@ -0,0 +1,5 @@
+---
+"create-eth": patch
+---
+
+templatise AGENTS.md file

contributors/TEMPLATE-FILES.md

@@ -49,6 +49,7 @@ If you're interested in developing third-party extensions, the [THIRD-PARTY-EXTE
 | Template                                                                                                                             | Example args file                                                                                                         |
 | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
 | [(doc) `README.md.template.mjs`](https://github.com/scaffold-eth/create-eth/blob/main/templates/base/README.md.template.mjs)         | [`README.md.args.mjs`](https://github.com/scaffold-eth/create-eth-extensions/blob/example/extension/README.md.args.mjs)   |
+| [(doc) `AGENTS.md.template.mjs`](https://github.com/scaffold-eth/create-eth/blob/main/templates/base/AGENTS.md.template.mjs)         | [`AGENTS.md.args.mjs`](https://github.com/scaffold-eth/create-eth-extensions/blob/example/extension/AGENTS.md.args.mjs)   |
 | [(gitignore) `.gitignore.template.mjs`](https://github.com/scaffold-eth/create-eth/blob/main/templates/base/.gitignore.template.mjs) | [`.gitignore.args.mjs`](https://github.com/scaffold-eth/create-eth-extensions/blob/example/extension/.gitignore.args.mjs) |
 
 ### create-eth internal use

templates/base/AGENTS.md templates/base/AGENTS.md.template.mjstemplates/base/AGENTS.md renamed to templates/base/AGENTS.md.template.mjs

@@ -1,13 +1,25 @@
-# AGENTS.md
+import { withDefaults } from "../utils.js";
+
+const contents = ({
+  extraProjectOverview,
+  extraSections,
+  fullContentOverride,
+}) => {
+
+  if (fullContentOverride[0]) {
+    return fullContentOverride[0];
+  }
+
+  return `# AGENTS.md
 
 This file provides guidance to coding agents working in this repository.
 
 ## Project Overview
 
 Scaffold-ETH 2 (SE-2) is a starter kit for building dApps on Ethereum. It comes in **two flavors** based on the Solidity framework:
 
-- **Hardhat flavor**: Uses `packages/hardhat` with hardhat-deploy plugin
-- **Foundry flavor**: Uses `packages/foundry` with Forge scripts
+- **Hardhat flavor**: Uses \`packages/hardhat\` with hardhat-deploy plugin
+- **Foundry flavor**: Uses \`packages/foundry\` with Forge scripts
 
 Both flavors share the same frontend package:
 
@@ -17,14 +29,14 @@ Both flavors share the same frontend package:
 
 Check which package exists in the repository:
 
-- If `packages/hardhat` exists → **Hardhat flavor** (follow Hardhat instructions)
-- If `packages/foundry` exists → **Foundry flavor** (follow Foundry instructions)
-
+- If \`packages/hardhat\` exists → **Hardhat flavor** (follow Hardhat instructions)
+- If \`packages/foundry\` exists → **Foundry flavor** (follow Foundry instructions)
+${extraProjectOverview.filter(Boolean).join("\n")}
 ## Common Commands
 
 Commands work the same for both flavors unless noted otherwise:
 
-```bash
+\`\`\`bash
 # Development workflow (run each in separate terminal)
 yarn chain          # Start local blockchain (Hardhat or Anvil)
 yarn deploy         # Deploy contracts to local network
@@ -50,65 +62,65 @@ yarn account             # View current account info
 yarn deploy --network <network>   # e.g., sepolia, mainnet, base
 
 yarn vercel:yolo --prod # for deployment of frontend
-```
+\`\`\`
 
 ## Architecture
 
 ### Smart Contract Development
 
 #### Hardhat Flavor
 
-- Contracts: `packages/hardhat/contracts/`
-- Deployment scripts: `packages/hardhat/deploy/` (uses hardhat-deploy plugin)
-- Tests: `packages/hardhat/test/`
-- Config: `packages/hardhat/hardhat.config.ts`
+- Contracts: \`packages/hardhat/contracts/\`
+- Deployment scripts: \`packages/hardhat/deploy/\` (uses hardhat-deploy plugin)
+- Tests: \`packages/hardhat/test/\`
+- Config: \`packages/hardhat/hardhat.config.ts\`
 - Deploying specific contract:
   - If the deploy script has:
-    ```typescript
+    \`\`\`typescript
     // In packages/hardhat/deploy/01_deploy_my_contract.ts
     deployMyContract.tags = ["MyContract"];
-    ```
-  - `yarn deploy --tags MyContract`
+    \`\`\`
+  - \`yarn deploy --tags MyContract\`
 
 #### Foundry Flavor
 
-- Contracts: `packages/foundry/contracts/`
-- Deployment scripts: `packages/foundry/script/` (uses custom deployment strategy)
-  - Example: `packages/foundry/script/Deploy.s.sol` and `packages/foundry/script/DeployYourContract.s.sol`
-- Tests: `packages/foundry/test/`
-- Config: `packages/foundry/foundry.toml`
+- Contracts: \`packages/foundry/contracts/\`
+- Deployment scripts: \`packages/foundry/script/\` (uses custom deployment strategy)
+  - Example: \`packages/foundry/script/Deploy.s.sol\` and \`packages/foundry/script/DeployYourContract.s.sol\`
+- Tests: \`packages/foundry/test/\`
+- Config: \`packages/foundry/foundry.toml\`
 - Deploying a specific contract:
-  - Create a separate deployment script and run `yarn deploy --file DeployYourContract.s.sol`
+  - Create a separate deployment script and run \`yarn deploy --file DeployYourContract.s.sol\`
 
 #### Both Flavors
 
-- After `yarn deploy`, ABIs are auto-generated to `packages/nextjs/contracts/deployedContracts.ts`
+- After \`yarn deploy\`, ABIs are auto-generated to \`packages/nextjs/contracts/deployedContracts.ts\`
 
 ### Frontend Contract Interaction
 
 **Correct interact hook names (use these):**
 
-- `useScaffoldReadContract` - NOT ~~useScaffoldContractRead~~
-- `useScaffoldWriteContract` - NOT ~~useScaffoldContractWrite~~
+- \`useScaffoldReadContract\` - NOT ~~useScaffoldContractRead~~
+- \`useScaffoldWriteContract\` - NOT ~~useScaffoldContractWrite~~
 
-Contract data is read from two files in `packages/nextjs/contracts/`:
+Contract data is read from two files in \`packages/nextjs/contracts/\`:
 
-- `deployedContracts.ts`: Auto-generated from deployments
-- `externalContracts.ts`: Manually added external contracts
+- \`deployedContracts.ts\`: Auto-generated from deployments
+- \`externalContracts.ts\`: Manually added external contracts
 
 #### Reading Contract Data
 
-```typescript
+\`\`\`typescript
 const { data: totalCounter } = useScaffoldReadContract({
   contractName: "YourContract",
   functionName: "userGreetingCounter",
   args: ["0xd8da6bf26964af9d7eed9e03e53415d37aa96045"],
 });
-```
+\`\`\`
 
 #### Writing to Contracts
 
-```typescript
+\`\`\`typescript
 const { writeContractAsync, isPending } = useScaffoldWriteContract({
   contractName: "YourContract",
 });
@@ -118,102 +130,102 @@ await writeContractAsync({
   args: [newGreeting],
   value: parseEther("0.01"), // for payable functions
 });
-```
+\`\`\`
 
 #### Reading Events
 
-```typescript
+\`\`\`typescript
 const { data: events, isLoading } = useScaffoldEventHistory({
   contractName: "YourContract",
   eventName: "GreetingChange",
   watch: true,
   fromBlock: 31231n,
   blockData: true,
 });
-```
+\`\`\`
 
-SE-2 also provides other hooks to interact with blockchain data: `useScaffoldWatchContractEvent`, `useScaffoldEventHistory`, `useDeployedContractInfo`, `useScaffoldContract`, `useTransactor`.
+SE-2 also provides other hooks to interact with blockchain data: \`useScaffoldWatchContractEvent\`, \`useScaffoldEventHistory\`, \`useDeployedContractInfo\`, \`useScaffoldContract\`, \`useTransactor\`.
 
-**IMPORTANT: Always use hooks from `packages/nextjs/hooks/scaffold-eth` for contract interactions. Always refer to the hook names as they exist in the codebase.**
+**IMPORTANT: Always use hooks from \`packages/nextjs/hooks/scaffold-eth\` for contract interactions. Always refer to the hook names as they exist in the codebase.**
 
 ### UI Components
 
-**Always use `@scaffold-ui/components` library for web3 UI components:**
+**Always use \`@scaffold-ui/components\` library for web3 UI components:**
 
-- `Address`: Display ETH addresses with ENS resolution, blockie avatars, and explorer links
-- `AddressInput`: Input field with address validation and ENS resolution
-- `Balance`: Show ETH balance in ether and USD
-- `EtherInput`: Number input with ETH/USD conversion toggle
-- `IntegerInput`: Integer-only input with wei conversion
+- \`Address\`: Display ETH addresses with ENS resolution, blockie avatars, and explorer links
+- \`AddressInput\`: Input field with address validation and ENS resolution
+- \`Balance\`: Show ETH balance in ether and USD
+- \`EtherInput\`: Number input with ETH/USD conversion toggle
+- \`IntegerInput\`: Integer-only input with wei conversion
 
 ### Styling
 
 **Use DaisyUI classes** for building frontend components.
 
-```tsx
+\`\`\`tsx
 // ✅ Good - using DaisyUI classes
 <button className="btn btn-primary">Connect</button>
 <div className="card bg-base-100 shadow-xl">...</div>
 
 // ❌ Avoid - raw Tailwind when DaisyUI has a component
 <button className="px-4 py-2 bg-blue-500 text-white rounded">Connect</button>
-```
+\`\`\`
 
 ### Configure Target Network before deploying to testnet / mainnet.
 
 #### Hardhat
 
-Add networks in `packages/hardhat/hardhat.config.ts` if not present.
+Add networks in \`packages/hardhat/hardhat.config.ts\` if not present.
 
 #### Foundry
 
-Add RPC endpoints in `packages/foundry/foundry.toml` if not present.
+Add RPC endpoints in \`packages/foundry/foundry.toml\` if not present.
 
 #### NextJs
 
-Add networks in `packages/nextjs/scaffold.config.ts` if not present. This file also contains configuration for polling interval, API keys. Remember to decrease the polling interval for L2 chains.
+Add networks in \`packages/nextjs/scaffold.config.ts\` if not present. This file also contains configuration for polling interval, API keys. Remember to decrease the polling interval for L2 chains.
 
 ## Code Style Guide
 
 ### Identifiers
 
 | Style            | Category                                                                                                               |
 | ---------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `UpperCamelCase` | class / interface / type / enum / decorator / type parameters / component functions in TSX / JSXElement type parameter |
-| `lowerCamelCase` | variable / parameter / function / property / module alias                                                              |
-| `CONSTANT_CASE`  | constant / enum / global variables                                                                                     |
-| `snake_case`     | for hardhat deploy files and foundry script files                                                                      |
+| \`UpperCamelCase\` | class / interface / type / enum / decorator / type parameters / component functions in TSX / JSXElement type parameter |
+| \`lowerCamelCase\` | variable / parameter / function / property / module alias                                                              |
+| \`CONSTANT_CASE\`  | constant / enum / global variables                                                                                     |
+| \`snake_case\`     | for hardhat deploy files and foundry script files                                                                      |
 
 ### Import Paths
 
-Use the `~~` path alias for imports in the nextjs package:
+Use the \`~~\` path alias for imports in the nextjs package:
 
-```tsx
+\`\`\`tsx
 import { useTargetNetwork } from "~~/hooks/scaffold-eth";
-```
+\`\`\`
 
 ### Creating Pages
 
-```tsx
+\`\`\`tsx
 import type { NextPage } from "next";
 
 const Home: NextPage = () => {
   return <div>Home</div>;
 };
 
 export default Home;
-```
+\`\`\`
 
 ### TypeScript Conventions
 
-- Use `type` over `interface` for custom types
-- Types use `UpperCamelCase` without `T` prefix (use `Address` not `TAddress`)
+- Use \`type\` over \`interface\` for custom types
+- Types use \`UpperCamelCase\` without \`T\` prefix (use \`Address\` not \`TAddress\`)
 - Avoid explicit typing when TypeScript can infer the type
 
 ### Comments
 
 Make comments that add information. Avoid redundant JSDoc for simple functions.
-
+${extraSections.filter(Boolean).join("\n")}
 ## Documentation
 
 Use **Context7 MCP** tools to fetch up-to-date documentation for any library (Wagmi, Viem, RainbowKit, DaisyUI, Hardhat, Next.js, etc.). Context7 is configured as an MCP server and provides access to indexed documentation with code examples.
@@ -222,4 +234,12 @@ Use **Context7 MCP** tools to fetch up-to-date documentation for any library (Wa
 
 Use these specialized agents for specific tasks:
 
-- **`grumpy-carlos-code-reviewer`**: Use this agent for code reviews before finalizing changes
+- **\`grumpy-carlos-code-reviewer\`**: Use this agent for code reviews before finalizing changes
+`;
+};
+
+export default withDefaults(contents, {
+  extraProjectOverview: "",
+  extraSections: "",
+  fullContentOverride: "",
+});