style: setup prettier (#22)

Author: larsrickert

.github/workflows/check.yml

@@ -48,5 +48,8 @@ jobs:
       - name: 📦 Install dependencies
         run: pnpm install
 
+      - name: 🔍 Check formatting
+        run: pnpm format:check
+
       - name: 🛠️ Build
         run: pnpm docs:build

.prettierignore

@@ -0,0 +1,4 @@
+# Prettier ignores all files inside .gitignore by default so this file only contains
+# files that are checked into git but should not be formatted
+pnpm-lock.yaml
+CHANGELOG.md

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "printWidth": 100
+}

cli/src/commands/deploy.command.ts

@@ -4,27 +4,21 @@ import { cli } from "..";
 import { cloneOrPullRepo } from "../utils/git";
 
 export const deployCommand = new Command("deploy")
-  .description(
-    "Clone or pull latest git repository and (re)build docker-compose.yml"
-  )
+  .description("Clone or pull latest git repository and (re)build docker-compose.yml")
   .argument("<url>", "URL of the git repository")
-  .option(
-    "-b, --branch <branch>",
-    "Branch name to checkout before deploying",
-    "main"
-  )
+  .option("-b, --branch <branch>", "Branch name to checkout before deploying", "main")
   .option(
     "-d, --dir <dir>",
     "Directory where the git repository should be cloned in. Will create a subfolder inside this directory (see option --folder)",
-    "./applications"
+    "./applications",
   )
   .option(
     "-f, --folder <folder>",
-    "Folder name inside the applications directory that the repo is cloned to. If not provided, repository name will be used"
+    "Folder name inside the applications directory that the repo is cloned to. If not provided, repository name will be used",
   )
   .option(
     "-r, --root <root>",
-    "Root directory inside the git repository where the docker-compose.yml is located that should be deployed. If not provided, repository root (.) will be used"
+    "Root directory inside the git repository where the docker-compose.yml is located that should be deployed. If not provided, repository root (.) will be used",
   )
   .action(async (url: string, options: OptionValues) => {
     if (!shell.which("git") || !shell.which("docker-compose")) {
@@ -36,10 +30,7 @@ export const deployCommand = new Command("deploy")
     const folderName = options.folder as string | undefined;
     const root = options.root as string | undefined;
 
-    if (
-      folderName &&
-      (folderName.startsWith(".") || folderName.includes("/"))
-    ) {
+    if (folderName && (folderName.startsWith(".") || folderName.includes("/"))) {
       return cli.error(`Folder name "${folderName}" is invalid`);
     }
 
@@ -55,9 +46,7 @@ export const deployCommand = new Command("deploy")
       return cli.error("URL must start with https://");
     }
 
-    shell.echo(
-      `Deploying git repository "${url}" with branch "${branch}"...\n`
-    );
+    shell.echo(`Deploying git repository "${url}" with branch "${branch}"...\n`);
 
     try {
       const repoPath = await cloneOrPullRepo(url, applicationsDir, folderName);
@@ -71,9 +60,7 @@ export const deployCommand = new Command("deploy")
       shell.echo(`Rebuilding docker-compose.yml...`);
       if (
         shell.exec(
-          `${
-            root ? `cd ${root} &&` : ""
-          } docker-compose -f ./docker-compose.yml up -d --build`
+          `${root ? `cd ${root} &&` : ""} docker-compose -f ./docker-compose.yml up -d --build`,
         ).code !== 0
       ) {
         cli.error(`Error: docker-compose rebuild failed`);

cli/src/utils/git.ts

@@ -6,7 +6,7 @@ import { exists } from "./shell";
 export async function cloneOrPullRepo(
   url: string,
   path: string,
-  folderName?: string
+  folderName?: string,
 ): Promise<string> {
   folderName ||= basename(url);
   const repoPath = join(path, folderName);
@@ -16,21 +16,15 @@ export async function cloneOrPullRepo(
   }
 
   if (!exists(repoPath)) {
-    shell.echo(
-      `Application "${folderName}" is deployed for the first time. Cloning repository.`
-    );
+    shell.echo(`Application "${folderName}" is deployed for the first time. Cloning repository.`);
     if (shell.exec(`cd ${path} && git clone ${url} ${folderName}`).code !== 0) {
       cli.error(`Error: Git clone repository failed`);
     }
   } else {
-    const { stdout: gitUrl } = shell.exec(
-      `cd ${repoPath} && git config --get remote.origin.url`
-    );
+    const { stdout: gitUrl } = shell.exec(`cd ${repoPath} && git config --get remote.origin.url`);
 
     if (!gitUrl.includes(url)) {
-      cli.error(
-        `A different application with name "${folderName}" does already exist`
-      );
+      cli.error(`A different application with name "${folderName}" does already exist`);
     }
 
     shell.echo("Pulling latest git changes.");

cli/tsconfig.json

@@ -1,14 +1,14 @@
 {
-	"compilerOptions": {
-		"target": "ES2020",
-		"module": "commonjs",
-		"esModuleInterop": true,
-		"forceConsistentCasingInFileNames": true,
-		"strict": true,
-		"skipLibCheck": true,
-		"outDir": "bin",
-		"rootDir": "src",
-		"importHelpers": false
-	},
-	"include": ["src"]
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "bin",
+    "rootDir": "src",
+    "importHelpers": false
+  },
+  "include": ["src"]
 }

package.json

@@ -15,9 +15,21 @@
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
     "docs:serve": "vitepress serve docs",
-    "preinstall": "npx only-allow pnpm"
+    "format": "prettier . --write",
+    "format:check": "prettier . --check",
+    "preinstall": "npx only-allow pnpm",
+    "prepare": "simple-git-hooks"
   },
   "devDependencies": {
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5",
+    "simple-git-hooks": "^2.11.1",
     "vitepress": "^1.1.4"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "prettier --write -u"
   }
 }