evophp 1.0.19 → 1.0.21

package/README.md

@@ -0,0 +1,134 @@
+# EvoPHP
+
+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.
+
+---
+
+## 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
+
+### 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.
+
+### Install EvoPHP
+To install EvoPHP globally, run:
+```bash
+npm install -g evophp
+```
+
+This command makes the `evophp` CLI available system-wide.
+
+---
+
+## Getting Started
+
+### Initialize a New Project
+To create and set up a new project, run:
+```bash
+evophp init <project-name>
+```
+Example:
+```bash
+evophp init my-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:
+```bash
+cd my-project
+```
+
+To start your project:
+```bash
+npm run start
+```
+
+---
+
+### Install a Plugin or Theme
+To install a plugin or theme, use the following command:
+```bash
+evophp install <plugin|theme> <author/repository-name>
+```
+Example:
+```bash
+evophp install plugin kinsokafor/eEdu
+```
+
+The command will fetch the specified plugin or theme and set it up for use.
+
+---
+
+### Create a New Plugin or Theme
+To create a new plugin or theme, use:
+```bash
+evophp new <plugin|theme> <author/repository-name>
+```
+Example:
+```bash
+evophp new plugin kinsokafor/MyAwesomePlugin
+```
+
+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:
+```bash
+npm run --i plugin
+```
+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`).
+
+---
+
+## 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.
+
+---
+
+### 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.

package/new-plugin.js

@@ -5,7 +5,7 @@ const path = require('path');
 const fs = require('fs');
 const axios = require('axios');
 const helpersPath = path.resolve(__dirname, 'helpers.js');
-const { readLineAsync, splitPluginName } = require(helpersPath);
+const { readLineAsync, splitpluginName } = require(helpersPath);
 
 (async () => {
     try {
@@ -29,7 +29,7 @@ const { readLineAsync, splitPluginName } = require(helpersPath);
         }
 
         // Validate name and split it into author and item name
-        const [author, itemName] = await splitPluginName(name);
+        const [author, pluginName] = await splitpluginName(name);
 
         // Validate PAT by checking the authenticated user's username
         const userData = await getUserData(gitHubToken);
@@ -48,34 +48,107 @@ const { readLineAsync, splitPluginName } = require(helpersPath);
             console.log("Creating a new plugin (EvoPlugin and EvoPlugin.js)...");
 
             // Create repository for EvoPlugin
-            await createGitHubRepo(gitHubToken, templateRepo, itemName);
+            await createGitHubRepo(gitHubToken, templateRepo, pluginName);
 
             // Clone the newly created repositories
-            cloneDir = path.join('Public', 'Modules', itemName);
-            await cloneRepository(author, itemName, cloneDir);
+            cloneDir = path.join('Public', 'Modules', pluginName);
+            await cloneRepository(author, pluginName, cloneDir);
 
             // Create repository for EvoPlugin.js (plugin.js)
             templateRepo = 'kinsokafor/EvoPlugin.js';
-            await createGitHubRepo(gitHubToken, templateRepo, `${itemName}.js`);
+            await createGitHubRepo(gitHubToken, templateRepo, `${pluginName}.js`);
 
             // Clone the newly created repositories
-            cloneDir = path.join('EvoJsDev', 'Modules', itemName);
-            await cloneRepository(author, itemName, cloneDir);
+            cloneDir = path.join('EvoJsDev', 'Modules', pluginName);
+            await cloneRepository(author, pluginName, cloneDir);
+
+            var pluginPrefix = await readLineAsync("Enter Plugin Prefix?");
+            while(!test(pluginPrefix, 3)) {
+                pluginPrefix = await readLineAsync("Enter Plugin Prefix?");
+            }
+            pluginPrefix = pluginPrefix.trim().replaceAll(" ", "").toUpperCase()
+
+            var entryURI = await readLineAsync("Entry URI?");
+            while(!test(entryURI, 20)) {
+                entryURI = await readLineAsync("Entry URI?");
+            }
+            entryURI = entryURI.trim().replaceAll(" ", "").toLowerCase()
+
+            const entry = pluginPrefix + "Main"
+
+            await editFile(`./EvoJsDev/Modules/${pluginName}/config.json`, {
+                pluginName: pluginName,
+                entry: entry
+            }).then(file => {
+                try {
+                    fs.rename(`./EvoJsDev/Modules/${pluginName}/Entry`, 
+                    `./EvoJsDev/Modules/${pluginName}/${entry}`, function(err) {
+                        if ( err ) console.error('ERROR: ' + err);
+                    });
+                } catch(e) {}
+                
+                const configFile = path.resolve(__dirname, `./EvoJsDev/Modules/${pluginName}/config.json`)
+                if (fs.existsSync(configFile)) {
+                    const pluginConfig = require(configFile)
+                    mergeConfig(pluginConfig)
+                }
+            })
+
+            await editFile(`./Public/Modules/${pluginName}/Routes.php`, {
+                pluginName: pluginName,
+                entry: entry,
+                entryURI: entryURI,
+                pluginPrefix: pluginPrefix
+            })
+            
+            if (fs.existsSync(path.resolve(__dirname, `./Public/Modules/${pluginName}/Controller.php`))) {
+                await editFile(`./Public/Modules/${pluginName}/Controller.php`, {
+                    pluginName: pluginName,
+                    pluginPrefix: pluginPrefix
+                }).then(file => {
+                    
+                    fs.rename(`./Public/Modules/${pluginName}/Controller.php`, 
+                    `./Public/Modules/${pluginName}/${pluginPrefix}Controller.php`, function(err) {
+                        if ( err ) console.error('ERROR: ' + err);
+                    });
+                    
+                    fs.rename(`./Public/Modules/${pluginName}/Views/Entry`, 
+                    `./Public/Modules/${pluginName}/Views/${entry}`, function(err) {
+                        if ( err ) console.error('ERROR: ' + err);
+                    });
+                })
+            }
 
         } else if (type === 'theme') {
             templateRepo = 'kinsokafor/EvoTheme';  // Theme template
             console.log("Creating a new theme (EvoTheme)...");
 
             // Create repository for EvoTheme
-            await createGitHubRepo(gitHubToken, templateRepo, itemName);
+            await createGitHubRepo(gitHubToken, templateRepo, pluginName);
 
             // Clone the newly created repositories
-            cloneDir = path.join('Public', 'Themes', itemName);
-            await cloneRepository(author, itemName, cloneDir);
+            cloneDir = path.join('Public', 'Themes', pluginName);
+            await cloneRepository(author, pluginName, cloneDir);
+
+            await editFile(`./Public/Themes/${pluginName}/Data/index.data.php`, {
+                pluginName: pluginName
+            })
+    
+            await editFile(`./Public/Themes/${pluginName}/Data/login.data.php`, {
+                pluginName: pluginName
+            })
+    
+            await editFile(`./Public/Themes/${pluginName}/Views/index.blade.php`, {
+                pluginName: pluginName
+            })
+    
+            await editFile(`./Public/Themes/${pluginName}/Views/login.blade.php`, {
+                pluginName: pluginName
+            })
         }
         
 
-        console.log(`The ${type} "${itemName}" has been set up successfully!`);
+        console.log(`The ${type} "${pluginName}" has been set up successfully!`);
 
     } catch (error) {
         console.error("An error occurred while setting up the plugin or theme:", error.message);
@@ -84,12 +157,12 @@ const { readLineAsync, splitPluginName } = require(helpersPath);
 })();
 
 // Function to create a repository from a template
