wp-advads 1.0.33 → 1.0.35

package/src/commands/release/translations.js

@@ -7,38 +7,32 @@ import logSymbols from 'log-symbols'
  * Internal Dependencies
  */
 import { pluginData } from '../release.js'
-import { heading, execCommand, getSetting } from "../../utilities/index.js"
+import { heading } from "../../utilities/index.js"
+import { downloadTranslations } from '../wp-glotpress.js'
 
 /**
  * Execute routine to download translations from GlotPress
  */
-export default function updateTranslations( next ) {
+export default async function updateTranslations( next ) {
     heading('Downloading translations from glotpress')
 
-    const glotpress = getSetting('wp.glotpress')
+    try {
+        const { files, locales } = await downloadTranslations()
+        console.log( logSymbols.success + ` Downloaded ${files.length} files successfully` )
 
-    if (!glotpress) {
-        console.log( logSymbols.warning + ' No glotpress project found' )
-        next()
-        return;
-    }
-
-    execCommand( 'npx wp-advads translations', function(locales) {
-        locales = locales.split('\n').slice(4).slice(0,-1)
-        console.log( logSymbols.success + ` Downloaded ${locales.length} files successfully` )
-
-        if (locales.length > 0) {
+        if (files.length > 0) {
             pluginData.commitMessages.push('add: Download translation from GlotPress')
         }
 
-        const newLocales = {}
-        locales.map((locale) => {
-            const data = locale.split('=')
-            newLocales[ data[0] ] = data[1]
-        })
-
-        pluginData.locales = newLocales
-
+        pluginData.locales = locales
         next()
-    })
+    } catch (err) {
+        if ( err && err.message === 'No glotpress project found' ) {
+            console.log( logSymbols.warning + ' No glotpress project found' )
+            next()
+            return
+        }
+
+        next(err)
+    }
 }

package/src/commands/release.js

@@ -2,13 +2,12 @@
  * External Dependencies
  */
 import chalk from 'chalk'
-import { waterfall } from 'async'
 import logSymbols from 'log-symbols'
 
 /**
  * Node dependencies
  */
-import { heading } from '../utilities/index.js'
+import { heading, runSteps } from '../utilities/index.js'
 
 /**
  * Internal Dependencies
@@ -31,13 +30,13 @@ export default async () => {
     heading('Releasing the plugin...')
     console.log('------------------------------------------------');
 
-    waterfall(
+    runSteps(
         [
             prompts,
             getSemVer,
             githubPreTasks,
             updateTranslations,
-            wpBuild,
+            ( next ) => wpBuild( next, pluginData.commitMessages ),
             updateVersionNumber,
             updateChangelog,
             githubFinalTasks

package/src/commands/updates.js

@@ -2,30 +2,33 @@
  * 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";
+import { getSetting, heading, getProjectRoot, writeFromTemplate } from "../utilities/index.js";
 
-export default (version) => {
+export default (version, options = {}) => {
 	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)
+	const settings = getSetting()
+	const data = {
+		...settings,
+		heading: `Update routine for version ${version}`,
+		description: `Update routine for version ${version}`,
+		prefix: settings.misc?.prefix,
+		version: version.replaceAll('.', '_'),
 	}
-	catch (err) {
-		msgErrorTitle('We failed!!!');
-		throw err;
+
+	if ( ! data.prefix ) {
+		throw new Error( 'misc.prefix is required' );
 	}
+
+	writeFromTemplate(
+		path.join(getProjectRoot(), getSetting('paths.updates')),
+		`upgrade-${version}.php`,
+		'files/update.php',
+		data,
+		options.force
+	)
 }

package/src/commands/views.js

@@ -1,4 +1,3 @@
-
 /**
  * Node Dependencies
  */
@@ -7,25 +6,24 @@ import path from 'path';
 /**
  * Internal Dependencies
  */
-import { getSetting, writeFile, heading, filenameToHeading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+import { getSetting, heading, filenameToHeading, getProjectRoot, writeFromTemplate } from "../utilities/index.js";
 
-export default (name, header) => {
+export default (name, header, options = {}) => {
 	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 dest = path.join( getProjectRoot(), getSetting( 'paths.views' ), name.toLowerCase().replaceAll( '\\', '/' ) ) + '.php'
+	const filename = path.basename( dest )
+	const headingText = header || filenameToHeading(filename) + ' template file'
 
-		const content = compileTemplate(getTemplateFile('files/view.php'), data);
-		writeFile(folder, filename, content);
-	}
-	catch (err) {
-		msgErrorTitle('We failed!!!');
-		throw err;
-	}
+	writeFromTemplate(
+		path.dirname( dest ),
+		filename,
+		'files/view.php',
+		{
+			...getSetting(),
+			heading: headingText,
+			description: headingText,
+		},
+		options.force
+	)
 }

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();
     } );
 }