wp-advads 1.0.7 → 1.0.9

package/src/utilities/folder.js

@@ -0,0 +1,64 @@
+/**
+ * Node dependencies
+ */
+import fs from 'fs'
+import { join } from 'path'
+import { createRequire } from 'node:module'
+
+/**
+ * Internal Dependencies
+ */
+import { CACHE_FILE } from './cache.js'
+import { getArguments } from './command.js'
+
+export function folderEmptiness(folder) {
+    const folderFiles = fs.readdirSync(folder)
+    if (1 === folderFiles.length || 0 === folderFiles.length) {
+        return true
+    }
+
+    return false
+}
+
+export function getCurrentFolder() {
+    let folder = process.cwd()
+    const args = getArguments()
+
+    if ( undefined !== args.folder ) {
+        folder = resolve( './' + args.folder )
+    }
+
+    return folder
+}
+
+export function getRootFolder() {
+    let counter = 0
+    const check = function( folder ) {
+        const isEmptyFolder = folderEmptiness(folder)
+
+        if (isEmptyFolder) {
+            return folder
+        }
+
+        const existsConfig = fs.existsSync( folder + '/' + CACHE_FILE )
+        const existsPkg = fs.existsSync( folder + '/package.json' )
+        if (existsConfig || existsPkg) {
+            return folder
+        }
+
+        if ( 5 === counter ) {
+            return process.cwd()
+        }
+
+        counter++
+        return check(join(folder, '../'))
+    }
+
+    return check(process.cwd())
+}
+
+export function getTemplateFolder() {
+    const require = createRequire( import.meta.url )
+    return require.resolve( '../../template' )
+        .replace( '/index.js', '' )
+}

package/src/utilities/formatting.js

@@ -0,0 +1,97 @@
+/**
+ * External dependencies
+ */
+import chalk from 'chalk'
+import logSymbols from 'log-symbols'
+
+/**
+ * Print heading.
+ *
+ * @param {String} title Title to print
+ *
+ * @returns {void}
+ */
+export function heading(title) {
+    console.log('')
+    console.log( chalk.bold.green( 'Ⓞ  ' + title ) )
+}
+
+/**
+ * Print text on new line.
+ *
+ * @param {String} text Text to print
+ *
+ * @returns {void}
+ */
+export function onNewLine(text) {
+    console.log('')
+    console.log(text)
+}
+
+/**
+ * Print text on same line by clearing buffer.
+ *
+ * @param {String} text Text to print
+ *
+ * @returns {void}
+ */
+export function onSameLine(text) {
+    process.stdout.clearLine()
+    process.stdout.cursorTo(0)
+    console.log(text)
+}
+
+/**
+ * Print text on same line by clearing buffer.
+ *
+ * @param {String} text Text to print
+ *
+ * @returns {void}
+ */
+export function msgSuccessOnSameLine(text) {
+    onSameLine(`${logSymbols.success} ${text}`)
+}
+
+/**
+ * Print text on same line by clearing buffer.
+ *
+ * @param {String} text Text to print
+ *
+ * @returns {void}
+ */
+export function msgErrorOnSameLine(text) {
+    onSameLine(`${logSymbols.error} ${text}`)
+}
+
+/**
+ * Print success text in bold green font
+ *
+ * @param {String} msg Text to print
+ *
+ * @returns {void}
+ */
+export function msgSuccessTitle(msg) {
+	console.log( `${logSymbols.success} ${chalk.bold.green(`${msg}`)}` )
+}
+
+/**
+ * Print error text in bold green font
+ *
+ * @param {String} msg Text to print
+ *
+ * @returns {void}
+ */
+export function msgErrorTitle(msg) {
+	console.log( `${logSymbols.error} ${chalk.bold.magenta(`${msg}`)}` )
+}
+
+/**
+ * Write text on current buffer
+ *
+ * @param {String} text Text to write
+ *
+ * @returns {void}
+ */
+export function write(text) {
+	process.stdout.write(text)
+}

package/src/utilities/index.js

@@ -0,0 +1,6 @@
+export * from './cache.js'
+export * from './command.js'
+export * from './file.js'
+export * from './folder.js'
+export * from './formatting.js'
+export * from './shell.js'

package/src/utilities/shell.js

