wp-advads 1.0.22 → 1.0.23

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "wp-advads",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "Create a Advanced Ads wordPress plugin eco system.",
   "author": {
     "name": "Shakeeb Ahmed",
@@ -17,7 +17,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/advanced-ads/npm-scaffolding.git"
+    "url": "git+https://github.com/advanced-ads/wp-advads.git"
   },
   "keywords": [
     "wordpress",
@@ -29,15 +29,13 @@
     "url": "https://github.com/advanced-ads/npm-scaffolding/issues"
   },
   "homepage": "https://github.com/advanced-ads/npm-scaffolding#readme",
-  "dependencies": {
-    "async": "^3.2.4",
-    "chalk": "^5.0.1",
-    "flat-cache": "^3.0.4",
-    "fs-extra": "^10.1.0",
-    "globby": "^13.1.2",
-    "handlebars": "^4.7.7",
-    "inquirer": "^9.1.1",
+  "devDependencies": {
+    "async": "^3.2.6",
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "fs-extra": "^11.3.0",
+    "inquirer": "^12.5.2",
     "lodash": "^4.17.21",
-    "yargs-parser": "^21.1.1"
+    "log-symbols": "^7.0.0"
   }
 }

package/src/app.js

@@ -4,55 +4,108 @@
  * External dependencies
  */
 import chalk from 'chalk'
-
-/**
- * Internal Dependencies
- */
-import { getCommand } from './utilities/index.js'
-import packageDetails from '../package.json' assert { type: "json" }
+import { program } from 'commander'
 
 /**
  * Commands
  */
 import * as commands from './commands/index.js'
+import { configFileExists, onNewLine } from './utilities/index.js'
 
 /**
  * App
  */
