chore(NO-TASK): Testing pre-commit

Author: aaronware

.distignore

@@ -42,4 +42,12 @@ output.log
 phpdoc.dist.xml
 release-please-config.json
 docker_tag
-package.json
+package.json
+.eslintrc.js
+.prettierrc.js
+.phpstan.neon.dist.yml
+.phpstan.neon.dist
+.phpstan-baseline.neon
+.phpstan.neon.dist.yml
+.phpstan.neon.dist
+.phpstan-baseline.neon

.husky/pre-commit

@@ -1 +1 @@
-npx lint-staged
+# npx lint-staged

FAQ.md

@@ -1,9 +1,13 @@
-# Frequently Asked Questions #
+# Frequently Asked Questions
 
-## Does this plugin work with Full Page Caching or WordPress Object Caching? ##
+## Does this plugin work with Full Page Caching or WordPress Object Caching?
 
 Yes
 
-## I'm looking for a specific type of notice that courier doesn't have, what's next? ##
+## I'm looking for a specific type of notice that courier doesn't have, what's next?
 
 The great thing is that Courier Notices is highly extendable and our team is adding new features constantly since release. You can always create a pull request in GitHub or add an issue. You can also take a look at the Pro version which also has some great features.
+
+## Is the compatible with the block editor?
+
+No but our next release v2.0.0 will be

composer.json

@@ -2,7 +2,6 @@
 	"name": "linchpin/courier-notices",
 	"description": "Courier Notices, a highly extendable advanced front end notification plugin for WordPress",
 	"homepage": "https://github.com/linchpin/courier-notices",