@@ -0,0 +1,36 @@
+/**
+ * Node dependencies
+ */
+import { exec, spawn } from 'node:child_process'
+
+/**
+ * Internal Dependencies
+ */
+import { onSameLine } from './formatting.js'
+
+export function runCommand( command, args, callback ) {
+    const commandSpawn = spawn( command, args, {
+        shell: true,
+        stdio: [ 'inherit' ]
+    } )
+
+    commandSpawn.stdout.on( 'data', (data) => {
+        onSameLine(data.toString())
+    })
+
+    commandSpawn.stderr.on( 'data', (data) => {
+        onSameLine(data.toString().replace('\n','').replace('\r','').trim())
+    })
+
+    commandSpawn.on( 'close', (code) => {
+        callback()
+    })
+}
+
+export function execCommand( command, callback ) {
+	if ('string' !== typeof command) {
+		command = command.join(' ')
+	}
+
+    exec( command, (error, stdout, stderr) => callback(stdout, error, stderr) )
+}

package/template/configs/.eslintignore

@@ -7,4 +7,7 @@
 
 # Minified files
 *.min.js
-assets/js
+*.build.js
+/assets/**/js/**
+/assets/vendor/**
+tailwind.config.js

package/template/configs/.gitattributes

@@ -0,0 +1,33 @@
+# Set the default behavior, in case people don't have `core.autocrlf` set.
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+*.php text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.aar binary
+*.gif binary
+*.jar binary
+*.jpg binary
+*.png binary
+*.ttf binary
+*.webp binary
+
+# Remove files for archives generated using `git archive`.
+/.*              export-ignore
+changelog.txt    export-ignore
+composer.*       export-ignore
+package*.json    export-ignore
+phpcs.*          export-ignore
+phpunit.*        export-ignore
+README.md        export-ignore
+
+# Remove folders for archives generated using `git archive`.
+assets/admin/scss       export-ignore
+assets/admin/src        export-ignore
+assets/frontend/scss    export-ignore
+assets/frontend/src     export-ignore
+bin/                    export-ignore
+.changelog/             export-ignore
+tests/                  export-ignore
+adv-ads-scaffolding export-ignore

package/template/configs/{.phpcs.xml → .phpcs.xml.dist}

@@ -15,6 +15,7 @@
 	<exclude-pattern>*/languages/*</exclude-pattern>
 	<exclude-pattern>*/lib/*</exclude-pattern>
 	<exclude-pattern>*/node_modules/*</exclude-pattern>
+	<exclude-pattern>*/packages/*</exclude-pattern>
 	<exclude-pattern>*/tests/*</exclude-pattern>
 	<exclude-pattern>*/vendor/*</exclude-pattern>
 	<exclude-pattern>*/index.php</exclude-pattern>

package/template/configs/.prettierignore

@@ -36,6 +36,8 @@ composer.lock
 # Config files
 .*
 *-lock*
+webpack.mix.js
+tailwind.config.js
 
 # Support .gitkeep Files
 !.gitkeep

package/template/configs/.stylelintrc

@@ -1,9 +1,23 @@
 {
   "extends": "@wordpress/stylelint-config",
   "ignoreFiles": [
-	"**/*.js",
-	"assets/css/*.min.css",
-	"node_modules/**/*.css",
-	"vendor/**/*.css"
-  ]
+	  "**/*.js",
+	  "assets/css/*.min.css",
+	  "node_modules/**/*.css",
+	  "vendor/**/*.css"
+  ],
+  "rules": {
+    "at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": [
+          "tailwind",
+          "apply",
+          "variants",
+          "responsive",
+          "screen"
+        ]
+      }
+    ]
+  }
 }

package/template/configs/package.json

@@ -8,7 +8,7 @@
 		"type": "git",
 		"url": "https://github.com/advanced-ads/{{package.name}}.git"
 	},
