NEW figuren-theater/code-quality (1.1.1) (#28)

figuren-theater · Feb 28, 2024 · 3281e08 · 3281e08
2 parents 8d2d984 + b5754c0
commit 3281e08
Show file tree

Hide file tree

Showing 26 changed files with 2,498 additions and 602 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -9,14 +9,15 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
 indent_style = tab
 indent_size = 4
+insert_final_newline = true
+tabSize = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
 
-[{.jshintrc,*.json,*.yml}]
+[{*.json,*.yml}]
 indent_style = space
 indent_size = 2
-
-[{*.txt,wp-config-sample.php}]
-end_of_line = crlf
diff --git a/.github/workflows/build-test-measure.yml b/.github/workflows/build-test-measure.yml
@@ -0,0 +1,13 @@
+name: Build, test & measure
+
+on:
+  workflow_call:
+  pull_request:
+  push:
+    branches:
+      ['main']
+
+jobs:
+  call-workflow-build-test-measure:
+    uses: figuren-theater/code-quality/.github/workflows/build-test-measure.yml@main
+    secrets: inherit
diff --git a/.github/workflows/prerelease-changelog.yml b/.github/workflows/prerelease-changelog.yml
@@ -0,0 +1,12 @@
+name: 'pre-Release Changelog Update'
+
+on:
+  workflow_call:
+  release:
+    types: [prereleased]
+
+jobs:
+  call-workflow-update-changelog:
+    uses: figuren-theater/.github/.github/workflows/prerelease-changelog-update.yml@main
+    secrets: inherit
+
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -0,0 +1,19 @@
+name: Draft or update the next release
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+jobs:
+  call-workflow-release-drafter:
+    uses: figuren-theater/.github/.github/workflows/release-drafter.yml@main
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,23 @@
-.DS_Store
-phpcs.xml
-phpunit.xml
-Thumbs.db
-wp-cli.local.yml
-node_modules/
+/build/
+/node_modules
+/vendor
 *.sql
 *.tar.gz
 *.zip
+/wiki
+.vscode
+
+# Generated via bin/transform-readme.php
+/readme.txt
+/.wp-env.override.json
+
+# misc
+.DS_Store
+Thumbs.db
 
+# is created during composer install,
+# when package is tested
+# and not running within ft-platform
 /vendor/
 /wordpress/
 /wp-content/
diff --git a/.phpcs.xml b/.phpcs.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<ruleset name="ft-onboarding">
+	<description>Coding standards for ft-onboarding</description>
+
+	<file>.</file>
+	<arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit -->
+
+	<!--
+	is created during composer install,
+	when package is tested
+	and not running within ft-platform
+	-->
+	<exclude-pattern>*/vendor/*</exclude-pattern>
+	<exclude-pattern>*/wordpress/*</exclude-pattern>
+	<exclude-pattern>*/wp-content/*</exclude-pattern>
+
+	<!-- Do not check this external ressource. -->
+	<exclude-pattern>inc/sites/wp_dropdown_posts/*</exclude-pattern>
+
+	<!-- Rules: figuren.theater Coding Standards -->
+	<rule ref="figurentheater" />
+
+</ruleset>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased](https://github.com/figuren-theater/ft-onboarding/compare/1.4.0...HEAD)
+
+
+
diff --git a/README.md b/README.md
@@ -27,28 +27,18 @@
 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/ft-onboarding/issues/new) ?
 
 ## Background & Motivation
 
 ...
 
 ## Install
 
-1. Add this repository to your `composer.json`
-```json
-"repositories": [
-    {
-        "type": "git",
-        "url": "https://github.com/figuren-theater/ft-onboarding"
-    }
-]
-```
-
-2. Install via command line
-```sh
-composer require figuren-theater/ft-onboarding
-```
+1. Install via command line
+  ```sh
+  composer require figuren-theater/ft-onboarding
+  ```
 
 ### Plugins included
 
@@ -77,6 +67,8 @@ Accompaniying the core functionality of the mentioned plugins, theese **best pra
 ## Built with & uses
 
   - [dependabot](/.github/dependabot.yml)
+  - [code-quality](https://github.com/figuren-theater/code-quality/)
+     A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
   - ....
 
 ## Contributing
@@ -96,13 +88,13 @@ 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/ft-onboarding/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/ft-onboarding/contributors)
 who participated in this project.
 
 ## License

diff --git a/composer.json b/composer.json
@@ -1,92 +1,99 @@
 {
 	"name": "figuren-theater/ft-onboarding",
 	"description": "Onboarding of new users, site- and user creation for a WordPress Multisite network like figuren.theater.",
-    "homepage": "https://websites.fuer.figuren.theater",
-    "type": "wordpress-muplugin",
-    "keywords": ["wordpress", "users", "onboarding", "registration"],
-    "license": "GPL-3.0-or-later",
-    "authors": [
-        {
-            "name": "figuren.theater",
-            "email": "[email protected]"
-        },
-        {
-            "name": "Carsten Bach",
-            "email": "[email protected]",
-            "homepage": "https://carsten-bach.de",
-            "role": "Developer"
-        }
-    ],
-    "support": {
-        "email": "[email protected]",
-        "issues": "https://github.com/figuren-theater/ft-onboarding/issues",
-        "source": "https://github.com/figuren-theater/ft-onboarding"
-    },
-	"autoload": {
-		"files": [
-			"inc/ft-core-block-domaincheck/namespace.php",
-            "inc/preferred-languages/namespace.php",
-            "inc/impressum/namespace.php",
-            "inc/sites/installation.php",
-            "inc/sites/registration.php",
-            "inc/sites/namespace.php",
-            "inc/users/namespace.php",
-            "inc/wp-approve-user/namespace.php",
-            "inc/wp-multi-network/namespace.php",
-            "inc/wp-user-profiles/namespace.php",
-			"inc/namespace.php"
-		],
-        "classmap": [
-            "inc/"
-        ]
+	"license": "GPL-3.0-or-later",
+	"type": "wordpress-muplugin",
+	"keywords": [
+		"wordpress",
+		"users",
+		"onboarding",
+		"registration"
+	],
+	"authors": [
+		{
+			"name": "figuren.theater",
+			"email": "[email protected]"
+		},
+		{
+			"name": "Carsten Bach",
+			"email": "[email protected]",
+			"homepage": "https://carsten-bach.de",
+			"role": "Developer"
+		}
+	],
+	"homepage": "https://websites.fuer.figuren.theater",
+	"support": {
+		"email": "[email protected]",
+		"issues": "https://github.com/figuren-theater/ft-onboarding/issues",
+		"source": "https://github.com/figuren-theater/ft-onboarding"
+	},
+	"require": {
+		"php": ">=7.1",
+		"figuren-theater/ft-core-block-domaincheck": "0.1.2",
+		"figuren-theater/ft-options": "*",
+		"figuren-theater/install.php": "1.1.0",
+		"stuttter/wp-multi-network": "2.5.2",
+		"stuttter/wp-user-profiles": "2.6.2",
+		"wpackagist-plugin/impressum": "2.0.3",
+		"wpackagist-plugin/preferred-languages": "2.0.1",
+		"wpackagist-plugin/wp-approve-user": "11"
+	},
+	"require-dev": {
+		"figuren-theater/code-quality": "^1.1"
 	},
 	"repositories": [
 		{
-            "type": "git",
-            "url": "https://github.com/figuren-theater/ft-options"
-        },
-        {
-            "type": "git",
-            "url": "https://github.com/figuren-theater/ft-core-block-domaincheck"
-        },
-        {
-            "type": "git",
-            "url": "https://github.com/figuren-theater/install.php"
-        },
+			"type": "git",
+			"url": "https://github.com/figuren-theater/ft-core-block-domaincheck"
+		},
+		{
+			"type": "git",
+			"url": "https://github.com/figuren-theater/install.php"
+		},
 		{
 			"type": "composer",
-			"url" : "https://wpackagist.org"
+			"url": "https://wpackagist.org"
 		}
 	],
-	"require": {
-        "php": ">=7.1",
-        "figuren-theater/ft-options": "*",
-        "figuren-theater/ft-core-block-domaincheck": "0.1.2",
-        "figuren-theater/install.php": "1.1.0",
-        "stuttter/wp-user-profiles": "2.6.2",
-        "stuttter/wp-multi-network":"2.5.2",
-        "wpackagist-plugin/impressum":"2.0.3",
-        "wpackagist-plugin/preferred-languages":"2.0.1",
-        "wpackagist-plugin/wp-approve-user": "11"
+	"autoload": {
+		"classmap": [
+			"inc/"
+		],
+		"files": [
+			"inc/ft-core-block-domaincheck/namespace.php",
+			"inc/preferred-languages/namespace.php",
+			"inc/impressum/namespace.php",
+			"inc/sites/installation.php",
+			"inc/sites/registration.php",
+			"inc/sites/namespace.php",
+			"inc/users/namespace.php",
+			"inc/wp-approve-user/namespace.php",
+			"inc/wp-multi-network/namespace.php",
+			"inc/wp-user-profiles/namespace.php",
+			"inc/namespace.php"
+		]
 	},
-    "extra": {
-        "altis": {
-            "install-overrides": [
-                "figuren-theater/ft-core-block-domaincheck",
-                "figuren-theater/install.php",
-                "stuttter/wp-multi-network",
-                "stuttter/wp-user-profiles",
-                "wpackagist-plugin/impressum",
-                "wpackagist-plugin/preferred-languages",
-                "wpackagist-plugin/wp-approve-user"
-            ]
-        }
-    },
 	"config": {
 		"allow-plugins": {
 			"composer/installers": true,
+			"dealerdirect/phpcodesniffer-composer-installer": true,
+			"ergebnis/composer-normalize": true,
 			"johnpbloch/wordpress-core-installer": true,
-			"koodimonni/composer-dropin-installer": true
+			"koodimonni/composer-dropin-installer": true,
+			"phpstan/extension-installer": true
+		}
+	},
+	"extra": {
+		"altis": {
+			"install-overrides": [
+				"figuren-theater/ft-core-block-domaincheck",
+				"figuren-theater/install.php",
+				"stuttter/wp-multi-network",
+				"stuttter/wp-user-profiles",
+				"wpackagist-plugin/impressum",
+				"wpackagist-plugin/preferred-languages",
+				"wpackagist-plugin/wp-approve-user"
+			]
 		}
 	}
 }