fix: throw when to many arguments are passed (bgd-labs#203)

* fix: throw when to many arguments are passed (errors when quotes on strings are missing)

* fix: emit correct md

* docs: adjust docs

* docs: improve docs

* fix: use underscore consistently

CONTRIBUTING.md

@@ -4,20 +4,22 @@
 
 Your proposal should follow the following naming Convention:
 
-- `src/Aave[V2|V3][Topic]_[YYYY][MM][DD]/Aave[V2|V3][Topic]_[YYYY][MM][DD].s.sol`
-- `src/Aave[V2|V3][Topic]_[YYYY][MM][DD]/Aave[V2|V3][Network][Topic]_[YYYY][MM][DD].sol`
-- `src/Aave[V2|V3][Topic]_[YYYY][MM][DD]/Aave[V2|V3][Network|Multi][Topic]_[YYYY][MM][DD]_Test.t.sol`
+- `src/Aave[V2|V3]_[Network|Multi]_[Topic]_[YYYY][MM][DD]/Aave[V2|V3]_[Topic]_[YYYY][MM][DD].s.sol`
+- `src/Aave[V2|V3]_[Network|Multi]_[Topic]_[YYYY][MM][DD]/Aave[V2|V3]_[Network]_[Topic]_[YYYY][MM][DD].sol`
+- `src/Aave[V2|V3]_[Network|Multi]_[Topic]_[YYYY][MM][DD]/Aave[V2|V3]_[Network]_[Topic]_[YYYY][MM][DD]_Test.t.sol`
 
-While the proposal tests can be combined in a single file, when addressing multiple networks, each payload should be placed in it's own file. The reason for this is that foundry verification will upload all contracts on verification, eventually bloating the code tab and making it hard to verify code on-chain.
+We highly recommend to only have one contract per file as it makes reviewing and verification easier.
 
 ## AIP
 
-- `src/Aave[V2|V3][Topic]_[YYYY][MM][DD]/Topic.md`
+- `src/Aave[V2|V3]_[Topic]_[YYYY][MM][DD]/[Topic].md`
 
 Markdown files will automatically be uploaded to ipfs once merged to main.
 
 ## Testing
 
+Please include an e2e test for all the assets you are touching in an `AIP`.
+
 ## Submitting changes
 
 ## Conventions

README.md

@@ -26,6 +26,34 @@ forge install
 yarn
 ```
 
+### Create an aip
+
+This repository includes a generator to help you bootstrap the required files for an `AIP`.
+To generate a proposal you need to run: `yarn generate -a "BGD labs" --chains Ethereum Polygon -pv V3 --name TestProposal --configEngine`
+
+To get a full list of available commands run `yarn generate --help`
+
+```sh
+Usage: proposal-generator [options]
+
+CLI to generate aave proposals
+
+Options:
+  -V, --version                    output the version number
+  -f, --force                      force creation (might overwrite existing files)
+  -cfg, --configEngine             extends config engine
+  -name, --name <string>           name of the proposal (e.g. CapsIncrease)
+  -ch, --chains <letters...>        (choices: "Ethereum", "Optimism", "Arbitrum", "Polygon", "Avalanche", "Fantom", "Harmony", "Metis")
+  -pv, --protocolVersion <string>   (choices: "V2", "V3")
+  -t, --title <string>             aip title
+  -a, --author <string>            author
+  -d, --discussion <string>        forum link
+  -s, --snapshot <string>          snapshot link
+  -h, --help                       display help for command
+```
+
+If you have any feedback regarding the generator (bugs, improvements, features), don't hesitate and put it [here](https://github.com/bgd-labs/aave-proposals/issues/200)!
+
 ### Test
 
 ```sh

generator/common.js

@@ -26,7 +26,7 @@ export function generateName(options) {
 }
 
 export function generateChainName(options, chain) {
-  return generateName({ ...options, chains: [chain] }).replace(/_/g, "");
+  return generateName({ ...options, chains: [chain] });
 }
 
 export function getAlias(chain) {

generator/generator.js

@@ -2,13 +2,7 @@ import fs from "fs";
 import path from "path";
 import { Command, Option } from "commander";
 import { generateAIP, generateScript } from "./templates.js";
-import {
-  SHORT_CHAINS,
-  generateChainName,
-  generateName,
-  getAlias,
-  getDate,
-} from "./common.js";
+import { generateChainName, generateName } from "./common.js";
 import { engineProposalTemplate } from "./templates/engineProposal.template.js";
 import { rawProposalTemplate } from "./templates/rawProposal.template.js";
 import { testTemplate } from "./templates/test.template.js";
@@ -52,7 +46,8 @@ program
   .addOption(new Option("-t, --title <string>", "aip title"))
   .addOption(new Option("-a, --author <string>", "author"))
   .addOption(new Option("-d, --discussion <string>", "forum link"))
-  .addOption(new Option("-s, --snapshot <string>", "snapshot link"));
+  .addOption(new Option("-s, --snapshot <string>", "snapshot link"))
+  .allowExcessArguments(false);
 
 program.parse();
 

generator/templates.js

@@ -48,14 +48,14 @@ contract CreateProposal is EthereumScript {
     GovHelpers.Payload[] memory payloads = new GovHelpers.Payload[](${
       options.chains.length
     });
-    ${options.chains
-      .map(
-        (chain, ix) =>
-          `payloads[${ix}] = GovHelpers.build${
-            chain == "Ethereum" ? "Mainnet" : chain
-          }(address(0));`
-      )
-      .join("\n")}
+${options.chains
+  .map(
+    (chain, ix) =>
+      `    payloads[${ix}] = GovHelpers.build${
+        chain == "Ethereum" ? "Mainnet" : chain
+      }(address(0));`
+  )
+  .join("\n")}
     GovHelpers.createProposal(payloads, GovHelpers.ipfsHashFile(vm, 'src/${generateName(
       options
     )}/${options.name}.md'));
@@ -66,9 +66,9 @@ contract CreateProposal is EthereumScript {
 
 export function generateAIP(options) {
   return `---
-title: ${options.title || ""}
-author: ${options.author || ""}
-discussions: ${options.discussion || ""}
+title: ${options.title || "TODO"}
+author: ${options.author || "TODO"}
+discussions: ${options.discussion || "TODO"}
 ---
 
 ## Simple Summary