-async function createGitHubRepo(token, templateRepo, itemName) {
+async function createGitHubRepo(token, templateRepo, pluginName) {
     try {
         const response = await axios.post(
             `https://api.github.com/repos/${templateRepo}/generate`,
             {
-                name: itemName,
+                name: pluginName,
                 private: false,  // Set to true if you want the repository to be private
                 description: `A new ${templateRepo.split('/')[1]} created from template.`,
             },
@@ -102,7 +175,7 @@ async function createGitHubRepo(token, templateRepo, itemName) {
         );
 
         if (response.status === 201) {
-            console.log(`Successfully created the repository: ${itemName} from ${templateRepo}`);
+            console.log(`Successfully created the repository: ${pluginName} from ${templateRepo}`);
         } else {
             console.error('Failed to create the repository:', response.data);
             process.exit(1);
@@ -114,22 +187,22 @@ async function createGitHubRepo(token, templateRepo, itemName) {
 }
 
 // Function to clone the newly created repository
-async function cloneRepository(author, itemName, cloneDir) {
+async function cloneRepository(author, pluginName, cloneDir) {
     try {
         // Ensure directories do not exist before cloning
         if (fs.existsSync(cloneDir)) {
-            console.log(`The plugin "${itemName}" already exists in the directory. Exiting.`);
+            console.log(`The plugin "${pluginName}" already exists in the directory. Exiting.`);
             process.exit(0);
         }
         
-        const cloneUrl = `https://github.com/${author}/${itemName}.git`;
+        const cloneUrl = `https://github.com/${author}/${pluginName}.git`;
 
         console.log(`Cloning the newly created repository from GitHub...`);
         execSync(`git clone ${cloneUrl} ${cloneDir}`, { stdio: 'inherit' });
 
-        console.log(`Cloned the repository ${itemName} successfully.`);
+        console.log(`Cloned the repository ${pluginName} successfully.`);
     } catch (error) {
-        console.error(`Error cloning the repository ${itemName}:`, error.message);
+        console.error(`Error cloning the repository ${pluginName}:`, error.message);
         process.exit(1);
     }
 }
@@ -149,3 +222,28 @@ async function getUserData(token) {
         process.exit(1);
     }
 }
+
+const editFile = async (file, data) => {
+    return new Promise((resolve, reject) => {
+        fs.readFile(file, 'utf8', (err, fileData) => {
+            if (err) {
+              console.error('Error reading color scheme file:', err);
+              reject(err)
+              return;
+            }
+            for(var i in data) {
+                fileData = fileData.replaceAll(`<${i}>`, data[i])
+            }
+            // Write the content to the destination file
+            fs.writeFile(file, fileData, 'utf8', (err) => {
+              if (err) {
+                console.error('Error writing color scheme file:', err);
+                reject(err)
+                return;
+              }
+              console.log(`${file} file created successfully.`);
+              resolve(file);
+            });
+        });
+    })      
+}

package/package.json

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