linted code

Author: Eversmile12

.gitignore

@@ -5,7 +5,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
-
+my-dapp-[0-9]*
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

helpers/cleanUpFiles.ts

@@ -12,4 +12,21 @@ export const cleanUpFiles = () => {
     recursive: true,
     force: true,
   });
+  fs.rmSync(path.join(process.cwd(), "types"), {
+    recursive: true,
+    force: true,
+  });
+  fs.rmSync(path.join(process.cwd(), ".eslintignore"), {
+    force: true,
+  });
+  fs.rmSync(path.join(process.cwd(), ".eslintrc"), {
+    force: true,
+  });
+  fs.rmSync(path.join(process.cwd(), "contributing.md"), {
+    force: true,
+  });
+  fs.rmSync(path.join(process.cwd(), "yarn.lock"), {
+    recursive: true,
+    force: true,
+  });
 };

helpers/cloneRepo.ts

@@ -4,12 +4,12 @@ import path from "path";
 import fse from "fs-extra";
 import chalk from "chalk";
 import cliProgress from "cli-progress";
-import { createEnv } from "./createEnv.js";
 import { setUpHardhat } from "./setupHardhat.js";
+import { dappInfo } from "../interfaces/dappInfo.js";
 
 export const cloneRepo = (
-  projectPath,
-  dappInfo
+  projectPath : string,
+  dappInfo : dappInfo
 ) => {
   try {
     process.chdir(projectPath);
@@ -31,7 +31,7 @@ export const cloneRepo = (
 
 
 
-    let template = path.join(
+    const template = path.join(
       process.cwd(),
       "templates",
       (dappInfo.chain == "ethereum" || dappInfo.chain == "polygon" || dappInfo.chain == "arbitrum"|| dappInfo.chain == "optimism") ? "ethereum" : "solana",
@@ -45,8 +45,9 @@ export const cloneRepo = (
 
     bar1.stop();
 
-    if (dappInfo.wantsBackend) {
-      switch (dappInfo.type) {
+    if (dappInfo.useBackend) {
+      console.log(chalk.yellow(`Copying ${dappInfo.backendProvider} files...`));
+      switch (dappInfo.backendProvider) {
         case "hardhat":
           setUpHardhat(dappInfo)
           break;
@@ -56,10 +57,8 @@ export const cloneRepo = (
         case "Anchor":
           break;
       }
-       
-      setUpHardhat(dappInfo)
     }
   } catch (e) {
-    selfDestroy(e);
+    selfDestroy();
   }
 };

helpers/createEnv.ts

@@ -1,14 +1,14 @@
 import fs from "fs";
+import { APIKeys } from "../interfaces/dappInfo";
+import path from "path";
 
-export const createEnv = (keys, path) => {
-  let env = {};
+export const createEnv = (apiKeys: APIKeys, projectPath = "./") => {
 
-  if (keys.alchemyKey) {
-    env["NEXT_PUBLIC_ALCHEMY_API_KEY"] = "demo";
-  }
-  if (Object.keys(env).length) {
-    let writeStream = fs.createWriteStream(path.join(path,".env"));
-    for (const [key, value] of Object.entries(env)) {
+  console.log(apiKeys)
+
+  if (Object.keys(apiKeys).length) {
+    const writeStream = fs.createWriteStream(path.join(projectPath, ".env"));
+    for (const [key, value] of Object.entries(apiKeys)) {
       writeStream.write(`NEXT_PUBLIC_${key.toUpperCase()}= ${value}`);
     }
     writeStream.end();

helpers/createPackage.ts

@@ -2,8 +2,15 @@ import fs from "fs";
 import { execSync } from "child_process";
 import chalk from "chalk";
 import cliProgress from "cli-progress";
+import { selfDestroy } from "./selfDestroy";
 
-export const createPackageJson = async ( projectName: string, {isEVM, useBackend, backendProvider = ""}) => {
+interface packageData{
+  isEVM: boolean,
+  useBackend: boolean,
+  backendProvider?: string
+}
+
+export const createPackageJson = async ( projectName: string, {isEVM, useBackend, backendProvider = ""} : packageData) => {
   try {
     console.log(chalk.yellow("Generating package.json"));
     const bar1 = new cliProgress.SingleBar(
@@ -12,7 +19,7 @@ export const createPackageJson = async ( projectName: string, {isEVM, useBackend
     );
     bar1.start(200, 0);
 
-    let packageJson = {
+    const packageJson = {
       name: projectName,
       version: "0.1.0",
       private: true,
@@ -77,5 +84,7 @@ export const createPackageJson = async ( projectName: string, {isEVM, useBackend
     console.log(chalk.yellow("Installing dependencies..."));
     execSync("npm install");
     console.log(chalk.green("Dependencies installed"));
-  } catch (e) {}
+  } catch (e) {
+    selfDestroy()
+  }
 };

helpers/mkdir.ts

@@ -3,7 +3,7 @@ import fs from "fs"
 export const mkdir = (projectPath: string) => {
     try {
         fs.mkdirSync(projectPath)
-    } catch (e: any) {
+    } catch (e) {
       console.log(e)
     }
 }

helpers/selfDestroy.ts

@@ -2,11 +2,11 @@ import fs from "fs";
 
 let root = ""
 
-export const setRoot = (path) => {
+export const setRoot = (path: string) => {
     root = path;
 }
 
-export const selfDestroy = (e) => {
+export const selfDestroy = () => {
     // console.log("CURRENT WORKING DIRECTORY::", process.cwd())
     // console.log("ROOT::", root)
 

helpers/setupHardhat.ts

@@ -3,37 +3,25 @@ import cliProgress from "cli-progress";
 import path from "path";
 import { createEnv } from "./createEnv.js";
 import fse from "fs-extra";
+import { dappInfo } from "../interfaces/dappInfo.js";
 
-export const setUpHardhat = (dappInfo) => {
-    console.log(chalk.yellow(`Copying ${dappInfo.type} files...`));
-      const bar2 = new cliProgress.SingleBar(
-        {},
-        cliProgress.Presets.shades_classic
-      );
-      bar2.start(100, 0);
-      bar2.update(50);
+export const setUpHardhat = (dappInfo: dappInfo) => {
+  const bar2 = new cliProgress.SingleBar(
+    {},
+    cliProgress.Presets.shades_classic
+  );
+  bar2.start(100, 0);
+  bar2.update(50);
 
-      switch (dappInfo.type) {
-        case "hardhat":
-          let hardhatTemplate = path.join(
-            process.cwd(),
-            "templates",
-            "hardhat"
-          );
-            fse.mkdirSync(path.join(process.cwd(), "backend"));
-          fse.copySync(hardhatTemplate, path.join(process.cwd(), "backend"));
-          createEnv(dappInfo.APIKey, path.join(process.cwd(), "backend"))
-          break;
-        case "foundry":
-          break;
-        case "anchor":
-          break;
-      }
+  const hardhatTemplate = path.join(process.cwd(), "templates", "hardhat");
+  fse.mkdirSync(path.join(process.cwd(), "backend"));
+  fse.copySync(hardhatTemplate, path.join(process.cwd(), "backend"));
 
-      bar2.update(100);
-      bar2.stop();
-      console.log(
-        chalk.green("Smart Contract Development Environment copied ✅")
-      );
-    
-}
+  if (dappInfo.apiKeys) {
+    createEnv(dappInfo.apiKeys, path.join(process.cwd(), "backend"));
+  }
+
+  bar2.update(100);
+  bar2.stop();
+  console.log(chalk.green("Smart Contract Development Environment copied ✅"));
+};

index.ts

@@ -1,17 +1,17 @@
 #!/usr/bin/env node
-/* eslint-disable import/no-extraneous-dependencies */
 
 import * as Commander from "commander";
 import prompts from "prompts";
 import path from "path";
 import { createPackageJson } from "./helpers/createPackage.js";
-import { existsSync, fstat } from "fs";
+import { existsSync } from "fs";
 import { mkdir } from "./helpers/mkdir.js";
 import { cleanUpFiles } from "./helpers/cleanUpFiles.js";
 import { cloneRepo } from "./helpers/cloneRepo.js";
 import { selfDestroy, setRoot } from "./helpers/selfDestroy.js";
 import chalk from "chalk";
 import { createEnv } from "./helpers/createEnv.js";
+import { dappInfo } from "./interfaces/dappInfo.js"
 
 console.log(`MMMMMMMMMMMMMMMMMK:..:KMMMMMMMMMMMMMMMMM
 MMMMMMMMMMMMMMMWO,    ,OWMMMMMMMMMMMMMMM
@@ -34,20 +34,25 @@ l.       'kWNx.                       .l
 console.log("\n");
 console.log("🔵 Welcome to the create-web3-dapp wizard 🔵");
 console.log("\n");
+
 let projectPath = "";
 
+// Gets project name
 const program = new Commander.Command("create-web3-dapp")
   .version("0.1.0")
   .arguments("[project-directory]")
   .usage("<project-directory>")
-  .action((name) => {
+  .action((name: string) => {
     projectPath = name;
   })
   .option("--ts, --typescript", "Initialize as a TypeScript project")
   .parse(process.argv);
 
+// Starts creation process
 async function run() {
   try {
+
+    // Checks if project name is provided
     if (typeof projectPath === "string") {
       projectPath = projectPath.trim();
     }
@@ -60,38 +65,39 @@ async function run() {
       }).then((data) => data.projectPath);
     }
 
+    //Reformat project's name
     projectPath = projectPath.trim().replace(/[\W_]+/g, "-");
-    console.log(projectPath);
 
-    let resolvedProjectPath = path.resolve(projectPath);
-    let dirExists = existsSync(resolvedProjectPath);
+    let resolvedProjectPath: string = path.resolve(projectPath);
+    let dirExists: boolean = existsSync(resolvedProjectPath);
     setRoot(resolvedProjectPath);
 
+    // Check if project
     while (dirExists) {
       projectPath = await prompts({
         type: "text",
         name: "projectPath",
         message:
           "A directory with this name already exists, please use a different name",
         initial: "my-dapp",
-      }).then((data) => data.projectPath);
-      console.log(projectPath);
+      }).then((data) => data.projectPath.trim().replace(/[\W_]+/g, "-"));
       resolvedProjectPath = path.resolve(projectPath);
       dirExists = existsSync(resolvedProjectPath);
       console.log(dirExists);
     }
 
     const projectName = path.basename(resolvedProjectPath);
 
-    let dappInfo: dappInfo = {
+    const dappInfo: dappInfo = {
       chain: "",
       isEVM: true,
       isTestnet: false,
       useBackend: false,
       wantsTemplateFiles: false,
+      apiKeys: {}
     };
 
-    const chain = await prompts({
+    const chain: string = await prompts({
       type: "select",
       name: "chain",
       message: "For which VM are you building for?",
@@ -106,6 +112,7 @@ async function run() {
     }).then((data) => data.chain);
 
     dappInfo.chain = chain;
+    
     dappInfo.isEVM =
       chain == "ethereum" ||
       chain == "polygon" ||
@@ -115,7 +122,7 @@ async function run() {
         : false;
 
     if (dappInfo.chain === "ethereum" || dappInfo.chain === "polygon") {
-      const isTestnet = await prompts({
+      const isTestnet: boolean = await prompts({
         type: "toggle",
         name: "testnet",
         message: "Do you want to use a testnet?",
@@ -137,7 +144,7 @@ async function run() {
     }
     //TODO: Split in components selection
 
-    const wantsTemplateFiles = await prompts({
+    const wantsTemplateFiles: boolean = await prompts({
       type: "toggle",
       name: "templateFiles",
       message: "Do you want to import the template files?",
@@ -148,7 +155,7 @@ async function run() {
 
     dappInfo.wantsTemplateFiles = wantsTemplateFiles;
 
-    const useBackend = await prompts({
+    const useBackend: boolean = await prompts({
       type: "toggle",
       name: "useBackend",
       message:
@@ -161,6 +168,7 @@ async function run() {
     dappInfo.useBackend = useBackend;
 
     if (useBackend) {
+      // set provider
       if (dappInfo.chain === "solana") {
         await prompts({
           type: "select",
@@ -183,27 +191,26 @@ async function run() {
       }
     }
 
-    let alchemyAPIKey = await prompts({
+    const alchemyAPIKey: string = await prompts({
       type: "text",
       name: "apiKey",
       message: "Insert your Alchemy API Key (if none, 'demo' will be used",
       initial: "demo",
     }).then((data) => data.apiKey);
 
-    mkdir(resolvedProjectPath);
+    dappInfo.apiKeys["alchemy_api_key"]= alchemyAPIKey
 
+    mkdir(resolvedProjectPath);
     cloneRepo(resolvedProjectPath, dappInfo);
-
     createPackageJson(projectName, dappInfo);
-
-    createEnv(alchemyAPIKey, process.cwd());
+    createEnv(dappInfo.apiKeys, process.cwd());
     cleanUpFiles();
 
     console.log(
       chalk.green("Visit https://docs.alchemy.com/for the complete tutorial")
     );
   } catch (e) {
-    selfDestroy(e);
+    selfDestroy();
   }
 }