Refactor and optimize WordPress installation configuration

The commit encompasses several important changes targeted towards WordPress package installation and configuration. It first optimizes the WpPackage.js file for more streamlined and efficient handling of WordPress installations. It also includes smarter parsing and generation of WordPress and other package config files. Furthermore, it enhances the database.js file to use better defined configurations. Major changes involve movement of parser-related functions to a new utils/parsers.js file, and inclusion of user prompts related to WordPress installation in a new utils/prompts.js file.

lib/Database.js

@@ -27,7 +27,7 @@ class Database {
    */
   dbDumpFilename = () => {
     const date = new Date().toDateString().replace(" ", "-");
-    return `${this.config.wordpress.config.DB_NAME}-${date}.sql.gz`;
+    return `${this.config.wordpress.WP_config.DB_NAME}-${date}.sql.gz`;
   };
 
   /**
@@ -49,7 +49,11 @@ class Database {
         return new Error('Database configuration not found');
       }
 
-      const databaseConnectionConfig = getConnectionSettings(this.config.wordpress.config);
+      /**
+       * the connection settings for the database
+       * @type {mysql.ConnectionOptions} databaseConnectionConfig - The connection settings for the database.
+       */
+      const databaseConnectionConfig = getConnectionSettings(this.config.wordpress.WP_config);
 
       /**
        * @type {import('mysql2/promise').Connection} connection - The MySQL connection object.
@@ -95,7 +99,7 @@ class Database {
 
     console.log(`✳️ Dumping database to ${dumpFile}...`);
 
-    if (!this.config.wordpress.config) {
+    if (!this.config.wordpress.WP_config) {
       return new Error('🔴 Database configuration not found');
     }
 
@@ -104,7 +108,7 @@ class Database {
      *
      * @type {mysqldump.ConnectionOptions} databaseConnectionConfig - The connection settings for the database.
      */
-    const databaseConnectionConfig = getConnectionSettings(this.config.wordpress.config);
+    const databaseConnectionConfig = getConnectionSettings(this.config.wordpress.WP_config);
 
     if (databaseConnectionConfig.host === 'localhost') {
       console.log('⚠️ Warning: You are using localhost as your database host. This may not work correctly.');

lib/Dump.js

@@ -1,7 +1,8 @@
 const fs = require('fs');
 const path = require('path');
-const { getCurrentWpInfo, getUserLocale, getLastWp } = require("./utils/wordpress.js");
-const {parseWpConfig, getWpConfigContent} = require("./utils/wordpress");
+const {getCurrentWpInfo} = require("./utils/wordpress.js");
+const {getWpConfigContent} = require("./utils/wordpress.js");
+const {parseWpConfig} = require("./utils/parsers.js");
 
 /**
  * Represents a Dump class for WordPress configuration.
@@ -13,50 +14,51 @@ class Dump {
    * Constructor for the class.
    *
    * Initializes the class with the necessary folders for WordPress.
+   * @param {import("./constants").WPMMpaths} paths - The object containing the paths for the WordPress installation.
    */
   constructor (paths) {
-    this.wpFolder = paths.baseFolder;
+    this.baseFolder = paths.baseFolder;
     this.themeFolder = paths.themeFolder;
     this.pluginsFolder = paths.pluginsFolder;
   }
 
   /**
-   * Initializes the function by logging the `wpFolder` and `themeFolder` properties,
+   * Initializes the function by logging the `baseFolder` and `themeFolder` properties,
    * scanning the theme and plugins directories, retrieving the website name from the
-   * `wpFolder` path, getting the WordPress version from `wp-includes/version.php`,
+   * `baseFolder` path, getting the WordPress version from `wp-includes/version.php`,
    * determining the language using `Intl.DateTimeFormat().resolvedOptions().locale`,
    * and saving the result to a JSON file.
    *
-   * @return {void}
+   * @return {Promise<import('./constants').WPMMconfig|{}>} - The configuration object.
    */
-  init() {
+  async init() {
     const themes = this.scanDirectory(this.themeFolder);
     const plugins = this.scanDirectory(this.pluginsFolder);
 
     // the website name
-    const name = path.basename(this.wpFolder);
+    const name = path.basename(this.baseFolder);
 
-    console.log(`🔍️ Scanning ${this.wpFolder}`);
+    console.log(`🔍️ Scanning ${this.baseFolder}`);
     /**
      * @type {{locale: string|null, version: string|null}}
      */
-    const wpInfo = getCurrentWpInfo(this.wpFolder);
+    const wpInfo = getCurrentWpInfo(this.baseFolder);
 
     const wpConfigData = parseWpConfig(
-      getWpConfigContent(this.wpFolder)
+      getWpConfigContent(this.baseFolder)
     );
 
-    const language = wpInfo.locale || getUserLocale();
-    const version = wpInfo.version || getLastWp()?.version || 'latest';
+    const version = wpInfo.version || 'latest';
+    const language = wpInfo.locale || 'en_US';
 
     const result = {
-      name,
       wordpress: {
+        name,
         version,
         language,
-        config: {
-          ...wpConfigData.constants,
-          ...wpConfigData.variables
+        WP_config: {
+          ...wpConfigData?.constants,
+          ...wpConfigData?.variables
         }
       },
       themes,
@@ -67,13 +69,15 @@ class Dump {
 
     fs.writeFileSync(outputPath, JSON.stringify(result, null, 2));
     console.log(`🆗 Wordpress configuration Dump completed. Configuration saved to ${outputPath}`);
+
+    return result;
   }
 
   /**
    * Scans a directory and returns an array of objects containing the name and version of each item found.
    *
    * @param {string} directory - The path of the directory to scan.
-   * @return {Array} - An array of objects with the name and version of each item found.
+   * @return {import('./constants').WPMMconfigPkg[]|null} - An array of objects with the name and version of each item found.
    */
   scanDirectory (directory) {
     // Check if the directory exists
@@ -83,7 +87,12 @@ class Dump {
     }
 
     const items = fs.readdirSync(directory);
-    const result = [];
+    /**
+     * The array of parsed items
+     *
+     * @type {import('./constants').WPMMconfigPkg[]} result
+     */
+    let result= [];
 
     for (const item of items) {
       const fullPath = path.join(directory, item);
@@ -113,7 +122,7 @@ class Dump {
       }
     }
 
-    return result;
+    return result.length ? result : null;
   }
 
   /**

lib/Initialize.js

@@ -37,9 +37,10 @@ class Initialize {
   /**
    * Generates the configuration file for WordPress.
    *
+   * @param {{version ?: string, language?: string}=} options - The options for the initialization.
    * @return {Promise<import('./constants.js').WPMMconfig>} The configuration object.
    */
-  async generateConfig() {
+  async generateConfig(options) {
 
     // check if the output path exists
     if (this.hasConfig()) {
@@ -48,15 +49,13 @@ class Initialize {
     }
 
     const name = this.wpFolder.split(path.sep).pop() || DefaultWpInstallFolder;
-    const lastWp = await getLastWp() ?? { version: 'latest' };
-    const userLocale = getUserLocale();
 
     return {
-      name,
       wordpress: {
-        version: lastWp?.version || 'latest',
-        language: userLocale,
-        config: DefaultWpConfig
+        name,
+        version: options?.version || (await getLastWp())?.version || 'latest',
+        language: options?.language || getUserLocale(),
+        'WP_config': DefaultWpConfig
       },
       database: {
         type: DefaultWpDatabaseType,
@@ -71,7 +70,7 @@ class Initialize {
   writeConfig = (/** @type {import('./constants.js').WPMMconfig} */ result) => {
     // write the config to the output path
     fs.writeFileSync(this.outputPath, JSON.stringify(result, null, 2));
-    console.log(`🆗 Wordpress configuration file created. Configuration saved to ${this.outputPath}`);
+    console.log(`🆗 WordPress configuration file created. Configuration saved to ${this.outputPath}`);
   };
 }
 

lib/Installer.js

@@ -39,21 +39,21 @@ class Installer {
 
     // Install WordPress
     if (wordpress) {
-      const wp = new WpPackage(this.config, 'wordpress', this.paths);
+      const wp = new WpPackage(this.config.wordpress, 'wordpress', this.paths);
       await wp.install();
     }
 
     if (plugins) {
       const pluginPackages = plugins.map((plugin) => new Package(plugin, 'plugin', this.paths));
       promises.push(...pluginPackages.map((pluginPackage) => pluginPackage.install().then(() => {
-        wpJson.plugins[pluginPackage.pkgInfo.name] =  pluginPackage.pkgInfo;
+        wpJson.plugins.push(pluginPackage.pkgInfo);
       })));
     }
 
     if (themes) {
       const themePackages = themes.map((theme) => new Package(theme, 'theme', this.paths));
       promises.push(...themePackages.map((themePackage) => themePackage.install().then(() => {
-        wpJson.themes[themePackage.pkgInfo.name] =  themePackage.pkgInfo;
+        wpJson.themes.push(themePackage.pkgInfo);
       })));
     }
 

lib/Package.js

@@ -18,14 +18,15 @@ const {
  * Represents a package and provides methods to download and install it.
  *
  * @class Package
+ * @template Package
  */
 class Package {
   /**
    * Constructs a new instance of the class.
    *
    * @param {import('./constants.js').WPMMconfigPkg} pkgConfig - the configuration object
    * @param {string} packageType - the type of package
-   * @param {{baseFolder: *}} paths - the object containing the paths
+   * @param {import('./constants.js').WPMMpaths} paths - the object containing the paths
    */
   constructor (pkgConfig, packageType, paths) {
     this.pkgInfo = pkgConfig;
@@ -53,7 +54,7 @@ class Package {
    * @param {import('./constants.js').WPMMpaths} paths - An array of paths.
    * @param {string} packageType - The type of package ('plugin' or 'theme').
    *
-   * @return {string|undefined} The destination folder path.
+   * @return {string} The destination folder path.
    */
   getDestFolder (paths, packageType) {
     if (packageType === 'plugin') {

lib/WpPackage.js

@@ -3,43 +3,35 @@ const fs = require('fs');
 const { renameFolder } = require('./utils/fs.js');
 
 const Package = require('./Package.js');
-const { replaceDbConstant, replaceDbConstantBool, replaceEmptySalts } = require('./utils/wordpress.js');
+const { replaceDbConstant, replaceDbConstantBool, replaceEmptySalts } = require('./utils/parsers.js');
 const { getWordPressDownloadUrl } = require('./utils/data.js');
 
 /**
  * Represents a WordPress package that can be installed and configured.
  *
  * @class WpPackage
- * @extends Package
+ * @extends Package<WpPackage> pkgConfig - the configuration object
  */
 class WpPackage extends Package {
 
   /**
-   * the constructor of the class
+   * Constructs a new instance of the class.
    * @param {import('./constants.js').WordpressPkg} pkgConfig - the configuration object
+   * @param {string} packageType - the type of package
    * @param {import('./constants.js').WPMMpaths} paths - the object containing the paths
    */
-  constructor (pkgConfig, paths) {
-    /**
-     * @type {import('./constants.js').WordpressPkg} pkgConfig - the configuration object
-     */
-    super(
-      pkgConfig,
-      'wordpress',
-      {
-        ...paths,
-        baseFolder: paths.baseFolder
-      }
-    );
+  constructor(pkgConfig, packageType, paths) {
+    super(pkgConfig, 'wordpress', paths);
+    this.pkgInfo = pkgConfig;
   }
 
   /**
    * Installs WordPress with the specified version and language.
    *
-   * @param {string} version - The version of WordPress to install.
-   * @param {string} language - The language of WordPress to install.
+   * @param {string=} version - The version of WordPress to install.
+   * @param {string=} language - The language of WordPress to install.
    */
-  async installWordPress (version, language) {
+  async installWordPress (version = 'latest', language = 'en_US') {
     const downloadUrl = getWordPressDownloadUrl(version, language);
 
     try {
@@ -83,13 +75,14 @@ class WpPackage extends Package {
       let configContent = fs.readFileSync(configPath, 'utf8');
 
       // Update database name, username, password, and other settings based on user-defined config
-      configContent = replaceDbConstant(configContent, 'DB_NAME', this.pkgInfo.wordpress.config.DB_NAME);
-      configContent = replaceDbConstant(configContent, 'DB_USER', this.pkgInfo.wordpress.config.DB_USER);
-      configContent = replaceDbConstant(configContent, 'DB_PASSWORD', this.pkgInfo.wordpress.config.DB_PASSWORD);
-      configContent = replaceDbConstant(configContent, 'DB_HOST', this.pkgInfo.wordpress.config.DB_HOST);
-      configContent = replaceDbConstant(configContent, 'DB_CHARSET', this.pkgInfo.wordpress.config.DB_CHARSET);
+      configContent = replaceDbConstant(configContent, 'DB_NAME', this.pkgInfo.WP_config.DB_NAME);
+      configContent = replaceDbConstant(configContent, 'DB_USER', this.pkgInfo.WP_config.DB_USER);
+      configContent = replaceDbConstant(configContent, 'DB_PASSWORD', this.pkgInfo.WP_config.DB_PASSWORD);
+      configContent = replaceDbConstant(configContent, 'DB_HOST', this.pkgInfo.WP_config.DB_HOST);
+      configContent = replaceDbConstant(configContent, 'DB_CHARSET', this.pkgInfo.WP_config.DB_CHARSET);
+
+      configContent = replaceDbConstantBool(configContent, 'WP_DEBUG', this.pkgInfo.WP_config.WP_DEBUG);
 
-      configContent = replaceDbConstantBool(configContent, 'WP_DEBUG', this.pkgInfo.wordpress.config.WP_DEBUG);
 
       configContent = replaceEmptySalts(configContent);
 
@@ -108,7 +101,7 @@ class WpPackage extends Package {
    * @returns {Promise<void>} A Promise that resolves when the installation and configuration are complete.
    */
   async install () {
-    const { version, language } = this.pkgInfo.wordpress;
+    const { version, language } = this.pkgInfo;
     await this.installWordPress(version, language);
     await this.setupWordPressConfig();
   }

lib/actions.js

@@ -62,27 +62,29 @@ function actions({config, paths}) {
     /** Dumps the current WordPress installation data. This function creates a new Dump instance and initializes it.*/
     dump: () => {
       const dump = new Dump(paths);
-      dump.init();
+      dump.init().then(() => {
+        console.log('🚀 All data dumped successfully.');
+      });
     },
 
     /** Dump the current WordPress database. */
     'dump-db': async () => {
-
       const db = new Database(config);
       await db.dumpDatabase(paths.baseFolder);
       console.log(`🚀 Database dumped successfully.`);
     },
 
     /** Dump the current WordPress database, plugins and themes setup. */
     'dump-all': () => {
-      wpmmActions["dump-db"]() || console.log('🚀 WP Database dumped successfully.');
-      wpmmActions.dump() || console.log('🚀 All data dumped successfully.');
+      wpmmActions["dump-db"]() &&
+      wpmmActions.dump() &&
+      console.log('🚀 All data dumped successfully.');
     },
 
     /** Upload a database by executing SQL queries from a specified file. */
     'upload-db': () => {
       const db = new Database(config);
-      db.uploadDatabase(config.wordpress.config.DB_NAME).then(() => {
+      db.uploadDatabase(config.wordpress.WP_config.DB_NAME).then(() => {
         console.log('🚀 Database uploaded successfully.');
       });
     },