evophp 1.0.29 → 1.0.30

package/README.md

@@ -1,18 +1,20 @@
-# EvoPHP
+# EvoPHP CLI - Comprehensive Guide
 
-EvoPHP is a command-line tool designed to simplify the creation, installation, and management of plugins, themes, and projects using Evolution by Kins Okafor. Whether you are starting a new project or extending functionality with plugins and themes, EvoPHP provides the tools you need to get up and running quickly.
+## Overview
+EvoPHP CLI is a command-line interface designed to simplify the development and management of projects, plugins, and themes within the EvoPHP ecosystem. With intuitive commands and shorthands, developers can quickly set up projects, manage dependencies, and handle plugin/theme creation and installation with ease.
 
 ---
 
 ## Table of Contents
-1. [Installation](#installation)
-2. [Getting Started](#getting-started)
-    - [Initialize a New Project](#initialize-a-new-project)
-    - [Install a Plugin or Theme](#install-a-plugin-or-theme)
-    - [Create a New Plugin or Theme](#create-a-new-plugin-or-theme)
-3. [Plugin Development](#plugin-development)
-4. [Troubleshooting](#troubleshooting)
-5. [License](#license)
+- [Installation](#installation)
+- [All Commands](#all-commands)
+  - [Initialization](#initialization)
+  - [Plugin/Theme Creation](#plugintheme-creation)
+  - [Plugin/Theme Installation](#plugintheme-installation)
+  - [Plugin/Theme Uninstallation](#plugintheme-uninstallation)
+  - [Dependency Management](#dependency-management)
+- [Notes](#notes)
+- [Further Documentation](#further-documentation)
 
 ---
 
@@ -21,7 +23,7 @@ EvoPHP is a command-line tool designed to simplify the creation, installation, a
 ### Prerequisites
 Ensure the following are installed on your system:
 - **Node.js**: Verify by running `node -v` and `npm -v`.
-- **Composer** (optional): For managing PHP dependencies.
+- **Composer**: For managing PHP dependencies.
 
 ### Install EvoPHP
 To install EvoPHP globally, run:
@@ -33,102 +35,118 @@ This command makes the `evophp` CLI available system-wide.
 
 ---
 
-## Getting Started
+## All Commands
 
-### Initialize a New Project
-To create and set up a new project, run:
+### Initialization
 ```bash
-evophp init <project-name>
-```
-Example:
-```bash
-evophp init my-project
+evophp init ?<project-name>
 ```
+- Initialize a new project.
+- Examples:
+  ```bash
+  evophp init
+  evophp init example-project
+  ```
 
-This will:
-1. Clone the EvoPHP repository into a folder named `<project-name>`.
-2. Run `node evolution` with the project name as an argument.
-3. Install Composer dependencies (if a `composer.json` file exists).
-4. Install Node.js dependencies using `npm install`.
+---
 
-After setup, navigate to your project folder:
+### Plugin/Theme Creation
 ```bash
-cd my-project
+evophp n | new plugin | theme <author>/<name>
 ```
+- Create a new plugin or theme.
+- Examples:
+  - Plugin:
+    ```bash
+    evophp new plugin example-author/example-plugin
+    evophp n plugin example-author/example-plugin
+    ```
+  - Theme:
+    ```bash
+    evophp new theme example-author/example-theme
+    evophp n theme example-author/example-theme
+    ```
+
+---
 
-To start your project:
+### Plugin/Theme Installation
 ```bash
-npm run start
+evophp i | install plugin | theme <author>/<name>
 ```
+- Install a plugin or theme.
+- Examples:
+  - Plugin:
+    ```bash
+    evophp install plugin example-author/example-plugin
+    evophp i plugin example-author/example-plugin
+    ```
+  - Theme:
+    ```bash
+    evophp install theme example-author/example-theme
+    evophp i theme example-author/example-theme
+    ```
 
 ---
 
-### Install a Plugin or Theme
-To install a plugin or theme, use the following command:
+### Plugin/Theme Uninstallation
 ```bash
-evophp install <plugin|theme> <author/repository-name>
+evophp u | uninstall plugin | theme <plugin-name>
 ```
-Example:
-```bash
-evophp install plugin kinsokafor/eEdu
-```
-
-The command will fetch the specified plugin or theme and set it up for use.
+- Uninstall a plugin or theme.
+- Examples:
+  - Plugin:
+    ```bash
+    evophp uninstall plugin example-plugin
+    evophp u plugin example-plugin
+    ```
+  - Theme:
+    ```bash
+    evophp uninstall theme example-theme
+    evophp u theme example-theme
+    ```
 
 ---
 
-### Create a New Plugin or Theme
-To create a new plugin or theme, use:
+### Dependency Management
 ```bash
-evophp new <plugin|theme> <author/repository-name>
+evophp d | install-dependencies <plugin-name>
 ```
-Example:
+- Install npm production dependencies.
+- Examples:
+  ```bash
+  evophp install-dependencies example-plugin
+  evophp d example-plugin
+  ```
+
+#### Development Dependencies
 ```bash
-evophp new plugin kinsokafor/MyAwesomePlugin
+evophp d | install-dependencies <plugin-name> --dev | --save-dev
 ```
-
-You will be prompted to provide additional details like:
-- The entry URI.
-- A unique 3-character plugin prefix.
-
----
-
-## Plugin Development
-
-### Creating a Plugin
-To create your own plugin:
-1. Use the [EvoPlugin GitHub template](https://github.com/kinsokafor/EvoPlugin) and click "Use this template."
-2. Name your repository (e.g., `ExamplePlugin`).
-3. Use the [EvoPlugin.js GitHub template](https://github.com/kinsokafor/EvoPlugin.js) for the JavaScript counterpart. Name it similarly, adding `.js` to the end (e.g., `ExamplePlugin.js`).
-
-### Installing Your Plugin
-To install your new plugin:
+- Install npm development dependencies.
+- Examples:
+  ```bash
+  evophp install-dependencies example-plugin --dev
+  evophp d example-plugin --dev
+  ```
+
+#### Composer Dependencies
 ```bash
-npm run --i plugin
+evophp d | install-dependencies <plugin-name> --composer
 ```
-You will be prompted for:
-- Plugin name (e.g., `kinsokafor/ExamplePlugin`).
-- Entry URI (e.g., `example-plugin`).
-- Unique 3-character plugin prefix (e.g., `ex1`).
+- Install composer dependencies.
+- Examples:
+  ```bash
+  evophp install-dependencies example-plugin --composer
+  evophp d example-plugin --composer
+  ```
 
 ---
 
-## Troubleshooting
-
-- **Permission Issues**: On Linux/macOS, use `sudo` for commands requiring elevated permissions.
-- **Node.js Installation**: Verify installation using `node -v` and `npm -v`.
-- **Versioning Conflicts**: If updating, increment the version in `package.json`.
-
----
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+## Notes
+- `<author>` must be a valid GitHub username.
+- `<name>` must be a unique repository name (not already existing on GitHub).
 
 ---
 
-### Key Features of This Version:
-1. **Clear Commands**: All commands are listed with syntax, examples, and expected results.
-2. **Plugin Development**: Detailed instructions for creating and managing plugins.
-3. **Troubleshooting Section**: Practical solutions to common issues.
-4. **User-Friendly Layout**: A clean structure with headings and examples for easy navigation.
+## Further Documentation
+For additional details, best practices, and advanced usage, please refer to the [official EvoPHP documentation](#).

package/install-dependencies.js

@@ -1,76 +1,149 @@
 #!/usr/bin/env node
 
-const { execSync } = require('child_process');
-const fs = require('fs');
-const path = require('path');
-const { readLineAsync } = require('./helpers');
+const { execSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+const { readLineAsync } = require("./helpers");
 
 (async () => {
-    try {
-        let [, , pluginName, ...args] = process.argv;
-
-        if (!pluginName) {
-            console.error("Please specify the plugin or theme name.");
-            process.exit(1);
-        }
-
-        // Check if flags for prod or dev are provided
-        const isProd = true;
-        const isDev = args.includes('--save-dev');
-
-        if (!isProd && !isDev) {
-            console.error("Please specify either '--prod' or '--dev' as flags.");
-            process.exit(1);
-        }
-
-        const depType = isProd ? 'prod' : 'dev';
-
-        const pluginPath = path.join('EvoJsDev', 'Modules', pluginName);
-
-        if (!fs.existsSync(pluginPath)) {
-            console.error(`Plugin "${pluginName}" not found in ${pluginPath}.`);
-            process.exit(1);
-        }
-
-        const dependenciesFile = path.join(pluginPath, 'dependencies.json');
-        let dependencies = {};
-
-        // If dependencies.json exists, read its content
-        if (fs.existsSync(dependenciesFile)) {
-            dependencies = JSON.parse(fs.readFileSync(dependenciesFile, 'utf-8'));
-        }
-
-        console.log(`Current dependencies in dependencies.json for ${pluginName}:`);
-        console.log("Production dependencies:", dependencies.prod || "None");
-        console.log("Development dependencies:", dependencies.dev || "None");
-
-        // Prompt user for additional dependencies
-        const additionalDeps = await readLineAsync(`Enter additional ${depType} dependencies (comma separated): `);
-        const newDeps = additionalDeps.split(',').map(dep => dep.trim()).filter(dep => dep);
-
-        // Add new dependencies to the respective array
-        if (newDeps.length) {
-            dependencies[depType] = (dependencies[depType]
-                ? dependencies[depType] + ' ' + newDeps.join(' ')
-                : newDeps.join(' ')).trim().split(' ').filter((value, index, array) => array.indexOf(value) === index).join(' ');
-        }
-
-        // Write updated dependencies to dependencies.json
-        fs.writeFileSync(dependenciesFile, JSON.stringify(dependencies, null, 2), 'utf-8');
-        console.log("Updated dependencies.json successfully.");
-
-        // Install the new dependencies
-        if (newDeps.length) {
-            const installCommand = depType === 'prod' 
-                ? `npm install ${newDeps.join(' ')} --save`   // For prod dependencies
-                : `npm install ${newDeps.join(' ')} --save-dev`; // For dev dependencies
-            console.log(`Installing ${depType} dependencies...`);
-            execSync(installCommand, { stdio: 'inherit' });
-        }
-
-        console.log("Dependencies installed successfully.");
-    } catch (error) {
-        console.error("An error occurred:", error.message);
+  try {
+    let [, , pluginName, ...args] = process.argv;
+
+    if (!pluginName) {
+      console.error("Please specify the plugin or theme name.");
+      process.exit(1);
+    }
+
+    // Check if flags for prod or dev are provided
+
+    const depType =
+      args.includes("--dev") ?? args.includes("--save-dev") ? "dev" : "prod";
+
+    if (args.includes("--composer")) {
+        const pluginPath = path.join("EvoJsDev", "Modules", pluginName);
+
+      if (!fs.existsSync(pluginPath)) {
+        console.error(`Plugin "${pluginName}" not found in ${pluginPath}.`);
+        process.exit(1);
+      }
+
+      const dependenciesFile = path.join(pluginPath, "dependencies.json");
+      let dependencies = {};
+      // If dependencies.json exists, read its content
+      if (fs.existsSync(dependenciesFile)) {
+        dependencies = JSON.parse(fs.readFileSync(dependenciesFile, "utf-8"));
+      }
+
+      console.log(
+        `Current php dependencies in dependencies.json for ${pluginName}:`
+      );
+      console.log("Production dependencies:", dependencies.prod || "None");
+
+      // Prompt user for additional dependencies
+      const additionalDeps = await readLineAsync(
+        `Enter additional ${depType} dependencies (space separated): `
+      );
+      const newDeps = additionalDeps
+        .split(" ")
+        .map((dep) => dep.trim())
+        .filter((dep) => dep);
+
+      // Add new dependencies to the respective array
+      if (newDeps.length) {
+        dependencies.prod = (
+          dependencies.prod
+            ? dependencies.prod + " " + newDeps.join(" ")
+            : newDeps.join(" ")
+        )
+          .trim()
+          .split(" ")
+          .filter((value, index, array) => array.indexOf(value) === index)
+          .join(" ");
+      }
+
+      // Write updated dependencies to dependencies.json
+      fs.writeFileSync(
+        dependenciesFile,
+        JSON.stringify(dependencies, null, 2),
+        "utf-8"
+      );
+      console.log("Updated dependencies.json successfully.");
+
+      // Install the new dependencies
+      if (newDeps.length) {
+        const installCommand = `composer require ${newDeps.join(" ")}`
+        console.log(`Installing ${depType} dependencies...`);
+        execSync(installCommand, { stdio: "inherit" });
+      }
+
+      console.log("Dependencies installed successfully.");
+
+    } else {
+      const pluginPath = path.join("EvoJsDev", "Modules", pluginName);
+
+      if (!fs.existsSync(pluginPath)) {
+        console.error(`Plugin "${pluginName}" not found in ${pluginPath}.`);
         process.exit(1);
+      }
+
+      const dependenciesFile = path.join(pluginPath, "dependencies.json");
+      let dependencies = {};
+
+      // If dependencies.json exists, read its content
+      if (fs.existsSync(dependenciesFile)) {
+        dependencies = JSON.parse(fs.readFileSync(dependenciesFile, "utf-8"));
+      }
+
+      console.log(
+        `Current dependencies in dependencies.json for ${pluginName}:`
+      );
+      console.log("Production dependencies:", dependencies.prod || "None");
+      console.log("Development dependencies:", dependencies.dev || "None");
+
+      // Prompt user for additional dependencies
+      const additionalDeps = await readLineAsync(
+        `Enter additional ${depType} dependencies (space separated): `
+      );
+      const newDeps = additionalDeps
+        .split(" ")
+        .map((dep) => dep.trim())
+        .filter((dep) => dep);
+
+      // Add new dependencies to the respective array
+      if (newDeps.length) {
+        dependencies[depType] = (
+          dependencies[depType]
+            ? dependencies[depType] + " " + newDeps.join(" ")
+            : newDeps.join(" ")
+        )
+          .trim()
+          .split(" ")
+          .filter((value, index, array) => array.indexOf(value) === index)
+          .join(" ");
+      }
+
+      // Write updated dependencies to dependencies.json
+      fs.writeFileSync(
+        dependenciesFile,
+        JSON.stringify(dependencies, null, 2),
+        "utf-8"
+      );
+      console.log("Updated dependencies.json successfully.");
+
+      // Install the new dependencies
+      if (newDeps.length) {
+        const installCommand =
+          depType === "prod"
+            ? `npm install ${newDeps.join(" ")} --save` // For prod dependencies
+            : `npm install ${newDeps.join(" ")} --save-dev`; // For dev dependencies
+        console.log(`Installing ${depType} dependencies...`);
+        execSync(installCommand, { stdio: "inherit" });
+      }
+
+      console.log("Dependencies installed successfully.");
     }
+  } catch (error) {
+    console.error("An error occurred:", error.message);
+    process.exit(1);
+  }
 })();

package/install-plugin.js

@@ -89,6 +89,21 @@ const fs = require('fs');
             } else {
                 console.log("No dependencies.json found. Skipping dependency installation.");
             }
+
+            // Check for dependencies.json in the .js plugin path
+            const phpDependenciesFile = path.join(paths[0], 'dependencies.json');
+            if (fs.existsSync(phpDependenciesFile)) {
+                console.log("Found dependencies.json. Installing php dependencies...");
+                const dependencies = JSON.parse(fs.readFileSync(phpDependenciesFile, 'utf-8'));
+
+                // Install production dependencies
+                if (dependencies.prod) {
+                    console.log("Installing production dependencies...");
+                    execSync(`composer require ${dependencies.prod}`, { stdio: 'inherit', cwd: process.cwd() });
+                }
+            } else {
+                console.log("No php dependencies.json found. Skipping dependency installation.");
+            }
         } else if (type === 'theme') {
             // Clone the theme repository
             const themeRepoURL = `https://github.com/${author}/${itemName}.git`;

package/installer.js

@@ -59,7 +59,7 @@ let [, , command, type, name] = process.argv;
       // sample command 
       // evophp (d | install-dependencies) <plugin-name> ?(--save-dev | --save)
       const args = name ? [name] : [];
-      console.log(args)
+
       name = type;
       if (!name) {
         console.error("Please specify the name of the plugin.");
@@ -148,16 +148,72 @@ let [, , command, type, name] = process.argv;
         console.error(`Error initializing project: ${error.message}`);
         process.exit(1);
       }
+    } else if (command === "help" || command === "h") {
+      console.log(`
+        ==========================================
+                EvoPHP CLI - Help Guide
+        ==========================================
+
+        All Commands:
+          Initialization:
+            evophp init ?<project-name>                      
+                Initialize a new project.
+                - Example: evophp init
+                - Example: evophp init example-project
+
+          Plugin/Theme Creation:
+            evophp n | new plugin | theme <author>/<name>    
+                Create a new plugin or theme.
+                - Example (plugin): evophp new plugin example-author/example-plugin
+                - Example (theme): evophp new theme example-author/example-theme
+                - Example (plugin shorthand): evophp n plugin example-author/example-plugin
+                - Example (theme shorthand): evophp n theme example-author/example-theme
+
+          Plugin/Theme Installation:
+            evophp i | install plugin | theme <author>/<name> 
+                Install a plugin or theme.
+                - Example (plugin): evophp install plugin example-author/example-plugin
+                - Example (theme): evophp install theme example-author/example-theme
+                - Example (plugin shorthand): evophp i plugin example-author/example-plugin
+                - Example (theme shorthand): evophp i theme example-author/example-theme
+
+          Plugin/Theme Uninstallation:
+            evophp u | uninstall plugin | theme <plugin-name> 
+                Uninstall a plugin or theme.
+                - Example (plugin): evophp uninstall plugin example-plugin
+                - Example (theme): evophp uninstall theme example-theme
+                - Example (plugin shorthand): evophp u plugin example-plugin
+                - Example (theme shorthand): evophp u theme example-theme
+
+          Dependency Management:
+            evophp d | install-dependencies <plugin-name> 
+                Install npm production dependencies.
+                - Example: evophp install-dependencies example-plugin
+                - Example (shorthand): evophp d example-plugin
+
+            evophp d | install-dependencies <plugin-name> --dev | --save-dev 
+                Install npm development dependencies.
+                - Example: evophp install-dependencies example-plugin --dev
+                - Example (shorthand): evophp d example-plugin --dev
+
+            evophp d | install-dependencies <plugin-name> --composer 
+                Install composer dependencies.
+                - Example: evophp install-dependencies example-plugin --composer
+                - Example (shorthand): evophp d example-plugin --composer
+
+        ==========================================
+        Notes:
+        - <author> must be a valid GitHub username.
+        - <name> must be a unique repository name (not already existing on GitHub).
+
+        For further details, visit the official EvoPHP documentation.
+        ==========================================
+
+        `);        
+      process.exit(1);
     } else {
       console.error(`Unknown command: "${command}".`);
-      console.log(`
-        Usage:
-          i | install <type> <name>         Install a plugin or theme
-          u | uninstall <type> <name>       Uninstall a plugin or theme
-          n | new <type> <name>             Create a new plugin or theme
-          d | install-dependencies <name> --save | --save-dev       Install dependencies
-          init <name>                       Initialize a new project
-        `);
+      console.log(`run evophp help for list of all acceptable commands.`);
       process.exit(1);
     }
   } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evophp",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "description": "Installer for the Evolution PHP project",
   "main": "installer.js",
   "scripts": {