wp-advads 1.0.14 → 1.0.15

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "wp-advads",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "Create a Advanced Ads wordPress plugin eco system.",
   "author": {
     "name": "Shakeeb Ahmed",

package/src/commands/file/create-file.js

@@ -12,7 +12,7 @@ import { getSettings, getRootFolder, getTemplateFolder, runCommand } from "../..
 
 class CreateFile {
     run( args, callback ) {
-        const { file, singleton = false } = args
+        const { file } = args
         const namespace = file.split('\\')
 
         this.template = getTemplateFolder()
@@ -35,7 +35,7 @@ class CreateFile {
         this.folder = getRootFolder() + '/includes/'
 
         // Files
-        this.files =[ singleton ? '/file-singleton.php' : '/file.php' ]
+        this.files = this.getTemplates(args)
 
         if (namespace.length > 0) {
             this.settings.namespace = '\\' + namespace.join('\\')
@@ -88,6 +88,28 @@ class CreateFile {
 
         fs.outputFile( dest, rendered ).then( next )
     }
+
+    getTemplates = (args) => {
+        const { singleton = false, integration = false, routes = false, initializer = false } = args
+
+        if ( singleton ) {
+            return [ '/file-singleton.php' ]
+        }
+
+        if ( integration ) {
+            return [ '/file-integration.php' ]
+        }
+
+        if ( routes ) {
+            return [ '/file-routes.php' ]
+        }
+
+        if ( initializer ) {
+            return [ '/file-initializer.php' ]
+        }
+
+        return [ '/file.php' ]
+    }
 }
 
 export default ( fileName, next ) => {

package/src/commands/setup/create-plugin.js

@@ -49,9 +49,7 @@ function setPluginData(next) {
 		pluginData.folder + '/includes',
 		pluginData.folder + '/includes/abstracts',
 		pluginData.folder + '/includes/admin',
-		pluginData.folder + '/includes/database',
 		pluginData.folder + '/includes/interfaces',
-		pluginData.folder + '/includes/models',
 		pluginData.folder + '/includes/traits',
 		pluginData.folder + '/includes/utilities',
 	]
@@ -121,13 +119,6 @@ function preparePluginFiles(next) {
 	const files =[
 		'/assets/src/app.js',
 		'/assets/scss/app.scss',
-		// '/includes/admin/class-admin.php',
-		// '/includes/interfaces/interface-integration.php',
-		// '/includes/class-assets.php',
-		// '/includes/class-frontend.php',
-		// '/includes/class-plugin.php',
-		// '/plugin.php',
-		// '/uninstall.php',
 	]
 
 	write('Preparing plugin files...')
@@ -169,6 +160,8 @@ function installNodePackages(next) {
 		'husky',
 		'laravel-mix',
 		'lint-staged',
+		'mix-tailwindcss',
+		'postcss',
 		'prettier',
 		'resolve-url-loader',
 		'sass',

package/template/.github/pull_request_template.md

@@ -1,6 +1,6 @@
 ## Description
 
-Please include a summary of the change and which issue is fixed. Provide a clear explanation of the motivation and context behind the change, including how it aligns with project goals.
+Explain your approach to a solution and decisions that lead to it. E.g., which alternatives you evaluated and why you chose yours.
 
 ## Issue ticket number and link
 Related to: #[Issue Number]
@@ -14,27 +14,28 @@ Describe the tests that were conducted to verify the changes. Include instructio
 - [ ] Automated Test B (Purpose of Test B)
 - [ ] Manual Test A (Purpose of Test A)
 - [ ] Manual Test B (Purpose of Test B)
+- [ ] Support / User A confirmed the fix
 
 ## Checklist:
 
 ### Developer -> Code Review:
 - [ ] PR title is clear and descriptive
-- [ ] Code follows the style guidelines of this project
-- [ ] I have performed a self-review of my own code
-- [ ] Code is easily understandable and well-documented
-- [ ] Request a code review from a peer or senior developer
+- [ ] Code is understandable, readable and well-documented
 
 ### Developer -> Testing:
-- [ ] My changes generate no new warnings
+- [ ] My changes generate no new warnings in debug.log and Query Monitor
 - [ ] New and existing unit tests pass locally with my changes
 - [ ] I have added tests that prove my fix is effective or that my feature works
 
 ### Developer -> Documentation:
-- [ ] I have made corresponding changelogs
+- [ ] I have made corresponding changelogs that are grammatically correct according to ...
 - [ ] (Optional) Update relevant documentation, such as API endpoints, configuration changes, or user guides
 
 ### Developer -> Dependencies:
-- [ ] Ensure your changes do not introduce new external dependencies without proper justification
+- [ ] (Optional) If you introduced any external dependencies, explain your reasoning here.
+
+### Reviewers -> Review:
+... describe what they tested – and what they didn’t
 
 ### Assignee -> Review:
 - [ ] Ensure the PR aligns with the original user story or feature requirement
@@ -43,7 +44,6 @@ Describe the tests that were conducted to verify the changes. Include instructio
 ### Assignee -> Testing:
 - [ ] Conduct user acceptance testing to validate that the changes meet the user's needs
 - [ ] Verify that the feature works as expected and doesn't introduce regressions
-- [ ] No issues have been found on the staging environment
 - [ ] PR reviewer has approved the release
 - [ ] Final changelog has been determined/approved
 

package/template/configs/.eslintrc.js

@@ -1,4 +1,13 @@
 module.exports = {
 	root: true,
 	extends: ['plugin:@wordpress/eslint-plugin/recommended'],
+	globals: {
+		jQuery: true,
+		advancedAds: true,
+		ajaxurl: true,
+		advadsglobal: true,
+	},
+	rules: {
+		'import/no-unresolved': 'off',
+	},
 };

package/template/configs/.gitattributes

@@ -30,4 +30,5 @@ assets/frontend/src     export-ignore
 bin/                    export-ignore
 .changelog/             export-ignore
 tests/                  export-ignore
-adv-ads-scaffolding export-ignore
+tools/                  export-ignore
+adv-ads-scaffolding     export-ignore

package/template/configs/.phpcs.xml.dist

@@ -53,35 +53,34 @@
 		<exclude-pattern>includes/**/interface-*.php</exclude-pattern>
 	</rule>
 
-	<!-- Elevate these rules to an error, so it gets printed on commit   -->
-    <rule ref="Generic.Formatting.MultipleStatementAlignment">
-        <type>error</type>
-    </rule>
-
-    <!-- Disable short arrays: -->
+	<!-- Disable disallow short arrays and enforce them: -->
 	<rule ref="WordPress-Extra">
 		<exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
 	</rule>
 
-	<!-- Enforce short arrays: -->
 	<rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
 
-	<!-- Method names MUST NOT be prefixed with a single underscore to indicate protected or private visibility. That is, an underscore prefix explicitly has no meaning. -->
-    <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
+	<!-- Elevate these rules to an error, so it gets printed on commit   -->
+    <rule ref="Generic.Formatting.MultipleStatementAlignment">
         <type>error</type>
-        <message>Method name "%s" must not be prefixed with an underscore to indicate visibility</message>
     </rule>
 
-	<rule ref="WordPress.PHP.StrictInArray">
+	<rule ref="Generic.CodeAnalysis.AssignmentInCondition">
         <type>error</type>
     </rule>
 
-	<rule ref="WordPress.PHP.StrictComparisons">
+	<rule ref="Universal.Operators.StrictComparisons">
         <type>error</type>
     </rule>
 
-	<rule ref="WordPress.CodeAnalysis.AssignmentInCondition">
+	<rule ref="WordPress.PHP.StrictInArray">
         <type>error</type>
     </rule>
 
+	<!-- Method names MUST NOT be prefixed with a single underscore to indicate protected or private visibility. That is, an underscore prefix explicitly has no meaning. -->
+    <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
+        <type>error</type>
+        <message>Method name "%s" must not be prefixed with an underscore to indicate visibility</message>
+    </rule>
+
 </ruleset>

package/template/configs/.prettierignore

@@ -29,6 +29,7 @@ node_modules/
 
 # Composer
 vendor/
+packages/
 bin/composer/**/vendor/
 composer.json
 composer.lock

package/template/configs/.stylelintrc

@@ -1,5 +1,5 @@
 {
-  "extends": "@wordpress/stylelint-config",
+  "extends": "@wordpress/stylelint-config/scss",
   "ignoreFiles": [
 	  "**/*.js",
 	  "assets/css/*.min.css",
@@ -7,17 +7,38 @@
 	  "vendor/**/*.css"
   ],
   "rules": {
-    "at-rule-no-unknown": [
+    "scss/at-rule-no-unknown": [
       true,
+      {
+        "ignoreAtRules": [
+          "apply",
+		  "layer",
+          "responsive",
+          "screen",
+          "tailwind",
+          "variants"
+        ]
+      }
+    ],
+	"at-rule-empty-line-before": [
+      "always",
       {
         "ignoreAtRules": [
           "tailwind",
           "apply",
           "variants",
           "responsive",
-          "screen"
+          "screen",
+		  "import"
         ]
       }
-    ]
+    ],
+	"rule-empty-line-before": [
+		"always",
+		{
+			"ignore": ["first-nested" ]
+		}
+	],
+	"no-descending-specificity": null
   }
 }

package/template/configs/composer.json

@@ -2,7 +2,7 @@
 	"name": "{{package.vendor}}/{{package.name}}",
     "description": "{{wp.description}}",
 	"homepage": "{{company.url}}",
-	"version": "1.42.1",
+	"version": "{{wp.version}}",
 	"type": "wordpress-plugin",
 	"license": "GPL-3.0-or-later",
 	"prefer-stable": true,
@@ -15,12 +15,12 @@
 		}
 	],
 	"require": {
-		"php": ">=7.2"
+		"php": ">=7.2",
+		"advanced-ads/framework": "dev-main"
 	},
 	"require-dev": {
-		"dealerdirect/phpcodesniffer-composer-installer": "^1.0",
 		"phpcompatibility/phpcompatibility-wp": "*",
-		"wp-coding-standards/wpcs": "^2.3"
+		"wp-coding-standards/wpcs": "^3.0.0"
 	},
 	"config": {
 		"optimize-autoloader": true,
@@ -39,7 +39,13 @@
 	},
 	"scripts": {
 		"post-install-cmd": [
-			"composer global require wp-cli/wp-cli"
+			"composer global require wp-cli/wp-cli",
+			"composer global require wp-cli/i18n-command"
+		],
+		"build": [
+			"rm -r packages || true",
+			"COMPOSER_VENDOR_DIR=packages composer install -o -a -n --no-dev --no-scripts",
+			"composer dump"
 		]
 	}
 }

package/template/configs/package.json

@@ -22,8 +22,10 @@
 		"build": "mix --production",
 		"lint": "lint-staged",
 		"lint:css": "stylelint \"**/*.css\" --cache",
+		"lint:scss": "stylelint \"**/*.scss\" --cache",
 		"lint:js": "eslint . --cache",
 		"lint:p": "prettier -c .",
+		"lint:pw": "prettier -w .",
 		"lint:php": "vendor/bin/phpcs",
 		"translations": "node ./tools/wp-glotpress.js"
 	},

package/template/configs/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+	plugins: {
+		tailwindcss: {},
+		autoprefixer: {},
+	},
+};

package/template/configs/tailwind.config.js

@@ -0,0 +1,8 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+	content: ['./includes/**/*.php', './views/**/*.php'],
+	theme: {
+		extend: {},
+	},
+	plugins: [],
+};

package/template/make/file-initializer.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * {{heading}}.
+ *
+ * @package {{php.package}}
+ * @author  {{author.name}} <{{author.email}}>
+ * @since   {{wp.version}}
+ */
+
+namespace {{php.package}}{{namespace}};
+
+use AdvancedAds\Framework\Interfaces\Initializer_Interface;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * {{heading}}.
+ */
+class {{className}} implements Initializer_Interface {
+
+	/**
+	 * Runs this initializer.
+	 *
+	 * @return void
+	 */
+	public function initialize(): void {
+
+	}
+}

package/template/make/file-integration.php

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

package/template/make/file-routes.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * {{heading}}.
+ *
+ * @package {{php.package}}
+ * @author  {{author.name}} <{{author.email}}>
+ * @since   {{wp.version}}
+ */
+
+namespace {{php.package}}{{namespace}};
+
+use AdvancedAds\Framework\Interfaces\Routes_Interface;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * {{heading}}.
+ */
+class {{className}} implements Routes_Interface {
+
+	/**
+	 * Registers routes with WordPress.
+	 *
+	 * @return void
+	 */
+	public function register_routes(): void {
+
+	}
+}

package/template/make/file-singleton.php

@@ -9,14 +9,12 @@
 
 namespace {{php.package}}{{namespace}};
 
-use AdvancedAds\Framework\Interfaces\WordPress_Integration;
-
 defined( 'ABSPATH' ) || exit;
 
 /**
  * {{heading}}.
  */
-class {{className}} implements WordPress_Integration {
+class {{className}} {
 
 	/**
 	 * Main instance
@@ -34,10 +32,4 @@ class {{className}} implements WordPress_Integration {
 
 		return $instance;
 	}
-
-	/**
-	 * Hook into WordPress.
-	 */
-	public function hooks() {
-	}
 }

package/template/make/file.php

@@ -9,18 +9,10 @@
 
 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() {
-	}
+class {{className}} {
 }

package/template/includes/interfaces/interface-integration.php

@@ -1,23 +0,0 @@
-<?php
-/**
- * An interface for registering integrations with WordPress.
- *
- * @package {{php.package}}
- * @author  {{author.name}} <{{author.email}}>
- * @since   {{wp.version}}
- */
-
-namespace {{php.package}}\Interfaces;
-
-defined( 'ABSPATH' ) || exit;
-
-/**
- * Integration interface.
- */
-interface WordPress_Integration {
-
-	/**
-	 * Hook into WordPress.
-	 */
-	public function hooks();
-}