Added automatic gitignore

Author: Hugos68

.changeset/eight-foxes-burn.md

@@ -0,0 +1,5 @@
+---
+'capkit': minor
+---
+
+Added gitignore job, /ios, /android and temp files are now removed

.gitignore

@@ -7,10 +7,4 @@ node_modules
 .env.*
 !.env.example
 vite.config.js.timestamp-*
-vite.config.ts.timestamp-*
-
-# Capacitor
-/android
-/ios
-capacitor.config.json.timestamp-*
-capacitor.config.json
+vite.config.ts.timestamp-*

README.md

@@ -20,18 +20,25 @@ Before starting be aware that Capacitor will only work with [Adapter Static](htt
 To get started with the CLI you can simply go into your existing sveltekit project and run:
 
 npm:
+
 ```bash
 npx capkit init
 ```
+
 pnpm:
+
 ```bash
 pnpm dlx capkit init
 ```
+
 yarn:
+
 ```bash
 yarn dlx capkit init
 ```
+
 bun:
+
 ```bash
 bunx capkit init
 ```
@@ -47,37 +54,51 @@ Upon doing this, you will be guided through a series of questions to help you co
 When working with native applications and using their respective IDE's (Android Studio or Xcode) you can enable hot reloading by running:
 
 npm:
+
 ```bash
 npm run dev:cap
 ```
+
 pnpm:
+
 ```bash
 pnpm dev:cap
 ```
+
 yarn:
+
 ```bash
 yarn dev:cap
 ```
+
 bun:
+
 ```bash
 bunx dev:cap
 ```
 
 If you are solely focusing on creating a progressive web app you can run:
 
 npm:
+
 ```bash
 npm run dev
 ```
+
 pnpm:
+
 ```bash
 pnpm dev
 ```
+
 yarn:
+
 ```bash
 yarn dev
 ```
+
 bun:
+
 ```bash
 bunx dev
 ```
@@ -87,40 +108,55 @@ bunx dev
 When building to native platforms you can use:
 
 npm:
+
 ```bash
 npm run build:cap
 ```
+
 pnpm:
+
 ```bash
 pnpm build:cap
 ```
+
 yarn:
+
 ```bash
 yarn build:cap
 ```
+
 bun:
+
 ```bash
 bunx build:cap
 ```
 
 If you are solely focusing on building a progressive web app you can run:
 
 npm:
+
 ```bash
 npm run build
 ```
+
 pnpm:
+
 ```bash
 pnpm build
 ```
+
 yarn:
+
 ```bash
 yarn build
 ```
+
 bun:
+
 ```bash
 bunx build
 ```
+
 ---
 
 ## Capacitor
@@ -129,6 +165,13 @@ For further questions about Capacitor you can refer to the [Capacitor Docs](http
 
 ---
 
+## Examples
+
+Here is a example project of a SvelteKit app with Capacitor deployed to Vercel: https://capkit-vercel.vercel.app/
+Repository: https://github.com/Hugos68/capkit-vercel
+
+---
+
 ## Issues
 
 If you encounter any issues or have concerns, please take a moment to [report them](https://github.com/Hugos68/capkit/issues/new). Your feedback is greatly appreciated and improves the quality of CapKit.

index.js

@@ -238,6 +238,19 @@ async function initializeProject({
 		}
 	});
 
+	if (existsSync(`${process.cwd()}/.gitignore`)) {
+		jobs.push({
+			start: `Configuring: "${kleur.cyan('.gitignore')}"`,
+			stop: `Successfully configured: "${kleur.cyan('.gitignore')}"`,
+			task: async () => {
+				const gitignores = ['# Capacitor', '/android', '/ios', 'capacitor.config.json.timestamp-*'];
+				const gitignore = await fs.readFile(`${process.cwd()}/.gitignore`, 'utf-8');
+				const newGitignore = gitignore + '\n' + gitignores.join('\n');
+				return fs.writeFile('.gitignore', newGitignore, 'utf-8');
+			}
+		});
+	}
+
 	await executeJobs(jobs);
 }
 

package-lock.json

@@ -8,7 +8,9 @@
   },
   "scripts": {
     "format": "prettier . --write .",
-    "release": "changeset publish --access public"
+    "release": "changeset publish --access public",
+    "dev:cap": "node ./scripts/hotreload.js && npx cap sync && node ./scripts/hotreload-cleanup.js && npm run build",
+    "build:cap": "vite build && npx cap sync"
   },
   "repository": {
     "type": "git",
@@ -31,4 +33,4 @@
     "prettier": "^3.0.3"
   },
   "type": "module"
-}
+}