evophp 1.0.31 → 1.1.1

package/README.md

@@ -1,152 +1,175 @@
 # EvoPHP CLI - Comprehensive Guide
 
 ## 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
-- [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)
+
+* [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)
+* [Authentication & PAT Storage](#authentication--pat-storage)
+* [Further Documentation](#further-documentation)
 
 ---
 
 ## Installation
 
 ### Prerequisites
+
 Ensure the following are installed on your system:
-- **Node.js**: Verify by running `node -v` and `npm -v`.
-- **Composer**: For managing PHP dependencies.
+
+* **Node.js**: Verify with `node -v` and `npm -v`
+* **Composer**: Required for PHP dependencies
 
 ### Install EvoPHP
-To install EvoPHP globally, run:
+
 ```bash
 npm install -g evophp
 ```
 
-This command makes the `evophp` CLI available system-wide.
+This makes the `evophp` CLI available globally.
 
 ---
 
 ## All Commands
 
 ### Initialization
+
 ```bash
-evophp init ?<project-name>
+evophp init [project-name]
 ```
-- Initialize a new project.
-- Examples:
+
+* Initializes a new EvoPHP project.
+* Examples:
+
   ```bash
   evophp init
-  evophp init example-project
+  evophp init my-project
   ```
 
 ---
 
 ### Plugin/Theme Creation
+
 ```bash
-evophp n | new plugin | theme <author>/<name>
+evophp new plugin <name>
+evophp new theme <name>
+evophp n plugin <name>
+evophp n theme <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
-    ```
+
+* Creates a new plugin or theme from a template.
+
+* Supports:
+
+  * Just `<name>` → Uses your GitHub account (token required)
+  * `<author>/<name>` → Creates in the specified GitHub account
+
+* Examples:
+
+  ```bash
+  evophp new plugin MyPlugin              # Uses your GitHub
+  evophp n plugin johndoe/BlogEnhancer    # Uses johndoe's GitHub
+  ```
 
 ---
 
 ### Plugin/Theme Installation
+
 ```bash
-evophp i | install plugin | theme <author>/<name>
+evophp install plugin <name>
+evophp install theme <name>
+evophp i plugin <name>
+evophp i theme <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
-    ```
+
+* Installs a plugin or theme from GitHub into your project.
+
+* Supports:
+
+  * Just `<name>` → Clones from your GitHub account (token required)
+  * `<author>/<name>` → Clones from public GitHub repo (no token required)
+
+* Examples:
+
+  ```bash
+  evophp install plugin MyPlugin
+  evophp i theme johndoe/EvoTheme
+  ```
 
 ---
 
 ### Plugin/Theme Uninstallation
+
 ```bash
-evophp u | uninstall plugin | theme <plugin-name>
+evophp uninstall plugin <name>
+evophp uninstall theme <name>
+evophp u plugin <name>
+evophp u theme <name>
 ```
-- 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
-    ```
+
+* Removes the installed plugin or theme from the project.
+
+* Examples:
+
+  ```bash
+  evophp uninstall plugin MyPlugin
+  evophp u theme EvoTheme
+  ```
 
 ---
 
 ### Dependency Management
+
 ```bash
-evophp d | install-dependencies <plugin-name>
+evophp install-dependencies <plugin-name>
+evophp d <plugin-name>
 ```
-- Install npm production dependencies.
-- Examples:
-  ```bash
-  evophp install-dependencies example-plugin
-  evophp d example-plugin
-  ```
 
-#### Development Dependencies
+* Adds or installs plugin dependencies.
+
+#### Production (npm):
+
 ```bash
-evophp d | install-dependencies <plugin-name> --dev | --save-dev
+evophp d MyPlugin
 ```
-- Install npm development dependencies.
-- Examples:
-  ```bash
-  evophp install-dependencies example-plugin --dev
-  evophp d example-plugin --dev
-  ```
 
-#### Composer Dependencies
+#### Development (npm):
+
 ```bash
-evophp d | install-dependencies <plugin-name> --composer
+evophp d MyPlugin --dev
+```
+
+#### PHP (Composer):
+
+```bash
+evophp d MyPlugin --composer
 ```
-- Install composer dependencies.
-- Examples:
-  ```bash
-  evophp install-dependencies example-plugin --composer
-  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).
+## Authentication & PAT Storage
+
+When using a command with just `<name>` (e.g. `evophp new plugin MyPlugin`), EvoPHP CLI will:
+
+* Prompt you for a **GitHub Personal Access Token** (PAT) the first time
+* Automatically store it in `.env.development` for future use
+* Use that token to fetch your GitHub username and manage private/public repos
+
+> To change your token later, simply edit or delete `.env.development`.
 
 ---
 
 ## Further Documentation
-For additional details, best practices, and advanced usage, please refer to the [official EvoPHP documentation](#).
+
+More advanced use cases, templates, and configuration details coming soon at:
+📘 [Official EvoPHP Documentation](#)

package/bin/evophp.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+const yargs = require("yargs");
+const { hideBin } = require("yargs/helpers");
+
+yargs(hideBin(process.argv))
+  .command(require("../commands/init"))
+  .command(require("../commands/new"))
+  .command(require("../commands/install"))
+  .command(require("../commands/uninstall"))
+  .command(require("../commands/dependencies"))
+  .command(require("../commands/help"))
+  .demandCommand(1, "Please specify a valid command. Use --help to see available commands.")
+  .help()
+  .argv;
+

package/commands/dependencies.js

@@ -0,0 +1,80 @@
+const fs = require("fs");
+const path = require("path");
+const { execSync } = require("child_process");
+const { readLineAsync } = require("../utils/helpers");
+const log = require("../utils/logger");
+
+module.exports = {
+  command: "install-dependencies <plugin> [--dev|--composer]",
+  aliases: ["d"],
+  describe: "Add and install plugin or theme dependencies",
+
+  builder: yargs =>
+    yargs
+      .positional("plugin", { describe: "Plugin or theme name", type: "string" })
+      .option("dev", { describe: "Install as dev dependency (JS)", type: "boolean" })
+      .option("composer", { describe: "Use composer for PHP", type: "boolean" }),
+
+  handler: async ({ plugin, dev, composer }) => {
+    try {
+      const depType = dev ? "dev" : "prod";
+
+      const isPHP = !!composer;
+      const baseDir = isPHP
+        ? path.join("Public", "Modules", plugin)
+        : path.join("EvoJsDev", "Modules", plugin);
+
+      if (!fs.existsSync(baseDir)) {
+        log.error(`Plugin not found at ${baseDir}`);
+        process.exit(1);
+      }
+
+      const dependenciesFile = path.join(baseDir, "dependencies.json");
+      let dependencies = fs.existsSync(dependenciesFile)
+        ? JSON.parse(fs.readFileSync(dependenciesFile, "utf-8"))
+        : {};
+
+      log.info(`Existing ${isPHP ? "PHP" : "JS"} dependencies:`);
+      log.info("Production:", dependencies.prod || "None");
+      if (!isPHP) log.info("Development:", dependencies.dev || "None");
+
+      const additionalDeps = await readLineAsync(
+        `Enter additional ${depType} dependencies (space separated): `
+      );
+      const newDeps = additionalDeps
+        .split(" ")
+        .map(dep => dep.trim())
+        .filter(Boolean);
+
+      if (newDeps.length === 0) {
+        log.warn("No dependencies provided.");
+        return;
+      }
+
+      // Merge and deduplicate
+      const depField = isPHP || depType === "prod" ? "prod" : "dev";
+      dependencies[depField] = (
+        (dependencies[depField] || "") + " " + newDeps.join(" ")
+      )
+        .trim()
+        .split(" ")
+        .filter((value, i, arr) => arr.indexOf(value) === i)
+        .join(" ");
+
+      fs.writeFileSync(dependenciesFile, JSON.stringify(dependencies, null, 2));
+      log.success("Updated dependencies.json");
+
+      // Install
+      const installCmd = isPHP
+        ? `composer require ${newDeps.join(" ")}`
+        : `npm install ${newDeps.join(" ")} ${dev ? "--save-dev" : "--save"}`;
+
+      log.info("Installing dependencies...");
+      execSync(installCmd, { stdio: "inherit" });
+      log.success("Installation complete.");
+    } catch (err) {
+      log.error("Error installing dependencies: " + err.message);
+      process.exit(1);
+    }
+  }
+};

package/commands/help.js

@@ -0,0 +1,71 @@
+module.exports = {
+  command: "help",
+  aliases: ["h"],
+  describe: "Show all available EvoPHP CLI commands",
+
+  handler: () => {
+    console.log(`
+==========================================
+        EvoPHP CLI - Help Guide
+==========================================
+
+📦 Initialization:
+  evophp init [project-name]
+      → Initialize a new Evolution PHP project.
+      → Aliases: none
+      → Example: evophp init my-coop-project
+
+🛠️  Plugin & Theme Creation:
+  evophp new plugin <name>
+  evophp new theme <name>
+  evophp n plugin <name>
+  evophp n theme <name>
+      → Create a plugin or theme from template repo.
+      → Supports:
+         • just <name> → uses your GitHub account
+         • author/name → uses any GitHub account
+
+⬇️  Plugin & Theme Installation:
+  evophp install plugin <name>
+  evophp install plugin author/name
+  evophp i theme <name>
+  evophp i theme author/name
+      → Install a plugin or theme from GitHub into your project.
+      → Format options:
+         • just <name> → installs from your GitHub account
+         • author/name → installs from public GitHub repo
+
+🗑️  Plugin & Theme Uninstallation:
+  evophp uninstall plugin <name>
+  evophp uninstall theme <name>
+  evophp u plugin <name>
+  evophp u theme <name>
+      → Remove an installed plugin or theme and update config.
+
+🔧 Dependency Management:
+  evophp install-dependencies <plugin>
+  evophp d <plugin> [--dev|--composer]
+      → Add and install dependencies for a plugin:
+         --dev      → JavaScript development dependencies
+         --composer → PHP dependencies via Composer
+      → Aliases: install-dependencies → d
+
+🔐 GitHub Authentication:
+  When installing or creating with just <name>,
+  the CLI will prompt for your GitHub PAT and store it
+  in .env.development for future runs.
+
+❓ General:
+  evophp help
+  evophp h
+      → Show this help guide.
+      → Aliases: help → h
+
+==========================================
+  Tip: Use --help after any command
+       for more usage examples.
+==========================================
+    `);
+    process.exit(0);
+  }
+};

package/commands/init.js

@@ -0,0 +1,57 @@
+const fs = require("fs");
+const path = require("path");
+const { execSync } = require("child_process");
+const { readLineAsync } = require("../utils/helpers");
+const log = require("../utils/logger");
+
+module.exports = {
+  command: "init [name]",
+  describe: "Initialize a new EvoPHP project",
+
+  builder: yargs =>
+    yargs
+      .positional("name", {
+        describe: "Project folder name (optional)",
+        type: "string",
+        default: "",
+      }),
+
+  handler: async ({ name }) => {
+    try {
+      if (!name) {
+        name = await readLineAsync("Enter the name of the project: ");
+        if (!name.trim()) {
+          log.error("You must enter a valid project name.");
+          process.exit(1);
+        }
+      }
+
+      const repoUrl = "https://github.com/kinsokafor/evolution.git";
+      const projectPath = path.join(process.cwd(), name);
+
+      log.info(`Cloning Evolution repo to "${name}"...`);
+      execSync(`git clone ${repoUrl} ${name}`, { stdio: "inherit" });
+
+      process.chdir(projectPath);
+
+      log.info(`Running bootstrap script: node evolution ${name}`);
+      execSync(`node evolution ${name}`, { stdio: "inherit" });
+
+      if (fs.existsSync("composer.json")) {
+        log.info("Installing Composer dependencies...");
+        execSync("composer install", { stdio: "inherit" });
+      } else {
+        log.info("No composer.json found. Skipping Composer installation.");
+      }
+
+      log.info("Installing NPM dependencies...");
+      execSync("npm install", { stdio: "inherit" });
+
+      log.success("Project setup complete!");
+      log.info(`Navigate into your project:\n  cd ${name}`);
+    } catch (err) {
+      log.error("Project initialization failed: " + err.message);
+      process.exit(1);
+    }
+  }
+};

package/commands/install.js

@@ -0,0 +1,91 @@
+const path = require('path');
+const fs = require('fs');
+const { execSync } = require('child_process');
+const { readLineAsync, mergeConfig, saveToEnv } = require('../utils/helpers');
+const { getUserData } = require('../utils/github');
+const { cloneRepo } = require('../utils/git');
+const { installDependencies } = require('../utils/dependencies');
+const log = require('../utils/logger');
+require("dotenv").config({ path: "./.env.development" });
+
+module.exports = {
+  command: 'install [type] [name]',
+  aliases: ['i'],
+  describe: 'Install a plugin or theme',
+
+  builder: yargs => yargs
+    .positional('type', { describe: 'plugin or theme', type: 'string' })
+    .positional('name', { describe: 'name or author/name', type: 'string' }),
+
+  handler: async ({ type, name }) => {
+    try {
+      if (!type || !['plugin', 'theme'].includes(type.toLowerCase())) {
+        type = await readLineAsync("What are you installing? (plugin/theme): ");
+        type = type.toLowerCase();
+        if (!['plugin', 'theme'].includes(type)) {
+          log.error("Invalid type.");
+          process.exit(1);
+        }
+      }
+
+      if (!name) {
+        name = await readLineAsync(`Enter the ${type} name (e.g., myplugin or johndoe/myplugin): `);
+      }
+
+      let author, pluginName;
+      let gitHubToken = process.env.GITHUB_TOKEN;
+
+      if (name.includes("/")) {
+        // Full author/name provided — no auth required
+        [author, pluginName] = name.split("/");
+      } else {
+        // Token required to determine user
+        if (!gitHubToken) {
+          gitHubToken = await readLineAsync("Enter your GitHub Personal Access Token: ");
+          saveToEnv("GITHUB_TOKEN", gitHubToken);
+          log.success("GitHub token saved to .env.development");
+        }
+        const userData = await getUserData(gitHubToken);
+        author = userData.login;
+        pluginName = name;
+        log.info(`Authenticated as ${author}`);
+      }
+
+      const paths = type === 'plugin'
+        ? [path.join('Public', 'Modules', pluginName), path.join('EvoJsDev', 'Modules', pluginName)]
+        : [path.join('Public', 'Themes', pluginName)];
+
+      for (const p of paths) {
+        if (fs.existsSync(p)) {
+          log.warn(`${type} "${pluginName}" already exists at ${p}`);
+          process.exit(0);
+        }
+      }
+
+      log.info(`Installing ${type} "${pluginName}" from ${author}...`);
+
+      if (type === 'plugin') {
+        await cloneRepo(`${author}/${pluginName}`, null, paths[0]);
+        await cloneRepo(`${author}/${pluginName}.js`, null, paths[1]);
+
+        const configFile = path.resolve(`./EvoJsDev/Modules/${pluginName}/config.json`);
+        if (fs.existsSync(configFile)) {
+          const pluginConfig = require(configFile);
+          mergeConfig(pluginConfig);
+        }
+
+        await installDependencies(paths[1], 'js');
+        await installDependencies(paths[0], 'php');
+
+      } else if (type === 'theme') {
+        await cloneRepo(`${author}/${pluginName}`, null, paths[0]);
+      }
+
+      log.success(`The ${type} "${pluginName}" has been installed successfully.`);
+
+    } catch (err) {
+      log.error(`Install failed: ${err.message}`);
+      process.exit(1);
+    }
+  }
+};