-	"author": "AdvancedAds",
+	"author": "{{author.name}}",
 	"license": "GPL-3.0-or-later",
 	"bugs": {
 		"url": "https://github.com/advanced-ads/{{package.name}}/issues"
@@ -19,7 +19,7 @@
 		"watch": "mix watch",
 		"watch-poll": "mix watch -- --watch-options-poll=1000",
 		"hot": "mix watch --hot",
-		"dist": "mix --production",
+		"build": "mix --production",
 		"lint": "lint-staged",
 		"lint:css": "stylelint \"**/*.css\" --cache",
 		"lint:js": "eslint . --cache",

package/template/configs/webpack.mix.js

@@ -3,6 +3,7 @@
 
 const mix = require('laravel-mix');
 const { join } = require('path');
+const packageData = require('./package.json');
 require('./tools/laravel-mix/wp-pot');
 
 // Local config.
@@ -57,8 +58,8 @@ mix.js('assets/src/app.js', 'assets/js/app.js');
  * WordPress translation
  */
 mix.wpPot({
-	output: '/languages/',
-	file: '{{wp.textDomain}}.pot',
+	output: packageData.wpPot.output,
+	file: packageData.wpPot.file,
 	skipJS: true,
-	domain: '{{wp.textDomain}}',
+	domain: packageData.wpPot.domain,
 });

package/template/make/file-singleton.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * {{heading}}.
+ *
+ * @package {{php.package}}
+ * @author  {{author.name}} <{{author.email}}>
+ * @since   {{wp.version}}
+ */
+
+namespace {{php.package}}{{namespace}};
+
+use AdvancedAds\Framework\Interfaces\WordPress_Integration;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * {{heading}}.
+ */
+class {{className}} implements WordPress_Integration {
+
+	/**
+	 * Main instance
+	 *
+	 * Ensure only one instance is loaded or can be loaded.
+	 *
+	 * @return {{className}}
+	 */
+	public static function get() {
+		static $instance;
+
+		if ( null === $instance ) {
+			$instance = new {{className}}();
+		}
+
+		return $instance;
+	}
+
+	/**
+	 * Hook into WordPress.
+	 */
+	public function hooks() {
+	}
+}

package/template/make/file.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * {{heading}}.
+ *
+ * @package {{php.package}}
+ * @author  {{author.name}} <{{author.email}}>
+ * @since   {{wp.version}}
+ */
+
+namespace {{php.package}}{{namespace}};
+
+use AdvancedAds\Framework\Interfaces\WordPress_Integration;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * {{heading}}.
+ */
+class {{className}} implements WordPress_Integration {
+
+	/**
+	 * Hook into WordPress.
+	 */
+	public function hooks() {
+	}
+}

package/template/tools/laravel-mix/wp-pot.js

@@ -1,37 +1,49 @@
-const mix = require('laravel-mix')
+const mix = require('laravel-mix');
 
 class WordPressPot {
-  name() {
-    return 'wpPot'
-  }
-
-  dependencies() {
-    this.requiresReload = `
-      Dependencies have been installed. Please run again.
-    `
-
-    return ['shelljs']
-  }
-
-  register(config) {
-    this.config = config
-  }
+	name() {
+		return 'wpPot';
+	}
 
-  boot() {
-    const sh = require('shelljs')
-    const {output, file, domain, skipJS = false, exclude = [] } = this.config
+	dependencies() {
+		this.requiresReload = `Dependencies have been installed. Please run again.`;
 
-	exclude.push(".github");
-	exclude.push("vendor");
-	exclude.push("tools");
+		return ['shelljs'];
+	}
 
-	const rootPath = process.cwd()
+	register(config) {
+		this.config = config;
+	}
 
-    sh.exec(`wp i18n make-pot ${rootPath} ${rootPath}${output}${file} --domain=${domain} --exclude=${exclude.join(',')}`)
-	if ( false !== skipJS ) {
-    	sh.exec(`wp i18n make-json ${rootPath}${output}`, { silent: true })
+	boot() {
+		const sh = require('shelljs');
+		const {
+			output,
+			file,
+			domain,
+			skipJS = false,
+			exclude = [],
+		} = this.config;
+
+		exclude.push(".github");
+        exclude.push(".husky");
+        exclude.push(".wordpress-org");
+        exclude.push("node_modules");
+		exclude.push("packages");
+        exclude.push("tools");
+        exclude.push("vendor");
+
+		const rootPath = process.cwd();
+
+		sh.exec(
+			`wp i18n make-pot ${rootPath} ${rootPath}${output}${file} --domain=${domain} --exclude=${exclude.join(
+				','
+			)}`
+		);
+		if (false !== skipJS) {
+			sh.exec(`wp i18n make-json ${rootPath}${output}`, { silent: true });
+		}
 	}
-  }
 }
 
-mix.extend('wpPot', new WordPressPot())
+mix.extend('wpPot', new WordPressPot());