wp-advads 1.0.22 → 1.0.25

package/src/commands/release/composer.js

@@ -1,37 +1,29 @@
 /**
  * External Dependencies
  */
-import fs from 'fs';
 import logSymbols from 'log-symbols'
 
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js';
+import { pluginData } from '../release.js';
 import { heading, execCommand, onSameLine } from "../../utilities/index.js"
 
 /**
  * Execute routine
  */
-export function updateComposer(next) {
+export default function updateComposer(next) {
     heading('Updating composer')
 
     process.stderr.write('Dumping....')
 
-    if (fs.existsSync('./vendor')) {
-        fs.rmSync('./vendor', { recursive: true, force: true });
-    }
-
-    if (fs.existsSync('./packages')) {
-        fs.rmSync('./packages', { recursive: true, force: true });
-    }
-
-    execCommand('composer install -o -a -n --no-dev --no-scripts', function() {
-        fs.renameSync('./vendor', './packages')
-        execCommand('composer install --no-scripts', function() {
+    execCommand('composer build', function(stdout, error, stderr) {
+        if(stderr.includes('not defined')) {
+            onSameLine(`${logSymbols.error} Command "build" is not defined.`)
+        } else {
             pluginData.commitMessages.push('update 3rd party dependecies and composer dump-autoloader')
             onSameLine(`${logSymbols.success} composer updated`)
-            next()
-        })
+        }
+        next()
     })
 }

package/src/commands/release/git.js

@@ -6,9 +6,8 @@ import logSymbols from 'log-symbols'
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js';
-import { execCommand, onSameLine } from "../../utilities/index.js"
-
+import { pluginData } from '../release.js'
+import { execCommand, onSameLine, getSetting } from "../../utilities/index.js"
 
 /**
  * Get latest tag from GitHub
@@ -18,7 +17,8 @@ export function getLatestTag() {
         try {
             execCommand('git rev-list --tags --max-count=1', function(tags) {
                 execCommand( 'git describe --tags ' + tags.trim(), function(version) {
-                    resolve(version.trim())
+                    version = version.trim()
+                    resolve( '' !== version ? version : getSetting( 'wp.version', '0.0.0' ) )
                 } )
             })
         }
@@ -93,27 +93,7 @@ export function verifyNextVersion(next) {
 export function getCurrentBranchName(next) {
     execCommand('git rev-parse --abbrev-ref HEAD', function(result) {
         pluginData.gitCurrentBranch = result.trim()
-        next()
-    })
-}
 
-/**
- * Create new branch with the release version
- */
-export function createReleaseBranch(next) {
-    const message = 'Creating release branch'
-    const version = pluginData.semver.getNextVersionString()
-    process.stdout.write(`${message}....`)
-
-    execCommand(`git checkout -b release/v${version}`, function(result, error, stderr) {
-        if (stderr.includes('fatal:') && stderr.includes('already exists')) {
-            onSameLine(`${logSymbols.error} Branch named: release/v${version} already exists.`)
-            return next(true)
-        }
-
-        execCommand(`git push --set-upstream origin release/v${version}`, function(result) {
-            onSameLine(`${logSymbols.success} Release branch created`)
-            next()
-        })
+        next()
     })
 }

package/src/commands/release/github.js

@@ -7,15 +7,14 @@ import logSymbols from 'log-symbols'
 /**
  * Internal Dependencies
  */
+import { pluginData } from '../release.js'
 import { execCommand, heading, onSameLine } from "../../utilities/index.js"
 import {
     hasPermission,
     gitFetch,
     verifyNextVersion,
-    getCurrentBranchName,
-    createReleaseBranch
+    getCurrentBranchName
 } from './git.js'
-import { pluginData } from './index.js'
 
 /**
  * Execute routine
@@ -29,7 +28,6 @@ export function githubPreTasks(next) {
             gitFetch,
             verifyNextVersion,
             getCurrentBranchName,
-            createReleaseBranch
         ],
         ( err, results ) => {
             if(err) {

package/src/commands/release/prompts.js

@@ -6,7 +6,7 @@ import inquirer from 'inquirer'
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js';
+import { pluginData } from '../release.js'
 
 /**
  * Execute routine

package/src/commands/release/semver.js

@@ -7,7 +7,7 @@ import logSymbols from 'log-symbols'
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js';
+import { pluginData } from '../release.js'
 import { getLatestTag } from './git.js'
 import { heading, onSameLine } from "../../utilities/index.js"
 
@@ -176,7 +176,7 @@ class SemVer {
 /**
  * Execute routine
  */
-export function getSemVer(next) {
+export default function getSemVer(next) {
     heading('Calculating next version')
 
     process.stdout.write('Fetching latest version from github....')

package/src/commands/release/translations.js

@@ -6,44 +6,22 @@ import logSymbols from 'log-symbols'
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js'
-import { heading, execCommand } from "../../utilities/index.js"
+import { pluginData } from '../release.js'
+import { heading, execCommand, getSetting } from "../../utilities/index.js"
 
 /**
- * Execute routine to generate POT files
+ * Execute routine to download translations from GlotPress
  */
-export function wpPot( next ) {
-    const rootPath = process.cwd()
-    const { wpPot = {} } = pluginData
-    const {output, file, domain, exclude = [] } = wpPot
+export default function updateTranslations( next ) {
+    heading('Downloading translations from glotpress')
 
-    heading('Creating POT file')
+    const glotpress = getSetting('wp.glotpress')
 
-    try {
-        exclude.push(".github")
-        exclude.push(".husky")
-        exclude.push(".wordpress-org")
-        exclude.push("node_modules")
-        exclude.push("tools")
-        exclude.push("vendor")
-        execCommand(
-            [ 'wp', 'i18n', 'make-pot', rootPath, `${rootPath}${output}${file} --domain=${domain} --exclude=${exclude.join(',')}` ].join(' '),
-            () => {
-                pluginData.commitMessages.push('update POT file')
-                console.log( logSymbols.success + ' POT file successfully generated!' )
-                next()
-            }
-        )
-    } catch {
-        throw new Error( logSymbols.error + ' Error' )
+    if (!glotpress) {
+        console.log( logSymbols.warning + ' No glotpress project found' )
+        next()
+        return;
     }
-}
-
-/**
- * Execute routine to download translations from GlotPress
- */
-export function updateTranslations( next ) {
-    heading('Downloading translations from glotpress')
 
     execCommand( 'npm run translations -- --no-console', function(locales) {
         locales = locales.split('\n').slice(4).slice(0,-1)

package/src/commands/release.js

@@ -0,0 +1,55 @@
+/**
+ * External Dependencies
+ */
+import chalk from 'chalk'
+import { waterfall } from 'async'
+import logSymbols from 'log-symbols'
+
+/**
+ * Node dependencies
+ */
+import { heading } from '../utilities/index.js'
+
+/**
+ * Internal Dependencies
+ */
+import prompts from './release/prompts.js'
+import getSemVer from './release/semver.js'
+import { githubPreTasks, githubFinalTasks } from './release/github.js'
+import updateTranslations from './release/translations.js'
+import updateComposer from './release/composer.js'
+import updateChangelog from './release/changelog.js'
+import updateVersionNumber from './release/change-version.js'
+
+export const pluginData = {
+    commitMessages: [],
+    changelogChanges: false
+}
+
+export default async () => {
+    heading('Releasing the plugin...')
+    console.log('------------------------------------------------');
+
+    waterfall(
+        [
+            prompts,
+            getSemVer,
+            githubPreTasks,
+            updateTranslations,
+            updateComposer,
+            updateVersionNumber,
+            updateChangelog,
+            githubFinalTasks
+        ],
+        ( err, results ) => {
+            if (err) {
+                console.log('');
+                console.log( `${logSymbols.error} ${chalk.bold.red(`We failed somewhere! Work hard mate...`)}` )
+                return
+            }
+
+            console.log('');
+            console.log( `${logSymbols.success} ${chalk.bold.green(`All done!`)}` )
+        }
+    )
+}

package/src/commands/updates.js

@@ -0,0 +1,31 @@
+/**
+ * Node Dependencies
+ */
+import path from 'path';
+import fs from 'fs-extra';
+
+/**
+ * Internal Dependencies
+ */
+import { getSetting, writeFile, heading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+
+export default (version) => {
+	heading('Creating update file...')
+
+	try {
+		const filename = `upgrade-${version}.php`;
+		const folder = path.join(getProjectRoot(), getSetting('paths.updates'));
+
+		// Data
+		const data = getSetting();
+		data.heading = `Update routine for version ${version}`;
+		data.version = version.replaceAll('.', '_');
+
+		const content = compileTemplate(getTemplateFile('files/update.php'), data);
+		writeFile(folder,filename, content)
+	}
+	catch (err) {
+		msgErrorTitle('We failed!!!');
+		throw err;
+	}
+}

package/src/commands/views.js

@@ -0,0 +1,31 @@
+
+/**
+ * Node Dependencies
+ */
+import path from 'path';
+
+/**
+ * Internal Dependencies
+ */
+import { getSetting, writeFile, heading, filenameToHeading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+
+export default (name, header) => {
+	heading('Creating view file...')
+
+	try {
+		const paths = name.toLowerCase().split('/')
+		const filename = paths.pop() + '.php';
+		const folder = path.join(getProjectRoot(), getSetting('paths.views'), paths.join('/'));
+
+		// Data
+		const data = getSetting();
+		data.heading = header || filenameToHeading(filename) + ' template file';
+
+		const content = compileTemplate(getTemplateFile('files/view.php'), data);
+		writeFile(folder, filename, content);
+	}
+	catch (err) {
+		msgErrorTitle('We failed!!!');
+		throw err;
+	}
+}

package/src/utilities/filesystem.js

@@ -0,0 +1,148 @@
+/**
+ * External dependencies
+ */
+import chalk from 'chalk';
+import logSymbols from 'log-symbols';
+import template from 'lodash/template.js';
+
+/**
+ * Node dependencies
+ */
+import path from 'path';
+import fs from 'fs-extra';
+
+/**
+ * Internal Dependencies
+ */
+import { write, msgSuccessOnSameLine, onSameLine } from './formatting.js'
+
+let projectRoot = null
+
+/**
+ * Get the root folder of the project by searching for a known root file (e.g., package.json).
+ *
+ * @throws {Error} - Throws an error if the root folder cannot be found.
+ *
+ * @param {string} startDir - The directory to start searching from. Defaults to the current directory.
+ *
+ * @returns {string} - The absolute path to the project root folder.
+ */
+export function getProjectRoot(startDir = process.cwd()) {
+	if (projectRoot) {
+		return projectRoot;
+	}
+
+	projectRoot = startDir;
+
+	while (projectRoot !== path.parse(projectRoot).root) {
+		const possibleRootFile = path.join(projectRoot, 'wp.advads');
+		if (fs.existsSync(possibleRootFile)) {
+			return projectRoot;
+		}
+
+		// Move up one directory level
+		projectRoot = path.dirname(projectRoot);
+  }
+
+  throw new Error('Project root not found. Make sure there is a wp.advads file in the root directory.');
+}
+
+/**
+ * Retrieves the path to the template folder.
+ *
+ * This function uses `createRequire` to resolve the path to the `../../template` directory
+ * relative to the current module's URL and removes the `/index.js` part from the resolved path.
+ *
+ * @returns {string} The path to the template folder.
+ */
+export function getTemplateFolder() {
+    const dirname = path.dirname(import.meta.url.replace('file://', ''))
+    return path.join(dirname, '../../template')
+}
+
+/**
+ * Retrieves the path to the specified template file.
+ *
+ * @param {string} file - The name of the file to retrieve.
+ *
+ * @returns {string} The path to the specified template file.
+ */
+export function getTemplateFile( file ) {
+	return path.join( getTemplateFolder(), file )
+}
+
+/**
+ * Compiles a template file with the provided data.
+ *
+ * @param {string} filename - The path to the template file.
+ * @param {Object} data - The data to be used in the template.
+ *
+ * @returns {string} - The compiled template with the data.
+ */
+export function compileTemplate( filename, data ) {
+	const fileContent = fs.readFileSync(filename, 'utf-8');
+	const compiled = template(fileContent,{ interpolate: /{{([\s\S]+?)}}/g });
+
+	return compiled(data);
+}
+
+/**
+ * Deletes a specified file if it exists.
+ *
+ * @param {string} name - The name of the file to be deleted.
+ * @param {string} file - The path to the file to be deleted.
+ *
+ * @returns {void}
+ */
+export function deleteFile(name, file) {
+    if ( ! fs.existsSync(file) ) {
+        console.log( `${logSymbols.error} ${chalk.red(`${name} file not found!`)}` )
+        return
+    }
+
+    fs.rmSync(file)
+    console.log( `${logSymbols.success} ${chalk.dim(`${name} deleted!`)}` )
+}
+
+/**
+ * Updates the content of a specified file.
+ *
+ * @param {string} fileName - The name of the file to update.
+ * @param {Object} messages - The messages to display during the update process.
+ * @param {Function} next - The callback function to call after the update process is complete.
+ * @param {Function} callback - The callback function to process the file content.
+ *
+ * @returns {void}
+ */
+export function updateFileContent(fileName, messages, next, callback) {
+    process.stdout.write(messages.updating)
+
+    fs.readFile(fileName, (err, buffer) => {
+        if ( null !== err ) {
+            onSameLine(`${logSymbols.error} ${messages.failed}`)
+            return next()
+        }
+
+        const content = callback(buffer.toString())
+
+        fs.writeFile(fileName, content, (err) => {
+            if ( null !== err ) {
+                onSameLine(`${logSymbols.error} ${messages.failed}`)
+                return next()
+            }
+
+            onSameLine(`${logSymbols.success} ${messages.updated}`)
+            next()
+        })
+    })
+}
+
+export function writeFile(folder, filename, content) {
+	write('Creating directories!!');
+	fs.ensureDirSync(folder);
+	msgSuccessOnSameLine('Directories created successfully');
+
+	write('Creating file!!');
+	fs.writeFileSync(path.join(folder, filename), content);
+	msgSuccessOnSameLine('File created successfully');
+}

package/src/utilities/formatting.js

@@ -36,8 +36,12 @@ export function onNewLine(text) {
  * @returns {void}
  */
 export function onSameLine(text) {
-    process.stdout.clearLine()
-    process.stdout.cursorTo(0)
+	if (process.stdout.clearLine) {
+		process.stdout.clearLine(); // Clear the current line
+		process.stdout.cursorTo(0);  // Move the cursor to the start of the line
+		// process.stdout.write(message);
+	}
+
     console.log(text)
 }
 

package/src/utilities/index.js

@@ -1,7 +1,6 @@
-export * from './cache.js'
-export * from './command.js'
-export * from './file.js'
-export * from './folder.js'
+export * from './filesystem.js'
 export * from './formatting.js'
-export * from './shell.js'
 export * from './semver.js'
+export * from './settings.js'
+export * from './shell.js'
+export * from './misc.js'

package/src/utilities/misc.js

@@ -0,0 +1,12 @@
+/**
+ * External Dependencies
+ */
+import capitalize from 'lodash/capitalize.js';
+
+export function filenameToHeading(filename) {
+	filename = filename.replace('.php', '');
+	filename = filename.replace('.js', '');
+	filename = filename.replace(/-/g, ' ');
+
+	return capitalize(filename);
+}

package/src/utilities/semver.js

@@ -20,7 +20,7 @@ export class SemVer {
         return this.rawVersion
     }
 
-    inc(type) {
+    increment(type) {
         const nextVersion = { ...this.baseVersion }
         nextVersion[type] += 1
 
@@ -38,3 +38,8 @@ export class SemVer {
         return `${version.major}.${version.minor}.${version.patch}`
     }
 }
+
+export function incrementVersion(version, type) {
+	const semver = new SemVer(version)
+	return semver.increment(type)
+}

package/src/utilities/settings.js

@@ -0,0 +1,94 @@
+/**
+ * External dependencies
+ */
+import get from 'lodash/get.js'
+import set from 'lodash/set.js'
+
+/**
+ * Node dependencies
+ */
+import fs from 'fs'
+import path from 'path'
+
+/**
+ * Internal Dependencies
+ */
+import { getProjectRoot } from './filesystem.js'
+
+let settings = null
+
+/**
+ * Checks if the configuration file exists at the specified path.
+ *
+ * @returns {boolean} True if the configuration file exists, false otherwise.
+ */
+export function configFileExists() {
+	try {
+		const configPath = path.join(getProjectRoot(), 'wp.advads')
+		return fs.existsSync(configPath);
+	} catch (err) {
+		return false;
+	}
+}
+
+/**
+ * Read JSON data from the config file asynchronously.
+ *
+ * @returns {Object} - JSON data from the file.
+ */
+export function readConfigFile() {
+	try {
+		const configPath = path.join(getProjectRoot(), 'wp.advads')
+		const data = fs.readFileSync(configPath, 'utf-8');
+		return JSON.parse(data);
+	} catch (err) {
+		return {};
+	}
+}
+
+/**
+ * Save config file
+ *
+ * @param {Object} data - The data object to save
+ */
+export function saveConfig(data) {
+	process.stdout.write('Saving config file...');
+	try {
+		const savePath = path.join(process.cwd(), 'wp.advads')
+		const jsonData = JSON.stringify(data, null, 2);
+		fs.writeFileSync(savePath, jsonData);
+		settings = data;
+	} catch (err) {
+		process.stdout.write('Error writing config file:', err);
+		throw err;
+	}
+}
+
+/**
+ * Get setting from the config file
+ *
+ * @param {string} key - The key to get the value for
+ * @param {string} defaultVal - The default value to return if key is not found
+ *
+ * @returns {string} - The value of the key
+ */
+export function getSetting(key = 'all', defaultVal = '') {
+	if (!settings) {
+		settings = readConfigFile();
+	}
+
+	if ( 'all' === key ) {
+		return settings;
+	}
+
+	return get( settings, key, defaultVal );
+}
+
+export function updateSetting(key, value) {
+	if (!settings) {
+		settings = readConfigFile();
+	}
+
+	settings = set(settings, key, value);
+	saveConfig(settings);
+}

package/src/utilities/shell.js

@@ -8,6 +8,15 @@ import { exec, spawn } from 'node:child_process'
  */
 import { onSameLine } from './formatting.js'
 
+/**
+ * Run a command in the terminal.
+ *
+ * @param {string} command Command to run
+ * @param {string[]} args Arguments to pass
+ * @param {Function} callback Callback function
+ *
+ * @returns {void}
+ */
 export function runCommand( command, args, callback ) {
     const commandSpawn = spawn( command, args, {
         shell: true,
@@ -27,6 +36,14 @@ export function runCommand( command, args, callback ) {
     })
 }
 
+/**
+ * Execute a command in the terminal.
+ *
+ * @param {string} command Command to execute
+ * @param {Function} callback Callback function
+ *
+ * @returns {void}
+ */
 export function execCommand( command, callback ) {
 	if ('string' !== typeof command) {
 		command = command.join(' ')

package/template/files/class-empty.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * {{heading}}.
+ * {{description}}
+ *
+ * @since   {{wp.version}}
+ * @package {{misc.package}}
+ * @author  {{author.name}} <{{author.email}}>
+ */
+
+namespace {{misc.package}}{{namespace}};
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * {{heading}} class.
+ */
+class {{className}} {
+
+	/**
+	 * Constructor.
+	 */
+	public function __construct() {
+		// Add your code here.
+	}
+}