Template categories and descriptions

Author: mutantcornholio

src/templateConfigs/index.ts

@@ -1,13 +1,9 @@
+import { TemplateConfig } from "#src/types";
+
 import reactPapiTailwind from "./react-papi-tailwind";
 import reactSolidityHardhat from "./react-solidity-hardhat";
 import reactSolidityRemix from "./react-solidity-remix";
 
-export type TemplateConfig = {
-  instructions: string;
-  npmRoots: string[];
-  postinstallScript?: string;
-};
-
 export const configs: Record<string, TemplateConfig> = {
   "react-papi-tailwind": reactPapiTailwind,
   "react-solidity-hardhat": reactSolidityHardhat,

src/templateConfigs/react-papi-tailwind.ts

@@ -1,7 +1,9 @@
-import { TemplateConfig } from "#src/templateConfigs/index";
+import { TemplateConfig, TemplateType } from "#src/types";
 import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
+  templateType: TemplateType.Recommended,
+  description: "Frontend dApp template using React, PAPI, ReactiveDOT and dot-connect",
   npmRoots: ["/"],
   instructions: `
 ${c.secondary("Start app:")}

src/templateConfigs/react-solidity-hardhat.ts

@@ -1,7 +1,9 @@
-import { TemplateConfig } from "#src/templateConfigs/index";
+import { TemplateConfig, TemplateType } from "#src/types";
 import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
+  templateType: TemplateType.Recommended,
+  description: "Solidity template with hardhat environment + wagmi-based frontend",
   npmRoots: ["contracts", "frontend"],
   instructions: `
 ${c.primary("Develop smart contracts:")}

src/templateConfigs/react-solidity-remix.ts

@@ -1,7 +1,9 @@
-import { TemplateConfig } from "#src/templateConfigs/index";
+import { TemplateConfig, TemplateType } from "#src/types";
 import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
+  templateType: TemplateType.Deprecated,
+  description: "Solidity template with remix/ethers environment + ethers-based frontend",
   npmRoots: ["contracts", "frontend"],
   instructions: `
 ${c.primary("For Remix environment:")}

src/types.ts

@@ -0,0 +1,13 @@
+export enum TemplateType {
+  Recommended,
+  Deprecated,
+  // TODO: External
+}
+
+export type TemplateConfig = {
+  instructions: string;
+  npmRoots: string[];
+  postinstallScript?: string;
+  templateType: TemplateType;
+  description: string;
+};

src/util/dappData.ts

@@ -1,17 +1,46 @@
-import { input, select } from "@inquirer/prompts";
-import { configs, TemplateConfig, TemplateNames } from "#src/templateConfigs/index";
+import { input, select, Separator } from "@inquirer/prompts";
+import { configs, TemplateNames } from "#src/templateConfigs/index";
+import { TemplateConfig, TemplateType } from "#src/types";
+import { colors as c } from "#src/util/log";
 
 export type DappData = {
   name: string;
   template: TemplateNames;
   config: TemplateConfig;
 };
 
+type Choice = {
+  value: TemplateNames;
+  description: string;
+};
+
+function formatChoices(): (Choice | Separator)[] {
+  const res: (Choice | Separator)[] = [];
+
+  const mapTemplate = ([name, template]: [TemplateNames, TemplateConfig]) => {
+    return { value: name as TemplateNames, description: template.description };
+  };
+
+  res.push(new Separator(c.primary("Recommended templates:")));
+  const recommendedTemplates = Object.entries(configs).filter(
+    ([_, template]) => template.templateType === TemplateType.Recommended,
+  );
+  res.push(...recommendedTemplates.map(mapTemplate), new Separator());
+
+  res.push(new Separator(c.primary("Deprecated templates:")));
+  const deprecatedTemplates = Object.entries(configs).filter(
+    ([_, template]) => template.templateType === TemplateType.Deprecated,
+  );
+  res.push(...deprecatedTemplates.map(mapTemplate));
+
+  return res;
+}
+
 export async function inquireDappData(): Promise<DappData> {
   const name = await input({ message: "Project name", required: true, default: "my-polkadot-dapp" });
   const template: TemplateNames = await select<TemplateNames>({
     message: "Select template",
-    choices: Object.keys(configs),
+    choices: formatChoices(),
   });
 
   return { name, config: configs[template], template };