Establish quality standards (#10)

figuren-theater · Aug 29, 2023 · 4bc2f62 · 4bc2f62
2 parents fe46cb3 + 2ddc98a
commit 4bc2f62
Show file tree

Hide file tree

Showing 19 changed files with 1,981 additions and 288 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -8,15 +8,15 @@ root = true
 
 [*]
 charset = utf-8
+indent_style = tab
+indent_size = 4
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
-indent_style = tab
-indent_size = 4
 
-[{.jshintrc,*.json,*.yml}]
+[*.md]
+trim_trailing_whitespace = false
+
+[{*.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/ft-issue-gardening.yml b/.github/workflows/ft-issue-gardening.yml
@@ -0,0 +1,10 @@
+name: Issue gardening for figuren.theater
+
+on:
+  issues:
+    types:
+      - opened
+jobs:
+  call-workflow-ft-issue-gardening:
+    uses: figuren-theater/.github/.github/workflows/issue-gardening.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,11 +1,21 @@
-.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
 
-/vendor/
+# is created during composer install,
+# when package is tested
+# and not running within ft-platform
+/wp-content/
diff --git a/.phpcs.xml b/.phpcs.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<ruleset name="ft-media">
+	<description>Coding standards for ft-media</description>
+
+	<file>.</file>
+
+	<!--
+	<exclude-pattern>*/bin/*</exclude-pattern>
+	<exclude-pattern>*/tests/*</exclude-pattern>
+	<exclude-pattern>*/vendor/*</exclude-pattern> -->
+
+	<!--
+	is created during composer install,
+	when package is tested
+	and not running within ft-platform
+	-->
+	<exclude-pattern>*/wp-content/*</exclude-pattern>
+
+	<!-- Use figuren.theater Coding Standards -->
+	<rule ref="figurentheater" />
+
+	<!--
+	<rule ref="WordPress.WP.I18n">
+		<properties>
+			<property name="text_domain" type="array">
+				<element value="figurentheater"/>
+			</property>
+		</properties>
+	</rule> -->
+
+</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-media/compare/1.0.15...HEAD)
+
+
+
diff --git a/README.md b/README.md
@@ -21,34 +21,24 @@
   </p>
 </div>
 
-## About 
+## About
 
 
 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-media/issues/new) ?
 
 ## Background & Motivation
 
 ...
 
 ## Install
 
-1. Add this repository to your `composer.json`
-```json
-"repositories": [
-    {
-        "type": "git",
-        "url": "https://github.com/figuren-theater/ft-media"
-    }
-]
-```
-
-2. Install via command line
-```sh
-composer require figuren-theater/ft-media
-```
+1. Install via command line
+	```sh
+	composer require figuren-theater/ft-media
+	```
 
 ## Usage
 
@@ -60,7 +50,7 @@ Figuren_Theater::API\get_...()
 
 ### Plugins included
 
-This package contains the following plugins. 
+This package contains the following plugins.
 Thoose are completely managed by code and lack of their typical UI.
 
 * [Attachment Taxonomies](https://wordpress.org/plugins/attachment-taxonomies/#developers)
@@ -79,6 +69,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
@@ -98,18 +90,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/ft-media/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-media/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
@@ -1,64 +1,82 @@
 {
 	"name": "figuren-theater/ft-media",
 	"description": "Optimizations related to media & attachments, packed for a WordPress multisite network like figuren.theater",
-    "homepage": "https://websites.fuer.figuren.theater",
-    "type": "wordpress-muplugin",
-    "keywords": ["wordpress", "attachments", "media", "uploads", "image compression", "webp"],
-    "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-media/issues",
-        "source": "https://github.com/figuren-theater/ft-media"
-    },
+	"license": "GPL-3.0-or-later",
+	"type": "wordpress-muplugin",
+	"keywords": [
+		"wordpress",
+		"attachments",
+		"media",
+		"uploads",
+		"image compression",
+		"webp"
+	],
+	"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-media/issues",
+		"source": "https://github.com/figuren-theater/ft-media"
+	},
+	"require": {
+		"php": ">=7.1",
+		"figuren-theater/ft-options": "^1",
+		"wpackagist-plugin/attachment-taxonomies": "^1",
+		"wpackagist-plugin/format-media-titles": "1.0.0",
+		"wpackagist-plugin/modern-images-wp": "^1"
+	},
+	"require-dev": {
+		"figuren-theater/code-quality": "^0.6.7"
+	},
+	"repositories": [
+		{
+			"type": "git",
+			"url": "https://github.com/figuren-theater/ft-options"
+		},
+		{
+			"type": "composer",
+			"url": "https://wpackagist.org"
+		}
+	],
 	"autoload": {
+		"classmap": [
+			"inc/"
+		],
 		"files": [
 			"inc/attachment-taxonomies/namespace.php",
 			"inc/auto-featured-image/namespace.php",
 			"inc/format-media-titles/namespace.php",
 			"inc/image-optimization/namespace.php",
 			"inc/modern-images-wp/namespace.php",
 			"inc/namespace.php"
-		],
-        "classmap": [
-            "inc/"
-        ]
+		]
 	},
-	"repositories": [
-		{
-            "type": "git",
-            "url": "https://github.com/figuren-theater/ft-options"
-        },
-		{
-			"type": "composer",
-			"url" : "https://wpackagist.org"
+	"config": {
+		"allow-plugins": {
+			"composer/installers": true,
+			"phpstan/extension-installer": true,
+			"dealerdirect/phpcodesniffer-composer-installer": true,
+			"ergebnis/composer-normalize": true
 		}
-	],
-	"require": {
-        "php": ">=7.1",
-        "figuren-theater/ft-options": "^1",
-        "wpackagist-plugin/attachment-taxonomies": "^1",
-        "wpackagist-plugin/format-media-titles":"1.0.0",
-        "wpackagist-plugin/modern-images-wp":"^1"
 	},
-    "extra": {
-        "altis": {
-            "install-overrides": [
-                "wpackagist-plugin/attachment-taxonomies",
-            	"wpackagist-plugin/format-media-titles",
-            	"wpackagist-plugin/modern-images-wp"
-            ]
-        }
-    }
+	"extra": {
+		"altis": {
+			"install-overrides": [
+				"wpackagist-plugin/attachment-taxonomies",
+				"wpackagist-plugin/format-media-titles",
+				"wpackagist-plugin/modern-images-wp"
+			]
+		}
+	}
 }