Add comprehensive JSDoc comments and refactor variable names

The update significantly improves code clarity and readability by adding comprehensive JSDoc comments to classes, functions, and variables across multiple files. In addition, it includes refactoring of parameters and variables for consistent naming conventions and precise type clarity with the introduction of explicit typing. The file initialize.js was also renamed to Initialize.js to maintain codebase consistency and adhere to naming standards.

lib/Database.js

@@ -3,6 +3,12 @@ const { getConnectionSettings } = require('./utils');
 const mysqldump = require('mysqldump');
 const fs = require('fs').promises;
 
+/**
+ * Constructor for the Database class.
+ *
+ * @class Database
+ * @param {WPMMconfig} config - The configuration object.
+ */
 class Database {
   /**
    * A description of the entire function.

lib/Dump.js

@@ -2,13 +2,32 @@ const fs = require('fs');
 const path = require('path');
 const { geVarFromPHPFile } = require('./utils');
 
+/**
+ * Represents a Dump class for WordPress configuration.
+ *
+ * @class Dump
+ */
 class Dump {
-  constructor () {W
+  /**
+   * Constructor for the class.
+   *
+   * Initializes the class with the necessary folders for WordPress.
+   */
+  constructor () {
     this.wpFolder = process.cwd();
     this.themeFolder = path.join(this.wpFolder, 'wp-content', 'themes');
     this.pluginsFolder = path.join(this.wpFolder, 'wp-content', 'plugins');
   }
 
+  /**
+   * Initializes the function by logging the `wpFolder` 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`,
+   * determining the language using `Intl.DateTimeFormat().resolvedOptions().locale`,
+   * and saving the result to a JSON file.
+   *
+   * @return {void}
+   */
   init () {
     console.log(this.wpFolder);
     console.log(this.themeFolder);
@@ -41,6 +60,12 @@ class Dump {
     console.log(`🆗 Wordpress configuration Dump completed. Configuration saved to ${outputPath}`);
   }
 
+  /**
+   * 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.
+   */
   scanDirectory (directory) {
     const items = fs.readdirSync(directory);
     const result = [];
@@ -76,12 +101,24 @@ class Dump {
     return result;
   }
 
+  /**
+   * Extracts the version number from a style file.
+   *
+   * @param {string} filePath - The path to the style file.
+   * @return {string|null} The version number extracted from the style file, or null if no match was found.
+   */
   extractVersionFromStyleFile (filePath) {
     const content = fs.readFileSync(filePath, 'utf8');
     const match = /Version:\s*([\d.]+)/i.exec(content);
     return match ? match[1] : null;
   }
 
+  /**
+   * Extracts the version number from a PHP file.
+   *
+   * @param {string} filePath - The path to the PHP file.
+   * @return {string|null} The version number extracted from the file, or null if no version is found.
+   */
   extractVersionFromPHPFile (filePath) {
     const content = fs.readFileSync(filePath, 'utf8');
     const match = /Version:\s*([\d.]+)/i.exec(content);

lib/Initialize.js

@@ -1,9 +1,19 @@
 const fs = require('fs');
 const path = require('path');
 
+/**
+ * Initialize class for generating WordPress configuration file.
+ *
+ * @class Initialize
+ */
 class Initialize {
-  constructor (options) {
-    this.options = options || {};
+  /**
+   * Constructor for a new instance of the class.
+   *
+   * @param {WPMMconfig} config - Optional configuration options.
+   */
+  constructor (config) {
+    this.options = config || {};
     this.wpFolder = process.cwd();
     this.outputPath = path.join(this.wpFolder, 'wp-package.json');
   }

lib/Installer.js

@@ -4,7 +4,9 @@ const { cleanup, makeDir } = require('./utils/fs.js');
 const { WordPressPackage, PluginPackage, ThemePackage } = require('./package');
 
 /**
- * The wpmm class represents the WordPress installer and provides methods for installing WordPress and its dependencies.
+ * The Installer class represents the WordPress installer and provides methods for installing WordPress and its dependencies.
+ *
+ * @class Installer
  */
 class Installer {
   /**

lib/Package.js

@@ -14,13 +14,18 @@ const {
 } = require('./utils/fs');
 
 /**
- * @typedef {Object} WPMMpaths - the object containing the paths
- * @property {string} rootFolder - the root folder of the application
- * @property {string} tempDir - the temporary directory
- * @property {string} baseFolder - the script base directory
+ * @typedef {Object} WPMMpaths - The object containing the paths
+ * @property {string} rootFolder - The root folder of the application
+ * @property {string} tempDir - The temporary directory
+ * @property {string} baseFolder - The path to the WordPress folder. Defaults to the current working directory.
  * @property {string} destFolder - The destination folder for package installation.
  */
 
+/**
+ * Represents a package and provides methods to download and install it.
+ *
+ * @class Package
+ */
 class Package {
   /**
    * Constructs a new instance of the class.
@@ -121,7 +126,7 @@ class Package {
   /**
    * Installs a package with the given name, version, and type.
    *
-   * @param config - The configuration object.
+   * @param {WPMMconfig} config - The configuration object.
    * @param {string} packageType - The type of the package ('theme' or 'plugin').
    * @return {Promise<void>} - A promise that resolves once the package is downloaded and installed.
    */

lib/PluginPackage.js

@@ -1,5 +1,11 @@
 const Package = require('./package');
 
+/**
+ * Represents a theme package.
+ *
+ * @class PluginPackage
+ * @extends Package
+ */
 export class PluginPackage extends Package {
   /**
    * Asynchronously installs a plugin.

lib/ThemePackage.js

@@ -1,5 +1,11 @@
 const Package = require('./package');
 
+/**
+ * Represents a theme package.
+ *
+ * @class ThemePackage
+ * @extends Package
+ */
 export class ThemePackage extends Package {
   /**
    * Installs a package with the specified name and version as a theme.

lib/Updater.js

@@ -1,11 +1,28 @@
 const { exec } = require('child_process');
 
+/**
+ * Represents the Updater class.
+ *
+ * @class Updater
+ */
 class Updater {
+  /**
+   * Constructs a new instance of the class.
+   *
+   * @param {WPMMconfig} config - the configuration object
+   */
   constructor (config) {
     // Load configuration from wp-package.json
     this.config = config;
   }
 
+  /**
+   * Update plugins.
+   *
+   * @async
+   * @function updatePlugins - Updates plugins using the `wp plugin install` command.
+   * @throws {Error} If there is an error updating the plugins.
+   */
   async updatePlugins () {
     try {
       const plugins = this.config.plugins;
@@ -31,6 +48,11 @@ class Updater {
     }
   }
 
+  /**
+   * Updates the themes in the configuration by installing and activating them.
+   *
+   * @return {void}
+   */
   async updateThemes () {
     try {
       const themes = this.config.themes;
@@ -56,6 +78,11 @@ class Updater {
     }
   }
 
+  /**
+   * Updates the WordPress installation.
+   *
+   * @return {Promise} A promise that resolves when the update is complete.
+   */
   async updateWordPress () {
     try {
       const command = 'wp core update';

lib/WpPackage.js

@@ -1,9 +1,15 @@
 const { getWordPressDownloadUrl, replaceDbConstant, replaceDbConstantBool, replaceEmptySalts } = require('./utils/index.js');
 const path = require('path');
-const fs = require('lib/utils/fs');
+const fs = require('fs');
 const { renameFolder } = require('./utils/fs');
 const Package = require('./package');
 
+/**
+ * Represents a WordPress package that can be installed and configured.
+ *
+ * @class WpPackage
+ * @extends Package
+ */
 export class WpPackage extends Package {
   /**
    * Installs WordPress with the specified version and language.

lib/index.js

@@ -8,13 +8,13 @@ const Initialize = require('./initialize.js');
 const yargs = require('yargs');
 const { hideBin } = require('yargs/helpers');
 
-// Get the arguments from the command line
+/** @var {yargs} argv - The command line arguments. */
 const argv = yargs(hideBin(process.argv)).argv;
 
-// Get the config
+/** @var {WPMMconfig} config - The configuration object for the script. */
 const config = getConfig(argv);
 
-// Start the timer
+/** @var {number} startTime - the time at which the script started. */
 const startTime = Date.now();
 
 const actions = {

lib/utils/index.js

@@ -188,6 +188,13 @@ async function installNpmPackages (packageDirectory) {
   });
 }
 
+/**
+ * Installs composer dependencies and generates autoloader based on composer.json file.
+ *
+ * @param {string} repoPath - The path to the repository where composer.json is located.
+ *
+ * @returns {Promise} - A promise resolving when the installation process is completed.
+ */
 async function installComposer (repoPath) {
   console.log('🎻 Found composer.json');
   await exec('composer install --no-dev', { cwd: repoPath });
@@ -287,6 +294,12 @@ function getInfo (config, actions) {
   console.log('🚀 Command line available actions: ' + JSON.stringify(actionsKeys, null, 2));
 }
 
+/**
+ * Logs the time passed in milliseconds since the given start time.
+ *
+ * @param {number} startTime - The start time in milliseconds.
+ * @return {undefined}
+ */
 function printTimePassed (startTime) {
   // End the timer
   const endTime = Date.now();