-	"version": "1.7.1",
 	"authors": [
 		{
 			"name": "Linchpin",
@@ -85,7 +84,8 @@
 		"yoast/phpunit-polyfills": "^4.0",
 		"phpstan/php-8-stubs": "^0.4.0",
 		"phpstan/phpstan-strict-rules": "^1.6",
-		"wpackagist-plugin/plugin-check": "^1.5"
+		"wpackagist-plugin/plugin-check": "^1.5",
+		"php-stubs/wordpress-stubs": "^6.8"
 	},
 	"extra": {
 		"installer-paths": {

composer.lock

@@ -20,15 +20,25 @@
  *
  * @param string       $notice      The notice text.
  * @param string|array $types       The type(s) of notice.
- * @param bool         $global      Whether this notice is global or not.
+ * @param bool         $is_global   Whether this notice is global or not.
  * @param bool         $dismissible Whether this notice is dismissible or not.
  * @param int          $user_id     The ID of the user this notice is for.
+ * @param string       $style       The style of notice.
+ * @param array        $placement   The placement of the notice.
  *
  * @since 1.2.0
  *
  * @return bool|int Return either false or the Post ID for the created courier_notice.
  */
-function courier_notices_add_notice( $notice = '', $types = array( 'Informational' ), $global = false, $dismissible = true, $user_id = 0, $style = 'Informational', $placement = array( 'header' ) ) {
+function courier_notices_add_notice(
+	string $notice = '',
+	array $types = [ 'Informational' ],
+	bool $is_global = false,
+	bool $dismissible = true,
+	int $user_id = 0,
+	string $style = 'Informational',
+	array $placement = [ 'header' ]
+) {
 	$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
 
 	if ( 0 !== $user_id ) {
@@ -70,7 +80,7 @@ function courier_notices_add_notice( $notice = '', $types = array( 'Informationa
 		wp_set_object_terms( $notice_id, $types, 'courier_type', true );
 		wp_set_object_terms( $notice_id, $placement, 'courier_placement', true );
 
-		if ( $global ) {
+		if ( $is_global ) {
 			wp_set_object_terms( $notice_id, array( 'Global' ), 'courier_scope', false );
 
 			// Clear the global notice cache.
@@ -134,12 +144,12 @@ function courier_notices_get_global_notices( $args = array() ) {
  *
  * @since 1.2.0
  *
- * @param array $args     Query Args
+ * @param array $args     Query Args.
  * @param bool  $ids_only Whether to return only IDs.
  *
  * @return array|bool|mixed
  */
-function courier_notices_get_dismissible_global_notices( $args = array(), $ids_only = false ) {
+function courier_notices_get_dismissible_global_notices( array $args = [], bool $ids_only = false ) {
 	$data = new Courier_Notice_Data();
 
 	return $data->get_dismissible_global_notices( $args, $ids_only );
@@ -155,7 +165,7 @@ function courier_notices_get_dismissible_global_notices( $args = array(), $ids_o
  *
  * @return array|bool|mixed
  */
-function courier_notices_get_persistent_global_notices( $args = array() ) {
+function courier_notices_get_persistent_global_notices( array $args = [] ) {
 	$data = new Courier_Notice_Data();
 
 	return $data->get_persistent_global_notices( $args );
@@ -310,24 +320,24 @@ function courier_notices_get_global_dismissed_notices( $user_id = 0 ) {
  * @return bool True if any notices exist, false otherwise.
  */
 function courier_notices_has_any_notices( $user_id = 0 ) {
-	// Check cache first
+	// Check cache first.
 	$cache_key = 'courier_has_notices_' . $user_id;
 	$cached    = wp_cache_get( $cache_key, 'courier-notices' );
-	
+
 	if ( false !== $cached ) {
 		return (bool) $cached;
 	}
-	
-	// Quick check for any published notices
+
+	// Quick check for any published notices.
 	$args = array(
 		'post_type'      => 'courier_notice',
 		'post_status'    => 'publish',
 		'posts_per_page' => 1,
 		'fields'         => 'ids',
 		'no_found_rows'  => true,
 	);
-	
-	// If user ID provided, check for user-specific notices
+
+	// If user ID provided, check for user-specific notices.
 	if ( $user_id ) {
 		$args['tax_query'] = array(
 			'relation' => 'OR',
@@ -343,13 +353,13 @@ function courier_notices_has_any_notices( $user_id = 0 ) {
 			),
 		);
 	}
-	
-	$query      = new WP_Query( $args );
+
+	$query       = new WP_Query( $args );
 	$has_notices = $query->have_posts();
-	
-	// Cache for 5 minutes
+
+	// Cache for 5 minutes.
 	wp_cache_set( $cache_key, $has_notices, 'courier-notices', 300 );
-	
+
 	return $has_notices;
 }
 
@@ -451,7 +461,7 @@ function courier_notices_clear_cache() {
 	// Clear object cache for courier-notices group.
 	wp_cache_flush_group( 'courier-notices' );
 
-	// Clear has_notices cache for all users
+	// Clear has_notices cache for all users.
 	global $wpdb;
 	$wpdb->query(
 		"DELETE FROM {$wpdb->options} WHERE option_name LIKE '_transient_courier_has_notices_%' OR option_name LIKE '_transient_timeout_courier_has_notices_%'"
@@ -518,22 +528,22 @@ function courier_notices_get_css() {
  *
  * @since 1.3.0
  *
- * @param        $title
- * @param string $before
- * @param string $after
- * @param bool   $echo
+ * @param string $title        The title of the notice.
+ * @param string $before       The HTML to display before the title.
+ * @param string $after        The HTML to display after the title.
+ * @param bool   $echo_output  Whether to echo the output or return it.
  *
  * @return mixed|string|void
  */
-function courier_notices_the_notice_title( $title, $before = '', $after = '', $echo = true ) {
+function courier_notices_the_notice_title( $title, $before = '', $after = '', bool $echo_output = true ) {
 	if ( 0 === strlen( $title ) ) {
 		return '';
 	}
 
 	$title = $before . $title . $after;
 	$title = apply_filters( 'courier_notices_the_notice_title', $title );
 
-	if ( $echo ) {
+	if ( $echo_output ) {
 		echo wp_kses_post( $title );
 	} else {
 		return $title;

includes/Helper/Functions.php

@@ -0,0 +1,31 @@
+/**
+ * External dependencies
+ */
+const fs = require("fs");
+
+/**
+ * @type {import('lint-staged').Configuration}
+ */
+const config = {
+	"**/*.{js,ts,mjs}": (filenames) => {
+		// Exclude config files from JS linting
+		const filteredFiles = filenames.filter(
+			(file) =>
+				!file.includes("lint-staged.config.js") &&
+				!file.includes("webpack.config.js") &&
+				!file.includes(".config.js"),
+		);
+		return filteredFiles.length > 0
+			? ["npm run lint-js", () => "npm run tsc"]
+			: [];
+	},
+	// Temporarily disable PHPStan due to memory issues
+	"**/*.php": () => "composer phpstan",
+	"courier-notices.php": "composer lint",
+	// Exclude problematic files from linting for now
+	"*.php": "composer lint",
+	"/tools/**.php": "composer lint",
+	"composer.json": () => "composer validate --strict",
+};
+
+module.exports = config;

lint-staged.config.js

@@ -16,7 +16,7 @@
 		"format-js": "wp-scripts format",
 		"lint-js": "wp-scripts lint-js",
 		"tsc": "tsc",
-		"format-php": "composer format:all",
+		"format-php": "composer format",
 		"phpstan": "composer phpstan",
 		"lint-php": "composer lint:all",
 		"prepare": "husky"
@@ -46,20 +46,5 @@
 	"browserslist": [
 		"defaults"
 	],
-	"private": true,
-	"lint-staged": {
-		"*.js": [
-			"eslint --fix",
-			"prettier --write"
-		],
-		"*.css": [
-			"prettier --write"
-		],
-		"*.scss": [
-			"prettier --write"
-		],
-		"*.php": [
-			"composer format"
-		]
-	}
+	"private": true
 }

package.json

@@ -36,6 +36,9 @@
 	<!-- Exclude the Node Modules directory. -->
 	<exclude-pattern>/node_modules/*</exclude-pattern>
 
+	<!-- Exclude the tools directory. -->
+	<exclude-pattern>./tools/*</exclude-pattern>
+
 	<!-- Exclude minified Javascript files. -->
 	<exclude-pattern>*.min.js</exclude-pattern>