optikit 1.0.4 → 1.1.1

package/CHANGELOG.md

@@ -10,6 +10,11 @@ We follow Semantic Versioning (SemVer) to indicate the nature of changes:
 
 Each section lists the changes in chronological order, with the most recent release at the top. We also include links to relevant discussions or issues when appropriate.
 
+## [1.1.1]
+### Added
+- **VS Code Setup Command:** Use the `setup-vscode` command to automatically create a `.vscode` folder with recommended Flutter settings—configured specifically for FVM. This command streamlines your project setup by setting the Flutter SDK path to `.fvm/flutter_sdk`, ensuring a smooth development experience for FVM users.
+
+  
 ## [1.0.4]
 ### Modified
 - Updated the CLI to support the latest version of Opticore.

package/USAGE.md

@@ -146,6 +146,16 @@ optikit open-ios
 
 ---
 
+### 11. VS Code Setup Command
+- Automatically create a `.vscode` folder with a `settings.json` file preconfigured for Flutter projects using FVM. This command streamlines your project setup by setting the Flutter SDK path to `.fvm/flutter_sdk`.
+
+```bash
+optikit setup-vscode
+```
+
+---
+
+
 ## Verification
 
 After running any command, you can verify its success by observing the output or using the `optikit --version` command to confirm the CLI's version.

package/dist/cli.js

@@ -11,6 +11,7 @@ import { buildFlutterApk, buildFlutterBundle, buildFlutterIos, buildFlutterIpa,
 import { boxenOptions } from "./styles.js";
 import { openIos, openAndroid } from "./commands/openProject.js";
 import { createRequire } from "module";
+import { createVscodeSettings } from "./commands/setupVSCode.js";
 const require = createRequire(import.meta.url);
 const packageInfo = require("../package.json");
 const version = packageInfo.version;
@@ -124,6 +125,8 @@ const options = yargs(hideBin(process.argv))
 })
     .command("open-android", "Open the Android project in Android Studio", {}, async () => {
     await openAndroid();
+}).command("setup-vscode", "Create a .vscode folder with recommended Flutter settings", () => { }, async () => {
+    await createVscodeSettings();
 })
     .version(version)
     .help(true).argv;

package/dist/commands/setupVSCode.js

@@ -0,0 +1,40 @@
+import { execCommand } from "../utils/execHelpers.js";
+import { LoggerHelpers } from "../utils/loggerHelpers.js";
+export { createVscodeSettings, };
+/**
+ * Creates a .vscode directory (if it doesn't exist) and writes a settings.json file
+ * with recommended Flutter configuration. The Flutter SDK path is set to ".fvm/flutter_sdk".
+ */
+async function createVscodeSettings() {
+    try {
+        // Create the .vscode folder (using -p ensures it won't error if it already exists)
+        await execCommand('mkdir -p .vscode');
+        LoggerHelpers.success("Created .vscode directory (if not already present).");
+        // Use a heredoc to write the settings.json file
+        const command = `
+cat << 'EOF' > .vscode/settings.json
+{
+  "dart.flutterSdkPath": ".fvm/flutter_sdk",
+  "editor.formatOnSave": true,
+  "dart.previewFlutterUiGuides": true,
+  "files.exclude": {
+    "**/.git": true,
+    "**/.DS_Store": true,
+    "**/node_modules": true,
+    "**/build": true
+  }
+}
+EOF
+`;
+        await execCommand(command);
+        LoggerHelpers.success("Created .vscode/settings.json with Flutter configuration.");
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            LoggerHelpers.error(`Error while creating VSCode settings: ${error.message}`);
+        }
+        else {
+            LoggerHelpers.error(`Error while creating VSCode settings: ${error}`);
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optikit",
-  "version": "1.0.4",
+  "version": "1.1.1",
   "description": "OptiKit CLI",
   "main": "src/cli.ts",
   "type": "module",
@@ -14,17 +14,17 @@
   },
   "keywords": [
     "optikit",
-    "optikit_cli"
+    "optikit_cli",
+    "optikit_cli_tool",
+    "opticore"
   ],
   "author": "Mahmoud El Shenawy",
   "license": "ISC",
   "dependencies": {
-    "appium-doctor": "1.16.2",
     "arg": "^5.0.2",
     "boxen": "^8.0.1",
     "chalk": "^4.1.2",
     "esm": "^3.2.25",
-    "inquirer": "^9.2.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
@@ -38,4 +38,4 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.6.3"
   }
-}
+}

