Issue/courier 1006

.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

.editorconfig

@@ -1,12 +1,31 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+# WordPress Coding Standards
+# http://make.wordpress.org/core/handbook/coding-standards/
+
 root = true
 
 [*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+tab_width = 4
 indent_style = tab
-indent_size = 2
+insert_final_newline = true
 trim_trailing_whitespace = true
 
-[*.{php,js,css,scss}]
-end_of_line = lf
-insert_final_newline = false
-indent_style = tab
-indent_size = 4
+[*\.txt]
+trim_trailing_whitespace = false
+
+[*\.{json,yml,yaml,xml,xml\.dist,eslintrc}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false
+
+[*\.svg]
+insert_final_newline = false

.eslintignore

@@ -0,0 +1,3 @@
+/build
+/node_modules
+/js

.eslintrc.js

@@ -0,0 +1,27 @@
+/**
+ * External dependencies
+ */
+const wpConfig = require('@wordpress/scripts/config/.eslintrc.js');
+
+const config = {
+	...wpConfig,
+	rules: {
+		...(wpConfig?.rules || {}),
+		'jsdoc/valid-types': 'off',
+		'import/no-unresolved': ['error'],
+	},
+	env: {
+		browser: true,
+	},
+	ignorePatterns: [
+		'/vendor',
+		'/node_modules',
+		'/build',
+		'/dist',
+		'/tools',
+		'/tests',
+		'/**/*.min.js',
+	],
+};
+
+module.exports = config;

.github/workflows/phpcbf.yml

@@ -74,7 +74,7 @@ jobs:
           signoff: false
           branch: phpcbf-${{ github.run_id }}-${{ github.run_attempt }}
           delete-branch: true
-          title: "Auto Fix Formatting - ${{ github.run_id }}"
+          title: 'Auto Fix Formatting - ${{ github.run_id }}'
           body: |
             ${{ steps.read_report.outputs.report }}
           labels: |

.github/workflows/phpcs.yml

@@ -32,7 +32,7 @@ jobs:
         uses: rtCamp/action-phpcs-code-review@v3.1.1
         env:
           GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
-          SKIP_FOLDERS: ".deployment,.github,assets,css,js,lib,sourcedata,wsdl,vendor"
-          PHPCS_STANDARD_FILE_NAME: "phpcs.xml"
+          SKIP_FOLDERS: '.deployment,.github,assets,css,js,lib,sourcedata,wsdl,vendor'
+          PHPCS_STANDARD_FILE_NAME: 'phpcs.xml'
         with:
-          args: "WordPress,WordPress-Core,WordPress-Extra"
+          args: 'WordPress,WordPress-Core,WordPress-Extra'

.github/workflows/release-please.yml

@@ -23,7 +23,7 @@ jobs:
 
   # Update the readme but only when it's creating a new release, not during the build
   update-readme:
-    needs: [ release-please ]
+    needs: [release-please]
     if: github.event_name != 'pull_request' && github.event.pull_request.merged != true && ! needs.release-please.outputs.release_created
     uses: linchpin/actions/.github/workflows/update-readme.yml@v3
     secrets: inherit

.github/workflows/wiki.yml

@@ -1,6 +1,7 @@
 on:
   push:
     branches:
+      - main
       - master
       - '!release-please-*'
       - '!renovate/*'
@@ -37,4 +38,4 @@ jobs:
           WIKI_DIR: wiki/
           GH_TOKEN: ${{ secrets.GH_WIKI_UPDATE_TOKEN }}
           GH_MAIL: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
-          GH_NAME: ${{ github.repository_owner }}
+          GH_NAME: ${{ github.repository_owner }}

.github/workflows/wordpress.yml

@@ -25,7 +25,7 @@ jobs:
         uses: php-actions/composer@v6
         with:
           dev: no
-          php_version: "7.4"
+          php_version: '7.4'
 
       - name: Install Yarn Dependencies
         run: |
@@ -34,7 +34,7 @@ jobs:
           rm -rf node_modules
 
       - name: Clean Build Files/Folders
-        run : |
+        run: |
           chmod +x ./.deployment/cleanup.sh
           sh ./.deployment/cleanup.sh;
 
@@ -50,6 +50,3 @@ jobs:
         env:
           SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
           SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
-
-
-

.gitignore

@@ -24,3 +24,4 @@ Session.vim
 Thumbs.db
 Desktop.ini
 vendor
+vendor-prefixed

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1 

.husky/pre-commit

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

.php-cs-fixer.cache

@@ -0,0 +1 @@
+{"php":"8.4.5","version":"3.84.0:v3.84.0#38dad0767bf2a9b516b976852200ae722fe984ca","indent":"    ","lineEnding":"\n","rules":{"octal_notation":true,"clean_namespace":true,"no_unset_cast":true,"assign_null_coalescing_to_coalesce_equal":true,"normalize_index_brace":true,"short_scalar_cast":true,"heredoc_indentation":true,"no_whitespace_before_comma_in_array":{"after_heredoc":true},"trailing_comma_in_multiline":{"after_heredoc":true},"list_syntax":{"syntax":"short"},"visibility_required":true,"ternary_to_null_coalescing":true,"array_syntax":{"syntax":"short"},"native_constant_invocation":true,"native_function_casing":true,"native_function_invocation":true,"native_type_declaration_casing":true},"hashes":{"includes\/Controller\/Cron.php":"05b3ab71d8472fb9a005d933912d586e"}}

.php-cs-fixer.dist.php

@@ -13,8 +13,6 @@
 $finder = PhpCsFixer\Finder::create()->in(
 	[
 		__DIR__ . '/includes/',
-		__DIR__ . '/blocks/src/',
-		__DIR__ . '/blocks/src-iapi/',
 	]
 );
 
@@ -28,6 +26,8 @@
 		'native_function_casing'         => true,
 		'native_function_invocation'     => true,
 		'native_type_declaration_casing' => true,
+		'array_syntax'                   => [ 'syntax' => 'short' ],
+		'list_syntax'                    => [ 'syntax' => 'short' ],
 	]
 );
 $config->setFinder( $finder );

.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+	...require('@wordpress/prettier-config'),
+	overrides: [
+		{
+			files: ['*.yml', '*.yaml'],
+			options: { tabWidth: 2, useTabs: false },
+		},
+	],
+};

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
 	".": "1.7.1"
-}
+}

.vscode/settings.json

@@ -0,0 +1,28 @@
+{
+	"editor.formatOnSave": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "explicit",
+		"source.organizeImports": "explicit"
+	},
+	"[php]": {
+		"editor.defaultFormatter": "junstyle.php-cs-fixer",
+		"editor.formatOnSave": true
+	},
+	"[javascript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode",
+		"editor.formatOnSave": true
+	},
+	"[typescript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode",
+		"editor.formatOnSave": true
+	},
+	"[json]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode",
+		"editor.formatOnSave": true
+	},
+	"php-cs-fixer.executablePath": "./vendor/bin/php-cs-fixer",
+	"php-cs-fixer.config": ".php-cs-fixer.dist.php",
+	"php-cs-fixer.onsave": true,
+	"php-cs-fixer.autoExecutable": true,
+	"prettier.configPath": "package.json"
+}

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