-async function app() {
+const app = async () => {
     console.log(
         [
             chalk.hex('#FADC00').inverse.bold('Advanced Ads WordPress Plugin Toolkit'),
-            chalk.white( 'v' + packageDetails.version ),
+            chalk.white( 'v2.0.0' ),
             chalk.dim( 'by Shakeeb Ahmed' )
         ].join(" ")
     );
 
+	program.configureHelp({
+		sortSubcommands: true,
+	});
+
+	program
+		.name('wp-advads')
+		.description('CLI to Advanced Ads scaffolding utilities')
+		.version('2.0.0')
+		.hook('preAction', (thisCommand, actionCommand) => {
+			if ( 'init' !== actionCommand.name() && ! configFileExists() ) {
+				onNewLine(chalk.bgRed.white('Config file not found. Run `wp-advads init` to create a new config file.'));
+				process.exit(1);
+			}
+		})
+		.showHelpAfterError();
+
+	// Command: init
+	program
+		.command('init')
+		.description('Create new config file for the project')
+		.action(commands.init);
+
+	// Command: plugin
+	// program
+	// 	.command('plugin')
+	// 	.description('Create a new plugin')
+	// 	.action(commands.plugin);
+
+	// Command: release
+	program
+		.command('release')
+		.description('Create a new release for the plugin')
+		.action(commands.release);
 
-    const { command, args } = getCommand()
-    if ( 'help' === command ) {
-        commands.help()
-    }
+	// Command: class
+	program
+		.command('class')
+		.description('Create a new class file')
+		.argument('<classname>', 'Classname')
+		.option('-h <heading>', 'Heading of the file')
+		.option('-d <description>', 'Description of the file')
+		.option('-i', 'Initializer interface template')
+		.option('-g', 'Integration interface template')
+		.option('-r', 'Rest interface template')
+		.option('-s', 'Singleton template')
+		.action(commands.classFile);
 
-    if ( 'backup' === command ) {
-        commands.backup()
-    }
+	// Command: view
+	program
+		.command('view')
+		.description('Create a new view')
+		.argument('<viewname>', 'name of the view')
+		.argument('[heading]', 'Heading of the file')
+		.action(commands.views);
 
-    if ( 'make:file' === command ) {
-        commands.makeFile(args)
-    }
+	// Command: updates
+	program
+		.command('updates')
+		.description('Updates for the plugin')
+		.argument('<version>', 'version number')
+		.action(commands.updates);
 
-    if ( 'make:plugin' === command ) {
-        commands.setupPlugin(args)
-    }
+	// Command: js
+	program
+		.command('js')
+		.description('Create a new JavaScript file')
+		.argument('<filename>', 'name of the file')
+		.option('-h <heading>', 'Heading of the file')
+		.option('-d <description>', 'Description of the file')
+		.action(commands.javascript);
 
-    if ( 'make:release' === command ) {
-        commands.release(args)
-    }
+	// Command: css
+	program
+		.command('css')
+		.description('Create a new CSS file')
+		.argument('<filename>', 'name of the file')
+		.option('-h <heading>', 'Heading of the file')
+		.option('-d <description>', 'Description of the file')
+		.action(commands.css);
 
-    if ( 'patch' === command ) {
-        commands.patch(args)
-    }
+	// Lets begin
+	program.parse(process.argv)
 }
 
 app()

package/src/commands/class.js

@@ -0,0 +1,63 @@
+/**
+ * External Dependencies
+ */
+import capitalize from 'lodash/capitalize.js';
+
+/**
+ * Node Dependencies
+ */
+import path from 'path';
+
+/**
+ * Internal Dependencies
+ */
+import { getSetting, writeFile, filenameToHeading, heading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate, runCommand } from "../utilities/index.js";
+
+function templateName(options)  {
+	const length = Object.keys(options).length
+
+	if ( 0 === length ) {
+		return 'class-empty';
+	}
+
+	const hash = {
+		'i': 'class-initializer',
+		'g': 'class-integration',
+		'r': 'class-rest',
+		's': 'class-singleton',
+	}
+	const has = Object.keys(options)[0]
+
+	return hash[has] ?? 'class-empty';
+}
+
+export default (classname, options) => {
+	heading('Creating class file...')
+    const {
+		h: header = null,
+		d: description = null,
+	} = options
+
+	try {
+		const template = templateName(options);
+		const namespace = classname.split('\\');
+		const paths = classname.toLowerCase().split('\\');
+		const filename = paths.pop() + '.php';
+		const folder = path.join(getProjectRoot(), getSetting('paths.php'), paths.join('/'));
+
+		// Data
+		const data = getSetting();
+		data.heading = header || filenameToHeading(filename) + ' template file';
+		data.description = description || 'Brief description of the styles in this file';
+		data.className = namespace.pop();
+		data.namespace = '\\' + namespace.join('\\');
+
+		const content = compileTemplate(getTemplateFile(`files/${template}.php`), data);
+		writeFile(folder, `class-${filename}`, content);
+		runCommand( 'composer', [ 'dump' ], () => {} );
+	}
+	catch (err) {
+		msgErrorTitle('We failed!!!');
+		throw err;
+	}
+}

package/src/commands/css.js

@@ -0,0 +1,36 @@
+
+/**
+ * Node Dependencies
+ */
+import path from 'path';
+
+/**
+ * Internal Dependencies
+ */
+import { getSetting, writeFile, heading, filenameToHeading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+
+export default (name, options) => {
+	heading('Creating CSS file...')
+	const {
+		h: header = null,
+		d: description = null,
+	} = options
+
+	try {
+		const paths = name.toLowerCase().split('\\')
+		const filename = paths.pop() + '.css';
+		const folder = path.join(getProjectRoot(), getSetting('paths.css'), paths.join('/'));
+
+		// Data
+		const data = getSetting();
+		data.heading = header || filenameToHeading(name) + ' styles.';
+		data.description = description || 'Brief description of the styles in this file';
+
+		const content = compileTemplate(getTemplateFile('files/stylesheet.css'), data);
+		writeFile(folder, filename, content);
+	}
+	catch (err) {
+		msgErrorTitle('We failed!!!');
+		throw err;
+	}
+}

package/src/commands/index.js

@@ -1,6 +1,8 @@
-export { default as backup } from './backup/index.js'
-export { default as makeFile } from './file/index.js'
-export { default as help } from './help/index.js'
-export { default as patch } from './patch/index.js'
-export { default as release } from './release/index.js'
-export { default as setupPlugin } from './setup/index.js'
+export { default as css } from './css.js'
+export { default as classFile } from './class.js'
+export { default as init } from './init.js'
+export { default as javascript } from './javascript.js'
+// export { default as plugin } from './plugin.js'
+export { default as release } from './release.js'
+export { default as updates } from './updates.js'
+export { default as views } from './views.js'

package/src/commands/init.js

@@ -0,0 +1,166 @@
+/**
+ * External dependencies
+ */
+import inquirer from 'inquirer'
+import kebabCase from 'lodash/kebabCase.js'
+
+/**
+ * Node dependencies
+ */
+import { getSetting, heading, saveConfig, msgSuccessTitle } from '../utilities/index.js'
+
+export default async () => {
+    const questions = [
+        // Product
+        {
+            type: 'input',
+            name: 'wp.name',
+            message: 'The name of your plugin/theme',
+            default: getSetting( 'wp.name', 'Advanced Ads' ),
+        },
+		{
+            type: 'input',
+            name: 'wp.description',
+            message: 'A short description of the plugin/theme',
+            default: getSetting( 'wp.description' ),
+        },
+		{
+            type: 'input',
+            name: 'wp.version',
+            message: 'The current version number of the plugin/theme',
+            default: getSetting( 'wp.version', '1.0.0' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+
+        // WordPress
+		{
+            type: 'input',
+            name: 'wp.requireWP',
+            message: 'The lowest WordPress version that the plugin/theme will work on',
+            default: getSetting( 'wp.requireWP', '6.0' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+		{
+            type: 'input',
+            name: 'wp.requirePHP',
+            message: 'The minimum required PHP version',
+            default: getSetting( 'wp.requirePHP', '7.4' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+        {
+            type: 'input',
+            name: 'wp.textDomain',
+            message: 'The gettext text domain of the plugin/theme',
+            default: getSetting( 'wp.textDomain' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+        {
+            type: 'input',
+            name: 'wp.glotpress',
+            message: 'The glotpress project slug',
+            default: getSetting( 'wp.glotpress' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+
+		// Paths
+		{
+            type: 'input',
+            name: 'paths.php',
+            message: 'The source files of the plugin/theme',
+            default: getSetting( 'paths.php', 'includes' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+		{
+            type: 'input',
+            name: 'paths.views',
+            message: 'The path to views folder of the plugin/theme',
+            default: getSetting( 'paths.views', 'views' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+		{
+            type: 'input',
+            name: 'paths.updates',
+            message: 'The path to updates folder of the plugin/theme',
+            default: getSetting( 'paths.updates', 'updates' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+		{
+            type: 'input',
+            name: 'paths.javascript',
+            message: 'The path to javascript folder of the plugin/theme',
+            default: getSetting( 'paths.javascript', 'assets/src' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+		{
+            type: 'input',
+            name: 'paths.css',
+            message: 'The path to css folder of the plugin/theme',
+            default: getSetting( 'paths.css', 'assets/css' ),
+            filter: ( val ) => val.toLowerCase()
+        },
+
+        // Misc
+        {
+            type: 'input',
+            name: 'misc.package',
+            message: 'Enter php package namespace',
+            default: getSetting( 'misc.package' ),
+            filter: ( val ) => val.replace( / /g, '' )
+        },
+		{
+            type: 'input',
+            name: 'misc.prefix',
+            message: 'Enter prefix to be used for functions',
+            default: getSetting( 'misc.prefix' ),
+        },
+        {
+            type: 'input',
+            name: 'misc.constprefix',
+            message: 'Enter prefix to be used for constants',
+            default: getSetting( 'misc.constprefix' ),
+        },
+    ]
+
+	heading('How you want your plugin?')
+    inquirer.prompt( questions )
+        .then( ( answers ) => {
+            const date = new Date()
+            answers = {
+                ...answers,
+                year: date.getFullYear(),
+                company: {
+                    name: 'Advanced Ads',
+                    url: 'https://wpadvancedads.com/',
+                },
+                author: {
+                    name: 'Advanced Ads',
+                    email: 'info@wpadvancedads.com',
+                    url: 'https://wpadvancedads.com/',
+                }
+            }
+
+            answers.package = {
+                vendor: kebabCase( answers.company.name ),
+                name: kebabCase( answers.wp.name )
+            }
+			answers.wp.textDomain = answers.wp.textDomain || answers.package.name
+
+            // Glotpress
+            answers.glotpress = false
+            if (answers.wp.glotpress) {
+                answers.glotpress = {
+                    project: answers.wp.glotpress,
+                    destination: "./languages/",
+                }
+            }
+
+            answers.wpPot = {
+                output: "/languages/",
+                file: `${answers.wp.textDomain}.pot`,
+                domain: answers.wp.textDomain
+            }
+
+			saveConfig( answers )
+			msgSuccessTitle('Config file created successfully!')
+        } )
+}

package/src/commands/javascript.js

@@ -0,0 +1,36 @@
+
+/**
+ * Node Dependencies
+ */
+import path from 'path';
+
+/**
+ * Internal Dependencies
+ */
+import { getSetting, writeFile, heading, filenameToHeading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+
+export default (name, options) => {
+	heading('Creating javascript file...')
+    const {
+		h: header = null,
+		d: description = null,
+	} = options
+
+	try {
+		const paths = name.toLowerCase().split('\\')
+		const filename = paths.pop() + '.js';
+		const folder = path.join(getProjectRoot(), getSetting('paths.javascript'), paths.join('/'));
+
+		// Data
+		const data = getSetting();
+        data.heading = header || filenameToHeading(name) + ' module.';
+		data.description = description || 'Description of the module';
+
+		const content = compileTemplate(getTemplateFile('files/javascript.js'), data);
+		writeFile(folder, filename, content);
+	}
+	catch (err) {
+		msgErrorTitle('We failed!!!');
+		throw err;
+	}
+}

package/src/commands/release/change-version.js

@@ -9,8 +9,8 @@ import { forEach, waterfall } from 'async'
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js'
-import { heading, onSameLine, updateFileContent } from "../../utilities/index.js"
+import { pluginData } from '../release.js'
+import { getSetting, heading, onSameLine, saveConfig, updateFileContent } from "../../utilities/index.js"
 
 /**
  * Update version in readme.txt file
@@ -56,63 +56,79 @@ function updatePluginFiles(next) {
             return next(true)
         }
 
-        forEach(files, (fileName, nextFile) => {
-            if ( '.php' === path.extname(fileName) && 'index.php' !== fileName ) {
-                updateFileContent(
-                    fileName,
-                    {
-                        updating: `Updating ${fileName}`,
-                        failed: `Failed to update ${fileName}`,
-                        updated: `${fileName} updated successfully`,
-                    },
-                    nextFile,
-                    (content) => {
-                        let update = false
-                        const version = pluginData.semver.getNextVersionString()
-                        let versionRe = new RegExp('^(?<prefix>(?:[ \\t]*<\\?php)?[ \\t\\/*#@]*Version: +)(?<version>.*)$', 'mi')
-                        let constantRe = new RegExp('^(?<opening>(?:[ \\t])?define.*[\\\'"].*_VERSION[\\\'"],.*[\\\'"])(?<version>.*)(?<closing>[\\\'"].*)$', 'mi')
-
-                        versionRe = versionRe.exec(content)
-                        if (null !== versionRe) {
-                            update = true
-                            versionRe = versionRe.groups
-                            content = content.replace(`${versionRe.prefix}${versionRe.version}`, `${versionRe.prefix}${version}`)
-                        }
-
-                        constantRe = constantRe.exec(content)
-                        if (null !== constantRe) {
-                            update = true
-                            constantRe = constantRe.groups
-                            content = content.replace(
-                                `${constantRe.opening}${constantRe.version}${constantRe.closing}`,
-                                `${constantRe.opening}${version}${constantRe.closing}`,
-                            )
-                        }
-
-                        if(update) {
-                            pluginData.commitMessages.push('update version in ' + fileName)
-                        }
-
-                        return content
+        const phpFiles = files.filter(file => {
+            return path.extname(file).toLowerCase() === '.php' && file.toLowerCase() !== 'index.php'
+        });
+
+        if ( phpFiles.length < 1 ) {
+            onSameLine(`${logSymbols.error} No PHP files found`)
+            return next(true)
+        }
+
+        forEach(phpFiles, (fileName, nextFile) => {
+            updateFileContent(
+                fileName,
+                {
+                    updating: `Updating ${fileName}`,
+                    failed: `Failed to update ${fileName}`,
+                    updated: `${fileName} updated successfully`,
+                },
+                nextFile,
+                (content) => {
+                    let update = false
+                    const version = pluginData.semver.getNextVersionString()
+                    let versionRe = new RegExp('^(?<prefix>(?:[ \\t]*<\\?php)?[ \\t\\/*#@]*Version: +)(?<version>.*)$', 'mi')
+                    let constantRe = new RegExp('^(?<opening>(?:[ \\t])?define.*[\\\'"].*_VERSION[\\\'"],.*[\\\'"])(?<version>.*)(?<closing>[\\\'"].*)$', 'mi')
+
+                    versionRe = versionRe.exec(content)
+                    if (null !== versionRe) {
+                        update = true
+                        versionRe = versionRe.groups
+                        content = content.replace(`${versionRe.prefix}${versionRe.version}`, `${versionRe.prefix}${version}`)
                     }
-                )
-            } else {
-                nextFile()
-            }
+
+                    constantRe = constantRe.exec(content)
+                    if (null !== constantRe) {
+                        update = true
+                        constantRe = constantRe.groups
+                        content = content.replace(
+                            `${constantRe.opening}${constantRe.version}${constantRe.closing}`,
+                            `${constantRe.opening}${version}${constantRe.closing}`,
+                        )
+                    }
+
+                    if(update) {
+                        pluginData.commitMessages.push('update version in ' + fileName)
+                    }
+
+                    return content
+                }
+            )
         }, () => next())
     })
 }
 
+/**
+ * Update version in config file
+ */
+function updateConfigFile(next) {
+    const settings = getSetting()
+    settings.wp.version = pluginData.semver.getNextVersionString()
+    saveConfig(settings)
+    onSameLine(`${logSymbols.success} Version updated in config file`)
+}
+
 /**
  * Execute routine
  */
-export function updateVersionNumber(next) {
+export default function updateVersionNumber(next) {
     heading('Updating files for new version')
 
     const flow = []
 
     if (!pluginData.semver.preRelease) {
         flow.push(updateReadme)
+        flow.push(updateConfigFile)
     }
 
     flow.push(updatePluginFiles)

package/src/commands/release/changelog.js

@@ -8,7 +8,7 @@ import { forEach, waterfall } from 'async'
 /**
  * Internal Dependencies
  */
-import { pluginData } from './index.js';
+import { pluginData } from '../release.js';
 import { heading, execCommand, onSameLine, updateFileContent } from "../../utilities/index.js"
 
 const LOCALES_CHANGELOG = {
@@ -241,7 +241,7 @@ function cleanChangelogDirectory(next) {
 /**
  * Execute routine
  */
-export function updateChangelog(next) {
+export default function updateChangelog(next) {
     heading('Creating changelog')
 
     const flow = [