package/src/cli.ts

@@ -17,6 +17,7 @@ import {
 import { boxenOptions } from "./styles.js";
 import { openIos, openAndroid } from "./commands/openProject.js";
 import { createRequire } from "module";
+import { createVscodeSettings } from "./commands/setupVSCode.js";
 const require = createRequire(import.meta.url);
 const packageInfo: { version: string } = require("../package.json");
 
@@ -182,6 +183,13 @@ const options = yargs(hideBin(process.argv))
     async () => {
       await openAndroid();
     }
+  ).command(
+    "setup-vscode",
+    "Create a .vscode folder with recommended Flutter settings",
+    () => {},
+    async () => {
+      await createVscodeSettings();
+    }
   )
   .version(version)
   .help(true).argv;

package/src/commands/openProject.ts

@@ -26,12 +26,12 @@ async function openAndroid() {
 
     const osPlatform = platform();
     let command;
-  
-    
+
+
     if (osPlatform === "win32") {
       command = "start android";
     } else if (osPlatform === "darwin") {
-      command = "open -a 'Android Studio' android"; 
+      command = "open -a 'Android Studio' android";
     } else {
       command = "xdg-open android"; 
     }

package/src/commands/setupVSCode.ts

@@ -0,0 +1,44 @@
+import chalk from "chalk";
+import { execCommand } from "../utils/execHelpers.js";
+import { LoggerHelpers } from "../utils/loggerHelpers.js";
+
+export {
+  createVscodeSettings,
+};
+
+/**
+ * Creates a .vscode directory (if it doesn't exist) and writes a settings.json file
+ * with recommended Flutter configuration. The Flutter SDK path is set to ".fvm/flutter_sdk".
+ */
+async function createVscodeSettings(): Promise<void> {
+  try {
+    // Create the .vscode folder (using -p ensures it won't error if it already exists)
+    await execCommand('mkdir -p .vscode');
+    LoggerHelpers.success("Created .vscode directory (if not already present).");
+
+    // Use a heredoc to write the settings.json file
+    const command = `
+cat << 'EOF' > .vscode/settings.json
+{
+  "dart.flutterSdkPath": ".fvm/flutter_sdk",
+  "editor.formatOnSave": true,
+  "dart.previewFlutterUiGuides": true,
+  "files.exclude": {
+    "**/.git": true,
+    "**/.DS_Store": true,
+    "**/node_modules": true,
+    "**/build": true
+  }
+}
+EOF
+`;
+    await execCommand(command);
+    LoggerHelpers.success("Created .vscode/settings.json with Flutter configuration.");
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error while creating VSCode settings: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error while creating VSCode settings: ${error}`);
+    }
+  }
+} 

package/src/commands/updateVersions.ts

@@ -98,19 +98,19 @@ async function updateIosVersionAndBuild(version: string, iosBuild: string) {
           /CURRENT_PROJECT_VERSION\s*=\s*[^;]+;/g,
           `CURRENT_PROJECT_VERSION = ${iosBuild};`
         );
-  
+
       fs.writeFileSync(projectPbxProjPath, projectContent);
-  
+
       LoggerHelpers.success(`Updated MARKETING_VERSION to ${version} and CURRENT_PROJECT_VERSION to ${iosBuild}`);
-  
+
       const infoPlistPath = path.join(currentDir, "ios/Runner/Info.plist");
-  
+
       if (!fs.existsSync(infoPlistPath)) {
         throw new Error(`Info.plist not found at ${infoPlistPath}`);
       }
-  
+
       const infoPlistContent = fs.readFileSync(infoPlistPath, "utf8");
-  
+
       const updatedPlist = infoPlistContent
         .replace(
           /<key>CFBundleShortVersionString<\/key>\s*<string>\$\{MARKETING_VERSION\}<\/string>/,
@@ -120,10 +120,10 @@ async function updateIosVersionAndBuild(version: string, iosBuild: string) {
           /<key>CFBundleVersion<\/key>\s*<string>\$\{CURRENT_PROJECT_VERSION\}<\/string>/,
           `<key>CFBundleVersion</key><string>${iosBuild}</string>`
         );
-  
+
       fs.writeFileSync(infoPlistPath, updatedPlist);
       LoggerHelpers.success("Updated Info.plist with the new version and iOS build.");
-  
+
     } catch (error) {
       LoggerHelpers.error(
         `Error while updating iOS version and build: ${

package/.history/.gitignore_20241023143139

@@ -1,53 +0,0 @@
-# Node.js modules
-node_modules/
-
-# Build output
-dist/
-
-# Log files
-*.log
-
-# Environment variables
-.env
-.env.local
-.env.*.local
-
-# Temporary files
-*.tmp
-*.temp
-*.cache
-
-# IDE and Editor folders
-.idea/
-.vscode/
-.DS_Store
-
-# TypeScript output
-*.tsbuildinfo
-*.js
-*.d.ts
-
-# Ignore package-lock.json
-package-lock.json
-
-# Yarn specific files
-yarn-error.log
-yarn-debug.log
-
-# OS specific files
-Thumbs.db
-ehthumbs.db
-Icon?
-Desktop.ini
-
-# Coverage directory used by tools like istanbul
-coverage/
-
-# Jest test results
-jest-test-results.json
-
-# NPM local config
-.npm/
-
-# npm-debug.log
-npm-debug.log*

package/.history/.gitignore_20241024014912

@@ -1,54 +0,0 @@
-# Node.js modules
-node_modules/
-
-# Build output
-dist/
-
-# Log files
-*.log
-
-# Environment variables
-.env
-.env.local
-.env.*.local
-
-# Temporary files
-*.tmp
-*.temp
-*.cache
-
-# IDE and Editor folders
-.idea/
-.vscode/
-.DS_Store
-
-# TypeScript output
-*.tsbuildinfo
-*.js
-*.d.ts
-
-# Ignore package-lock.json
-package-lock.json
-
-# Yarn specific files
-yarn-error.log
-yarn-debug.log
-
-# OS specific files
-Thumbs.db
-ehthumbs.db
-Icon?
-Desktop.ini
-
-# Coverage directory used by tools like istanbul
-coverage/
-
-# Jest test results
-jest-test-results.json
-
-# NPM local config
-.npm/
-
-# npm-debug.log
-npm-debug.log*
-

package/.history/.gitignore_20241024014914

@@ -1,55 +0,0 @@
-# Node.js modules
-node_modules/
-
-# Build output
-dist/
-
-# Log files
-*.log
-
-# Environment variables
-.env
-.env.local
-.env.*.local
-
-# Temporary files
-*.tmp
-*.temp
-*.cache
-
-# IDE and Editor folders
-.idea/
-.vscode/
-.DS_Store
-
-# TypeScript output
-*.tsbuildinfo
-*.js
-*.d.ts
-
-# Ignore package-lock.json
-package-lock.json
-
-# Yarn specific files
-yarn-error.log
-yarn-debug.log
-
-# OS specific files
-Thumbs.db
-ehthumbs.db
-Icon?
-Desktop.ini
-
-# Coverage directory used by tools like istanbul
-coverage/
-
-# Jest test results
-jest-test-results.json
-
-# NPM local config
-.npm/
-
-# npm-debug.log
-npm-debug.log*
-
-#

package/.history/.gitignore_20241024014915

@@ -1,55 +0,0 @@
-# Node.js modules
-node_modules/
-
-# Build output
-dist/
-
-# Log files
-*.log
-
-# Environment variables
-.env
-.env.local
-.env.*.local
-
-# Temporary files
-*.tmp
-*.temp
-*.cache
-
-# IDE and Editor folders
-.idea/
-.vscode/
-.DS_Store
-
-# TypeScript output
-*.tsbuildinfo
-*.js
-*.d.ts
-
-# Ignore package-lock.json
-package-lock.json
-
-# Yarn specific files
-yarn-error.log
-yarn-debug.log
-
-# OS specific files
-Thumbs.db
-ehthumbs.db
-Icon?
-Desktop.ini
-
-# Coverage directory used by tools like istanbul
-coverage/
-
-# Jest test results
-jest-test-results.json
-
-# NPM local config
-.npm/
-
-# npm-debug.log
-npm-debug.log*
-
-# 

package/.history/.gitignore_20241024014921

@@ -1,56 +0,0 @@
-# Node.js modules
-node_modules/
-
-# Build output
-dist/
-
-# Log files
-*.log
-
-# Environment variables
-.env
-.env.local
-.env.*.local
-
-# Temporary files
-*.tmp
-*.temp
-*.cache
-
-# IDE and Editor folders
-.idea/
-.vscode/
-.DS_Store
-
-# TypeScript output
-*.tsbuildinfo
-*.js
-*.d.ts
-
-# Ignore package-lock.json
-package-lock.json
-
-# Yarn specific files
-yarn-error.log
-yarn-debug.log
-
-# OS specific files
-Thumbs.db
-ehthumbs.db
-Icon?
-Desktop.ini
-
-# Coverage directory used by tools like istanbul
-coverage/
-
-# Jest test results
-jest-test-results.json
-
-# NPM local config
-.npm/
-
-# npm-debug.log
-npm-debug.log*
-
-# .history directory
-.history/

package/.history/.npmignore_20241205005905

@@ -1,4 +0,0 @@
-node_modules/
-dist/
-*.log
-test/

package/.history/.npmignore_20241205005909

@@ -1,4 +0,0 @@
-node_modules/
-dist/
-*.log
-test/

package/.history/.npmignore_20241205005925

@@ -1,4 +0,0 @@
-node_modules/
-dist/
-*.log
-test/

package/.history/CHANGELOG_20250202181744.md

@@ -1,34 +0,0 @@
-# Changelog
-
-All notable changes to this project are documented in this file. Each release includes details about new features, improvements, bug fixes, and any breaking changes. This changelog helps users and developers track the evolution of the project and understand how different versions may impact their use of the tool.
-
-We follow Semantic Versioning (SemVer) to indicate the nature of changes:
-
-	•	MAJOR: Breaking changes that may affect compatibility.
-	•	MINOR: New features or improvements that are backward compatible.
-	•	PATCH: Bug fixes and minor improvements that are backward compatible.
-
-Each section lists the changes in chronological order, with the most recent release at the top. We also include links to relevant discussions or issues when appropriate.
-
-## [1.1.0] - 2024-11-21
-### Added
-- New Commands:
-  - `optikit flutter-update-version`: Update the version and build numbers for both Android and iOS, with support for automatic versioning and build number management.
-  - `optikit flutter-build-ios`: Build the Flutter iOS app for release, with support for FVM and automatic version incrementing
-  - `optikit flutter-build-ipa`: Create a release IPA for the Flutter app, with support for FVM and automatic version incrementing.
-
-## [1.0.0] - 2024-11-18
-### Added
-- Initial release of the CLI tool with the following commands:
-  - `optikit generate module <module_name>`
-  - `optikit clean-flutter`
-  - `optikit clean-ios`
-  - `sheno flutter-build-apk`
-  - `sheno flutter-build-bundle`
-  - `sheno open-android`
-  - `sheno open-ios`
-- Support for version handling using Semantic Versioning (SemVer).
-
-## [0.1.0] - 2024-10-15
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181748.md

@@ -1,34 +0,0 @@
-# Changelog
-
-All notable changes to this project are documented in this file. Each release includes details about new features, improvements, bug fixes, and any breaking changes. This changelog helps users and developers track the evolution of the project and understand how different versions may impact their use of the tool.
-
-We follow Semantic Versioning (SemVer) to indicate the nature of changes:
-
-	•	MAJOR: Breaking changes that may affect compatibility.
-	•	MINOR: New features or improvements that are backward compatible.
-	•	PATCH: Bug fixes and minor improvements that are backward compatible.
-
-Each section lists the changes in chronological order, with the most recent release at the top. We also include links to relevant discussions or issues when appropriate.
-
-## [1.1.0] - 2024-11-21
-### Added
-- New Commands:
-  - `optikit flutter-update-version`: Update the version and build numbers for both Android and iOS, with support for automatic versioning and build number management.
-  - `optikit flutter-build-ios`: Build the Flutter iOS app for release, with support for FVM and automatic version incrementing
-  - `optikit flutter-build-ipa`: Create a release IPA for the Flutter app, with support for FVM and automatic version incrementing.
-
-## [1.0.0] - 2024-11-18
-### Added
-- Initial release of the CLI tool with the following commands:
-  - `optikit generate module <module_name>`
-  - `optikit clean-flutter`
-  - `optikit clean-ios`
-  - `optikit flutter-build-apk`
-  - `optikit flutter-build-bundle`
-  - `optikit open-android`
-  - `optikit open-ios`
-- Support for version handling using Semantic Versioning (SemVer).
-
-## [0.1.0] - 2024-10-15
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181814.md

@@ -1,4 +0,0 @@
-
-## [0.1.0] - 2024-10-15
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181815.md

@@ -1,3 +0,0 @@
-## [0.1.0] - 2024-10-15
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181821.md

@@ -1,3 +0,0 @@
-## [0.1.0]
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181824.md

@@ -1,3 +0,0 @@
-## [1.1.0]
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181825.md

@@ -1,3 +0,0 @@
-## [1.0.0]
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202181827.md

@@ -1,3 +0,0 @@
-## [1.0.0]
-### Added
-- Initial prototype with basic CLI command structure.

package/.history/CHANGELOG_20250202224530.md

@@ -1,34 +0,0 @@
-# Changelog
-
-All notable changes to this project are documented in this file. Each release includes details about new features, improvements, bug fixes, and any breaking changes. This changelog helps users and developers track the evolution of the project and understand how different versions may impact their use of the tool.
-
-We follow Semantic Versioning (SemVer) to indicate the nature of changes:
-
-	•	MAJOR: Breaking changes that may affect compatibility.
-	•	MINOR: New features or improvements that are backward compatible.
-	•	PATCH: Bug fixes and minor improvements that are backward compatible.
-
-Each section lists the changes in chronological order, with the most recent release at the top. We also include links to relevant discussions or issues when appropriate.
-
-## [1.1.0] - 2024-11-21
-### Added
-- New Commands:
-  - `optikit flutter-update-version`: Update the version and build numbers for both Android and iOS, with support for automatic versioning and build number management.
-  - `optikit flutter-build-ios`: Build the Flutter iOS app for release, with support for FVM and automatic version incrementing
-  - `optikit flutter-build-ipa`: Create a release IPA for the Flutter app, with support for FVM and automatic version incrementing.
-
-## [1.0.0] - 2024-11-18
-### Added
-- Initial release of the CLI tool with the following commands:
-  - `optikit generate module <module_name>`
-  - `optikit clean-flutter`
-  - `optikit clean-ios`
-  - `optikit flutter-build-apk`
-  - `optikit flutter-build-bundle`
-  - `sheno open-android`
-  - `sheno open-ios`
-- Support for version handling using Semantic Versioning (SemVer).
-
-## [0.1.0] - 2024-10-15
-### Added
-- Initial prototype with basic CLI command structure.