wp-advads 1.0.31 → 1.0.34

package/src/commands/wp-glotpress.js

@@ -4,163 +4,162 @@
 import fs from 'fs';
 import chalk from 'chalk';
 import { resolve } from 'path';
-import eachSeries from 'async/eachSeries.js';
-
-/**
- * Internal Dependencies
- */
 import { heading, msgError, getSetting, write, msgSuccessOnSameLine, onSameLine, msgErrorOnSameLine } from "../utilities/index.js";
 
-class GlotPressDownloader {
-    baseURL = 'https://translate.wpadvancedads.com/api/projects';
+const BASE_URL = 'https://translate.wpadvancedads.com/api/projects';
 
-    run() {
-        heading('Downloading Translations from GlotPress...')
+export async function downloadTranslations() {
+    heading('Downloading Translations from GlotPress...')
 
-        try {
-            this.validateData();
-            this.maybeDirectory();
-			this.download();
-        } catch (error) {
-            msgError(error.message);
-            return;
-        }
+    try {
+        const ctx = readProject();
+        ensureDestination( ctx.destination );
+        return await downloadAll( ctx );
+    } catch (error) {
+        msgError(error.message);
+        throw error;
     }
+}
 
-    validateData() {
-        const glotpress = getSetting('glotpress')
-        write('Validating data...');
+export default () => {
+    downloadTranslations().catch(() => {});
+}
 
-        if (!glotpress) {
-            onSameLine('')
-            throw new Error('No glotpress project found');
-        }
+function readProject() {
+    const glotpress = getSetting('glotpress')
+    write('Validating data...');
 
-		if ('' === glotpress.project) {
-			throw new Error('The GlotPress project name is not defined.');
-		}
+    if (!glotpress) {
+        onSameLine('')
+        throw new Error('No glotpress project found');
+    }
+
+    if ('' === glotpress.project) {
+        throw new Error('The GlotPress project name is not defined.');
+    }
+
+    if (undefined === glotpress.destination || '' === glotpress.destination) {
+        throw new Error('The destination directory is not defined.');
+    }
+
+    const { project, destination } = glotpress;
+    const domain = getSetting('wpPot.domain');
 
-		if (undefined === glotpress.destination || '' === glotpress.destination) {
-			throw new Error('The destination directory is not defined.');
-		}
+    msgSuccessOnSameLine('Validation done');
+
+    return {
+        project,
+        potPrefix: domain ?? project,
+        destination,
+    }
+}
 
-		// Set data.
-		const { project, destination } = glotpress;
-		const domain = getSetting('wpPot.domain');
+function ensureDestination( destination ) {
+    write('Checking if destination directory exists...');
+    fs.mkdirSync(resolve(destination), { recursive: true });
+    msgSuccessOnSameLine('Directory exists');
+}
 
-		this.project = project;
-		this.potPrefix = domain ?? project;
-		this.destination = destination;
+async function downloadAll( ctx ) {
+    const locales = await getLocales( ctx );
+    if (false === locales) {
+        return { files: [], locales: {} };
+    }
 
-        msgSuccessOnSameLine('Validation done');
-	}
+    const files = [];
+    const names = {};
 
-    maybeDirectory() {
-		const destination = resolve(this.destination);
-        write('Checking if destination directory exists...');
+    for ( const locale of Object.keys( locales ) ) {
+        const set = locales[ locale ];
 
-		if (!fs.existsSync(destination)) {
-			fs.mkdirSync(destination);
+        console.log( '' );
+        console.log(
+            chalk.yellow.bold( 'Updating Language:' ) +
+                ` ${chalk.italic( set.name )}`
+        );
 
-            if (!fs.existsSync(destination)) {
-                throw new Error('The destination directory could not be created.');
-            } else {
-                msgSuccessOnSameLine('Directory created');
+        for ( const format of [ 'mo', 'po' ] ) {
+            const target = await downloadFile( ctx, locale, set, format );
+            if ( target ) {
+                const file = target.replace( /^\.\//, '' );
+                files.push( file );
+                names[ file ] = set.name;
             }
-		} else {
-            msgSuccessOnSameLine('Directory exists');
         }
-	}
-
-    async download() {
-        const locales = await this.getLocales();
-        if (false === locales) {
-			return;
-		}
-
-        eachSeries(
-            Object.keys(locales),
-            (locale, callback) => {
-                const set = locales[locale];
-
-                console.log('');
-				console.log(
-					chalk.yellow.bold('Updating Language:') +
-						` ${chalk.italic(set.name)}`
-				);
-
-                eachSeries(['mo', 'po'], (format, nextFormat) => {
-                    this.downloadFile(locale, set, format, nextFormat);
-                }, (err) => {
-                    callback();
-                })
-            },
-            (err, results) => {
-                if (err) {
-                    msgError(err.message);
-                } else {
-                    console.log('');
-                    console.log(
-                        chalk.bgGreen.bold('Success:') +
-                            ' All files has been downloaded.'
-                    );
-                }
-            }
-        )
     }
 
-    async getLocales() {
-        write('Downloading locales...');
-        const response = await fetch(`${this.baseURL}/${this.project}`);
-        const data = await response.json();
-        const sets = {};
+    console.log( '' );
+    console.log(
+        chalk.bgGreen.bold( 'Success:' ) +
+            ' All files has been downloaded.'
+    );
+
+    return { files, locales: names };
+}
+
+async function getLocales( ctx ) {
+    write('Downloading locales...');
+    const response = await fetch(`${BASE_URL}/${ctx.project}`, {
+        signal: AbortSignal.timeout(30000),
+    });
+    if (!response.ok) {
+        msgErrorOnSameLine(`HTTP ${response.status}`);
+        return false;
+    }
+    const data = await response.json();
+    const sets = {};
+
+    if (undefined !== data.success && !data.success) {
+        msgErrorOnSameLine(data.error);
+        return false;
+    }
 
-		if (undefined !== data.success && !data.success) {
-			msgErrorOnSameLine(data.error);
-			return false;
-		}
+    data.translation_sets.map((set) => {
+        if (set.current_count > 0) {
+            let id = set.wp_locale;
+            if ('default' !== set.slug) {
+                id += '_' + set.slug;
+            }
 
-        data.translation_sets.map((set) => {
-			if (set.current_count > 0) {
-				let id = set.wp_locale;
-				if ('default' !== set.slug) {
-					id += '_' + set.slug;
-				}
+            sets[id] = set;
+        }
 
-				sets[id] = set;
-			}
+        return false;
+    });
 
-			return false;
-		});
+    msgSuccessOnSameLine('Downloaded locales');
 
-        msgSuccessOnSameLine('Downloaded locales');
+    return sets;
+}
 
-		return sets;
+async function downloadFile(ctx, locale, data, format) {
+    if (!/^[a-zA-Z0-9_]+$/.test(locale)) {
+        msgErrorOnSameLine(`Skipping invalid locale: ${locale}`);
+        return;
     }
 
-   async downloadFile(locale, data, format, callback) {
-		write(
-			chalk.bold(`Downloading: ${this.potPrefix}-${locale}.${format}`)
-		);
+    write(
+        chalk.bold(`Downloading: ${ctx.potPrefix}-${locale}.${format}`)
+    );
 
-		const target = `${this.destination}/${this.potPrefix}-${locale}.${format}`;
-		const endpoint = `${this.baseURL}/${this.project}/${data.locale}/${data.slug}/export-translations?format=${format}`;
+    const target = `${ctx.destination}/${ctx.potPrefix}-${locale}.${format}`;
+    const endpoint = `${BASE_URL}/${ctx.project}/${data.locale}/${data.slug}/export-translations?format=${format}`;
 
-		// Download.
-		const response = await fetch(endpoint);
-		const content = await response.text();
+    const response = await fetch(endpoint, {
+        signal: AbortSignal.timeout(30000),
+    });
+    if (!response.ok) {
+        msgErrorOnSameLine(`Skipping ${ctx.potPrefix}-${locale}.${format}`);
+        return;
+    }
 
-		fs.writeFileSync(target, content);
+    const content = await response.text();
 
-        onSameLine(
-			chalk.bold(`Downloaded: ${this.potPrefix}-${locale}.${format}`)
-		);
+    fs.writeFileSync(target, content);
 
-        callback();
-	}
-}
+    onSameLine(
+        chalk.bold(`Downloaded: ${ctx.potPrefix}-${locale}.${format}`)
+    );
 
-export default () => {
-    const downloader = new GlotPressDownloader();
-    downloader.run();
+    return target;
 }

package/src/commands/wp-pot.js

@@ -4,16 +4,18 @@
 import { heading, msgSuccess, runCommand, getSetting } from "../utilities/index.js"
 
 export default (next = null) => {
-    heading('Generating PO and MO files...')
+    heading('Generating POT file...')
 
     const settings = getSetting()
 
     const output = settings.wpPot.output;
     const file = settings.wpPot.file;
     const domain = settings.wpPot.domain;
+    const name = settings.author?.name ?? ''
+    const email = settings.author?.email ?? ''
     const headers = {
-        'Last-Translator': 'Shakeeb Ahmed <me@shakeebahmed.com>',
-        'Language-Team': 'Advanced Ads <support@wpadvancedads.com>',
+        'Last-Translator': `${name} <${email}>`,
+        'Language-Team': `${name} <${email}>`,
     };
     const exclude = [
         '.git',
@@ -28,17 +30,23 @@ export default (next = null) => {
 
     // Execute.
     const rootPath = process.cwd();
-    const command = [
-        'wp i18n make-pot',
+    runCommand( 'wp', [
+        'i18n',
+        'make-pot',
         rootPath,
         rootPath + output + file,
         `--domain=${domain}`,
         `--exclude=${exclude.join(',')}`,
-        `--headers='${JSON.stringify(headers)}'`,
-    ];
+        `--headers=${JSON.stringify(headers)}`,
+    ], ( error ) => {
+        if ( error ) {
+            if ( next ) {
+                next( error )
+            }
+            return
+        }
 
-    runCommand( command.join(' '), [], () => {
-        msgSuccess('PO and MO files generated successfully');
+        msgSuccess('POT file generated successfully');
         if (next) next();
     } );
 }

package/src/utilities/filesystem.js

@@ -1,7 +1,6 @@
 /**
  * External dependencies
  */
-import chalk from 'chalk';
 import logSymbols from 'log-symbols';
 import template from 'lodash/template.js';
 
@@ -9,12 +8,13 @@ import template from 'lodash/template.js';
  * Node dependencies
  */
 import path from 'path';
-import fs from 'fs-extra';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
 
 /**
  * Internal Dependencies
  */
-import { msgSuccessOnSameLine, onSameLine, write } from './formatting.js'
+import { msgErrorTitle, msgSuccessOnSameLine, onSameLine, write } from './formatting.js'
 
 let projectRoot = null
 
@@ -32,32 +32,26 @@ export function getProjectRoot(startDir = process.cwd()) {
 		return projectRoot;
 	}
 
-	projectRoot = startDir;
+	let dir = startDir;
 
-	while (projectRoot !== path.parse(projectRoot).root) {
-		const possibleRootFile = path.join(projectRoot, 'wp.advads');
-		if (fs.existsSync(possibleRootFile)) {
+	while (dir !== path.parse(dir).root) {
+		if (fs.existsSync(path.join(dir, 'wp.advads'))) {
+			projectRoot = dir;
 			return projectRoot;
 		}
 
-		// Move up one directory level
-		projectRoot = path.dirname(projectRoot);
-  }
+		dir = path.dirname(dir);
+	}
 
-  throw new Error('Project root not found. Make sure there is a wp.advads file in the root directory.');
+	projectRoot = null;
+	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')
+	return path.join( path.dirname( fileURLToPath( import.meta.url ) ), '../../template' )
 }
 
 /**
@@ -87,21 +81,22 @@ export function compileTemplate( filename, data ) {
 }
 
 /**
- * Deletes a specified file if it exists.
+ * Compile a template and write it, or print the shared scaffold failure.
  *
- * @param {string} name - The name of the file to be deleted.
- * @param {string} file - The path to the file to be deleted.
- *
- * @returns {void}
+ * @param {string} folder
+ * @param {string} filename
+ * @param {string} templateFile Path under template/
+ * @param {Object} data
+ * @param {boolean} force
  */
-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!`)}` )
+export function writeFromTemplate( folder, filename, templateFile, data, force = false ) {
+	try {
+		const content = compileTemplate( getTemplateFile( templateFile ), data )
+		writeFile( folder, filename, content, force )
+	} catch ( err ) {
+		msgErrorTitle( 'We failed!!!' )
+		throw err
+	}
 }
 
 /**
@@ -120,7 +115,7 @@ export function updateFileContent(fileName, messages, next, callback) {
     fs.readFile(fileName, (err, buffer) => {
         if ( null !== err ) {
             onSameLine(`${logSymbols.error} ${messages.failed}`)
-            return next()
+            return next(err)
         }
 
         const content = callback(buffer.toString())
@@ -128,7 +123,7 @@ export function updateFileContent(fileName, messages, next, callback) {
         fs.writeFile(fileName, content, (err) => {
             if ( null !== err ) {
                 onSameLine(`${logSymbols.error} ${messages.failed}`)
-                return next()
+                return next(err)
             }
 
             onSameLine(`${logSymbols.success} ${messages.updated}`)
@@ -137,12 +132,38 @@ export function updateFileContent(fileName, messages, next, callback) {
     })
 }
 
-export function writeFile(folder, filename, content) {
+function assertInsideProject( target ) {
+	if ( String( target ).includes( '\0' ) ) {
+		throw new Error( 'Invalid path' )
+	}
+
+	const root = path.resolve( getProjectRoot() )
+	const resolved = path.resolve( target )
+	const relative = path.relative( root, resolved )
+
+	if ( relative.startsWith( `..${path.sep}` ) || relative === '..' || path.isAbsolute( relative ) ) {
+		throw new Error( 'Path escapes project root' )
+	}
+}
+
+export function writeFile(folder, filename, content, force = false) {
+	if ( String( filename ).includes( '\0' ) ) {
+		throw new Error( 'Invalid path' )
+	}
+
+	assertInsideProject( folder )
+	assertInsideProject( path.join( folder, filename ) )
+
+	const target = path.join( folder, filename )
+	if ( ! force && fs.existsSync( target ) ) {
+		throw new Error( `File exists: ${target}` )
+	}
+
 	write('Creating directories!!');
-	fs.ensureDirSync(folder);
+	fs.mkdirSync(folder, { recursive: true });
 	msgSuccessOnSameLine('Directories created successfully');
 
 	write('Creating file!!');
-	fs.writeFileSync(path.join(folder, filename), content);
+	fs.writeFileSync(target, content);
 	msgSuccessOnSameLine('File created successfully');
 }

package/src/utilities/flow.js

@@ -0,0 +1,21 @@
+/**
+ * Run callback-style steps in order. `next(err)` if any step fails.
+ *
+ * @param {Function[]} steps Each step is `(done) => void`
+ * @param {Function} next
+ */
+export function runSteps( steps, next ) {
+	;( async () => {
+		for ( const step of steps ) {
+			await new Promise( ( resolve, reject ) => {
+				step( ( err ) => {
+					if ( err ) {
+						reject( err )
+					} else {
+						resolve()
+					}
+				} )
+			} )
+		}
+	} )().then( () => next() ).catch( ( err ) => next( err ) )
+}

package/src/utilities/formatting.js

@@ -28,6 +28,10 @@ export function onNewLine(text) {
     console.log(text)
 }
 
+function canRewriteStdout() {
+	return Boolean( process.stdout.isTTY && ! process.env.NODE_TEST_CONTEXT )
+}
+
 /**
  * Print text on same line by clearing buffer.
  *
@@ -36,9 +40,9 @@ export function onNewLine(text) {
  * @returns {void}
  */
 export function onSameLine(text) {
-	if (process.stdout.clearLine) {
-		process.stdout.clearLine(); // Clear the current line
-		process.stdout.cursorTo(0);  // Move the cursor to the start of the line
+	if ( canRewriteStdout() && process.stdout.clearLine ) {
+		process.stdout.clearLine();
+		process.stdout.cursorTo(0);
 	}
 
     console.log(text)
@@ -118,5 +122,10 @@ export function msgErrorTitle(msg) {
  * @returns {void}
  */
 export function write(text) {
-	process.stdout.write(text)
+	if ( canRewriteStdout() ) {
+		process.stdout.write(text)
+		return
+	}
+
+	console.log(text)
 }

package/src/utilities/index.js

@@ -1,6 +1,6 @@
 export * from './filesystem.js'
+export * from './flow.js'
 export * from './formatting.js'
-export * from './semver.js'
 export * from './settings.js'
 export * from './shell.js'
 export * from './misc.js'

package/src/utilities/misc.js

@@ -1,12 +1,7 @@
-/**
- * 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);
+	return filename.charAt(0).toUpperCase() + filename.slice(1).toLowerCase();
 }

package/src/utilities/settings.js

@@ -1,9 +1,3 @@
-/**
- * External dependencies
- */
-import get from 'lodash/get.js'
-import set from 'lodash/set.js'
-
 /**
  * Node dependencies
  */
@@ -18,6 +12,14 @@ import { write } from './formatting.js'
 
 let settings = null
 
+function configPath() {
+	try {
+		return path.join( getProjectRoot(), 'wp.advads' )
+	} catch {
+		return path.join( process.cwd(), 'wp.advads' )
+	}
+}
+
 /**
  * Checks if the configuration file exists at the specified path.
  *
@@ -25,8 +27,7 @@ let settings = null
  */
 export function configFileExists() {
 	try {
-		const configPath = path.join(getProjectRoot(), 'wp.advads')
-		return fs.existsSync(configPath);
+		return fs.existsSync( configPath() );
 	} catch (err) {
 		return false;
 	}
@@ -39,8 +40,7 @@ export function configFileExists() {
  */
 export function readConfigFile() {
 	try {
-		const configPath = path.join(getProjectRoot(), 'wp.advads')
-		const data = fs.readFileSync(configPath, 'utf-8');
+		const data = fs.readFileSync( configPath(), 'utf-8' );
 		return JSON.parse(data);
 	} catch (err) {
 		return {};
@@ -55,9 +55,8 @@ export function readConfigFile() {
 export function saveConfig(data) {
 	write('Saving config file...');
 	try {
-		const savePath = path.join(process.cwd(), 'wp.advads')
 		const jsonData = JSON.stringify(data, null, 2);
-		fs.writeFileSync(savePath, jsonData);
+		fs.writeFileSync( configPath(), jsonData );
 		settings = data;
 	} catch (err) {
 		write('Error writing config file:', err);
@@ -82,7 +81,7 @@ export function getSetting(key = 'all', defaultVal = '') {
 		return settings;
 	}
 
-	return get( settings, key, defaultVal );
+	return getPath( settings, key, defaultVal );
 }
 
 export function updateSetting(key, value) {
@@ -90,6 +89,27 @@ export function updateSetting(key, value) {
 		settings = readConfigFile();
 	}
 
-	settings = set(settings, key, value);
+	settings = setPath(settings, key, value);
 	saveConfig(settings);
 }
+
+function getPath( object, key, defaultVal ) {
+	const value = String( key ).split( '.' ).reduce( ( cur, part ) => cur?.[ part ], object )
+	return value === undefined ? defaultVal : value
+}
+
+function setPath( object, key, value ) {
+	const parts = String( key ).split( '.' )
+	let cur = object
+
+	for ( let i = 0; i < parts.length - 1; i++ ) {
+		const part = parts[ i ]
+		if ( cur[ part ] == null || typeof cur[ part ] !== 'object' ) {
+			cur[ part ] = {}
+		}
+		cur = cur[ part ]
+	}
+
+	cur[ parts[ parts.length - 1 ] ] = value
+	return object
+}