Establish quality standards (#13)

.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

.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

.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

.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
+

.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

.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/

.phpcs.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<ruleset name="ft-seo">
+	<description>Coding standards for ft-seo</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>*/wp-content/*</exclude-pattern>
+
+	<!-- Rules: figuren.theater Coding Standards -->
+	<rule ref="figurentheater" />
+
+</ruleset>

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-seo/compare/1.1.0...HEAD)
+
+
+

README.md

@@ -21,7 +21,7 @@
   </p>
 </div>
 
-## About 
+## About
 
 
 This is the long desc
@@ -60,7 +60,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.
 
 * [Yoast SEO](https://wordpress.org/plugins/wordpress-seo/#developers)
@@ -108,7 +108,7 @@ 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

composer.json

@@ -1,10 +1,14 @@
 {
     "name": "figuren-theater/ft-seo",
     "description": "Integrations dedicated to search engines and social media plattforms for all sites of the WordPress multisite network figuren.theater",
-    "homepage": "https://websites.fuer.figuren.theater",
-    "type": "wordpress-muplugin",
-    "keywords": ["wordpress", "seo", "sitemaps", "opengraph"],
     "license": "GPL-3.0-or-later",
+    "type": "wordpress-muplugin",
+    "keywords": [
+        "wordpress",
+        "seo",
+        "sitemaps",
+        "opengraph"
+    ],
     "authors": [
         {
             "name": "figuren.theater",
@@ -17,12 +21,34 @@
             "role": "Developer"
         }
     ],
+    "homepage": "https://websites.fuer.figuren.theater",
     "support": {
         "email": "[email protected]",
         "issues": "https://github.com/figuren-theater/ft-seo/issues",
         "source": "https://github.com/figuren-theater/ft-seo"
     },
+    "require": {
+        "php": ">=7.1",
+        "figuren-theater/ft-options": "*",
+        "wpackagist-plugin/sharing-image": "^2.0",
+        "wpackagist-plugin/wordpress-seo": "19.8"
+    },
+    "require-dev": {
+        "figuren-theater/code-quality": "^1.1"
+    },
+    "suggest": {
+        "figuren-theater/ft-media": "Contains the mandatory function to shrink and minify images."
+    },
+    "repositories": [
+        {
+            "type": "composer",
+            "url": "https://wpackagist.org"
+        }
+    ],
     "autoload": {
+        "classmap": [
+            "inc/"
+        ],
         "files": [
             "inc/sharing-image/admin-ui.php",
             "inc/sharing-image/frontend.php",
@@ -34,26 +60,15 @@
             "inc/wordpress-seo/options.php",
             "inc/wordpress-seo/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,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "ergebnis/composer-normalize": true,
+            "phpstan/extension-installer": true
         }
-    ],
-    "require": {
-        "php": ">=7.1",
-        "figuren-theater/ft-options": "^1",
-        "wpackagist-plugin/sharing-image": "^2.0",
-        "wpackagist-plugin/wordpress-seo": "^19.8"
     },
     "extra": {
         "altis": {