add prettier task (#750)

Author: technophile-04

.changeset/silly-coins-share.md

@@ -0,0 +1,5 @@
+---
+"create-eth": patch
+---
+
+Add format with prettier task

src/main.ts

@@ -3,6 +3,7 @@ import {
   createProjectDirectory,
   installPackages,
   createFirstGitCommit,
+  prettierFormat,
 } from "./tasks";
 import type { Options } from "./types";
 import { renderOutroMessage } from "./utils/render-outro-message";
@@ -44,6 +45,10 @@ export async function createProject(options: Options) {
         }
       },
     },
+    {
+      title: "🪄 Formatting files with prettier",
+      task: () => prettierFormat(targetDirectory),
+    },
     {
       title: `📡 Initializing Git repository ${
         options.extensions.includes("foundry") ? "and submodules" : ""

src/tasks/index.ts

@@ -2,3 +2,4 @@ export * from "./copy-template-files";
 export * from "./create-project-directory";
 export * from "./install-packages";
 export * from "./create-first-git-commit";
+export * from "./prettier-format";

src/tasks/prettier-format.ts

@@ -0,0 +1,15 @@
+import { execa } from "execa";
+
+export async function prettierFormat(targetDir: string) {
+  try {
+    const result = await execa("yarn", ["format"], { cwd: targetDir });
+
+    if (result.failed) {
+      throw new Error("There was a problem running the format command");
+    }
+  } catch (error) {
+    throw new Error("Failed to create directory", { cause: error });
+  }
+
+  return true;
+}

templates/base/package.json

@@ -13,6 +13,7 @@
     "next:lint": "yarn workspace @se-2/nextjs lint",
     "next:format": "yarn workspace @se-2/nextjs format",
     "next:check-types": "yarn workspace @se-2/nextjs check-types",
+    "format": "yarn next:format",
     "postinstall": "husky install",
     "precommit": "lint-staged",
     "vercel": "yarn workspace @se-2/nextjs vercel",

templates/extensions/foundry/package.json

@@ -8,8 +8,10 @@
     "deploy:verify": "yarn workspace @se-2/foundry deploy:verify",
     "foundry:lint": "yarn workspace @se-2/foundry lint",
     "foundry:test": "yarn workspace @se-2/foundry test",
+    "foundry:format": "yarn workspace @se-2/foundry format",
     "test": "yarn foundry:test",
     "verify": "yarn workspace @se-2/foundry verify",
-    "generate": "yarn workspace @se-2/foundry generate"
+    "generate": "yarn workspace @se-2/foundry generate",
+    "format": "yarn next:format && yarn foundry:format"
   }
 }

templates/extensions/foundry/packages/foundry/.prettier.json

@@ -0,0 +1,6 @@
+{
+  "arrowParens": "avoid",
+  "printWidth": 120,
+  "tabWidth": 2,
+  "trailingComma": "all"
+}

templates/extensions/foundry/packages/foundry/contracts/YourContract.sol

@@ -73,7 +73,7 @@ contract YourContract {
      * The function can only be called by the owner of the contract as defined by the isOwner modifier
      */
     function withdraw() public isOwner {
-        (bool success, ) = owner.call{value: address(this).balance}("");
+        (bool success,) = owner.call{value: address(this).balance}("");
         require(success, "Failed to send Ether");
     }
 

templates/extensions/foundry/packages/foundry/foundry.toml

@@ -33,4 +33,9 @@ scroll = "https://rpc.scroll.io"
 polygonMumbai = { key = "${ETHERSCAN_API_KEY}" }
 goerli = { key = "${ETHERSCAN_API_KEY}" }
 
+
+[fmt]
+line_length = 80
+multiline_func_header = "params_first"
+
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

templates/extensions/foundry/packages/foundry/package.json

@@ -10,7 +10,8 @@
     "deploy": "forge build --build-info --build-info-path out/build-info/ && forge script script/Deploy.s.sol --rpc-url ${1:-default_network} --broadcast --legacy && node script/generateTsAbis.js",
     "deploy:verify": "forge build --build-info --build-info-path out/build-info/ && forge script script/Deploy.s.sol --rpc-url ${1:-default_network} --broadcast --legacy --verify ; node script/generateTsAbis.js",
     "verify": "forge build --build-info --build-info-path out/build-info/ && forge script script/VerifyAll.s.sol --ffi --rpc-url ${1:-default_network}",
-    "lint": "forge fmt",
+    "lint": "forge fmt --check && prettier --check ./script/**/*.js",
+    "format": "forge fmt && prettier --write ./script/**/*.js",
     "test": "forge test"
   },
   "devDependencies": {