Allow backslashes in hook names (#8)

figuren-theater · Jul 17, 2023 · e44b101 · e44b101
2 parents cf929e5 + 46593fa
commit e44b101
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
     <img src="https://raw.githubusercontent.com/figuren-theater/logos/main/favicon.png" alt="figuren.theater Logo" width="100" height="100">
   </a>
 
-  <h1 align="center">figuren.theater | coding_standards</h1>
+  <h1 align="center">figuren.theater | coding-standards</h1>
 
   <p align="center">
     Coding standards for PHP, JavaScript and CSS within the WordPress Multisite network for puppeteers - <a href="https://figuren.theater">figuren.theater</a>.
@@ -27,50 +27,19 @@
 This is the long desc
 
 * [x] *list closed tracking-issues or `docs` files here*
-* [ ] Do you have any [ideas](/issues/new) ?
+* [ ] Do you have any [ideas](https://github.com/figuren-theater/coding-standards/issues/new) ?
 
 ## Background & Motivation
 
 ...
 
 ## Install
 
-1. Add this repository to your `composer.json`
-```json
-"repositories": [
-    {
-        "type": "git",
-        "url": "https://github.com/figuren-theater/coding-standards"
-    }
-]
-```
+1. Install via command line
+	```sh
+	composer require figuren-theater/coding-standards
+	```
 
-2. Install via command line
-```sh
-composer require figuren-theater/coding-standards
-```
-
-## Usage
-
-### API
-
-```php
-Figuren_Theater::API\get_...()
-```
-
-### Plugins included
-
-This package contains the following plugins. 
-Thoose are completely managed by code and lack of their typical UI.
-
-* ...
-
-
-### What does this package do in addition?
-
-Accompaniying the core functionality of the mentioned plugins, theese **best practices** are included with this package.
-
-* ...
 
 
 ## Built with & uses
@@ -95,18 +64,18 @@ Don't forget to give the project a star! Thanks again!
 ## Versioning
 
 We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
-available, see the [tags on this repository](/tags).
+available, see the [tags on this repository](https://github.com/figuren-theater/coding-standards/tags).
 
 ## Authors
 
   - **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)
 
-See also the list of [contributors](/contributors)
+See also the list of [contributors](https://github.com/figuren-theater/coding-standards/contributors)
 who participated in this project.
 
 ## License
 
-This project is licensed under the [GPL-3.0-or-later](LICENSE.md), see the [LICENSE](LICENSE) file for
+This project is licensed under the **GPL-3.0-or-later**, see the [LICENSE](/LICENSE) file for
 details
 
 ## Acknowledgments

diff --git a/composer.json b/composer.json
@@ -6,7 +6,8 @@
 	"keywords": [
 		"wordpress",
 		"coding-standards",
-		"wpcs"
+		"wpcs",
+		"WordPressVIPMinimum"
 	],
 	"authors": [
 		{

diff --git a/figurentheater/ruleset.xml b/figurentheater/ruleset.xml
@@ -2,8 +2,6 @@
 <ruleset name="figurentheater">
 	<description>Coding standards for figuren.theater</description>
 
-	<file>.</file>
-
 	<exclude-pattern>*/bin/*</exclude-pattern>
 	<exclude-pattern>*/tests/*</exclude-pattern>
 	<exclude-pattern>*/vendor/*</exclude-pattern>
@@ -29,6 +27,11 @@
 		</properties>
 	</rule>
 
+	<!-- Allow backslashes in hook names -->
+	<rule ref="WordPress.NamingConventions.ValidHookName">
+		<exclude name="WordPress.NamingConventions.ValidHookName.UseUnderscores" />
+	</rule>
+
 	<!-- Prevent deprecation notice when the sniff is not explicitely included. -->
 	<!-- 11.11.2019: 2.2.0: "The deprecated sniff will be removed in WPCS 3.0.0." ;) -->
 	<rule ref="WordPress.WP.TimezoneChange.DeprecatedSniff">