[FEATURE] Initial commit

Author: bmack

.gitignore

@@ -0,0 +1,3 @@
+/.build/
+/vendor/
+/composer.lock

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2019 Benni Mack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,99 @@
+# TYPO3 Coding Standards Package
+
+You know the feeling: You work on your own extension, and then contribute to TYPO3, and TYPO3 delivers all the nice
+things to check for proper coding standards.
+
+Well, same happens to all of us! Luckily, TYPO3 has this configuration in Core, and it's now available separately
+- ready to plug-and-play for you!
+
+It does not matter if you're an extension developer, or a TYPO3 contributor, or working on your TYPO3 project.
+
+## Installation
+
+As this is a composer package, execute `composer req --dev typo3/coding-standards` in your composer project.
+
+## What's in the package?
+
+The coding guidelines that are used in TYPO3 Core development. Instead of putting this information in our main
+repository, it should be helpful to apply certain rules to other projects as well. TYPO3 is more than just TYPO3 Core!
+
+1. PHP-CS-Fixer rules
+
+Making sure your PHP files apply to the same rules.
+
+2. .editorconfig
+
+If you work on a team, and you use different IDE settings, `.editorconfig` helps you to have the same settings
+across all editors. It does not matter if it is VS-Code, vim or PhpStorm.
+
+3. eslint config
+
+TypeScript rules are also available.
+
+### Setting up the TYPO3 rulesets as boilerplate
+
+Our coding standards file can set this up for you. Run
+
+    php vendor/typo3/coding-standards/setup.php project
+    php vendor/typo3/coding-standards/setup.php extension 
+
+or if you want to update the rules, add `-f` option to the end.
+
+Have a look at the newly created files in your root folder:
+
+- .php_cs 
+- .editorconfig
+
+For projects, the folder `src/extensions` is configured by default, but you can accommodate where your extensions
+or PHP code resides in. For extensions, PHP-CS-Fixer scans the whole base directory.
+
+In addition, you can configure your PHP-CS-Fixer cache file folder and other configurations just like with PHP-CS-Fixer.
+
+
+You can decide to commit them to your Git repository, which is the recommended way.
+
+## Executing the PHP-CS-Fixer
+
+Once you've followed the step above, running PHP CS Fixer works like this:
+
+ composer exec php-cs-fixer
+
+Leave a note on how you set it up on GitHub Actions or GitLab CI/CD so this document can be even more helpful
+for everybody.
+
+
+## What's next?
+
+We'd love to ship out license headers for all PHP files, however there are certain limitations (namespace must
+be underneath the license headers), which why this option is not enabled by default.
+
+## A note about our standards
+
+### PHP Coding Guidelines
+
+TYPO3's coding guidelines have evolved over time. And we are happy to have PHP-FIG and PSR-1/PSR-2 and PSR-12.
+That's why we're committed to following these guidelines.
+
+However, there are some more rules that we think are good:
+
+- Remove leading slashes in use clauses.
+- PHP single-line arrays should not have trailing comma.
+- Single-line whitespace before closing semicolon are prohibited.
+- Remove unused use statements in the PHP source code
+- Ensure Concatenation to have at least one whitespace around
+- Remove trailing whitespace at the end of blank lines.
+
+## Maintaining and Development of this package
+
+This package is not meant to be updated regularly, since talking about coding guidelines takes a lot of time, and
+is usual a matter of taste. Nonetheless, you can always open up an issue if you feel like we're missing out on something.
+
+## License & Thanks
+
+This package is available under the MIT license, since it relies heavily on the PHP-CS-Fixer code.
+
+In addition, I would like to thank the TYPO3 Core Team that kickstarted this set of rules in 2015, and to the
+creators and maintainers of PHP-CS-Fixer package.
+
+Benni Mack
+TYPO3 Project Lead

composer.json

@@ -0,0 +1,24 @@
+{
+	"name": "typo3/coding-standards",
+	"type": "coding-standards",
+	"description": "A set of coding guidelines for any TYPO3-related project or extension",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Benni Mack",
+			"email": "[email protected]"
+		}
+	],
+	"require": {
+        "friendsofphp/php-cs-fixer": "^2.16.0",
+        "php": "^7.2"
+    },
+	"config": {
+		"sort-packages": true
+	},
+	"autoload": {
+		"psr-4": {
+			"TYPO3\\CodingStandards\\": "src/"
+		}
+	}
+}

setup.php

@@ -0,0 +1,19 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types = 1);
+
+$setup = function($scriptPath, string $type = null, $forceOption = null) {
+    $rootPath = getcwd();
+    require $rootPath . '/vendor/autoload.php';
+    $obj = new \TYPO3\CodingStandards\Setup($rootPath);
+    switch ($type) {
+        case 'extension':
+            return $obj->forExtension($forceOption === '-f');
+        case 'project':
+            return $obj->forProject($forceOption === '-f');
+        default:
+            echo "You need to specify at least one option. Use 'extension' or 'project'.\n";
+            exit(1);
+    }
+};
+$setup(...$_SERVER['argv']);

src/CsFixerConfig.php

@@ -0,0 +1,111 @@
+<?php
+declare(strict_types = 1);
+namespace TYPO3\CodingStandards;
+
+/*
+ * This file is part of the TYPO3 project  - inspiring people to share!
+ * (c) 2019 Benni Mack
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+use PhpCsFixer\Config;
+
+class CsFixerConfig extends Config
+{
+    private static $defaultHeader = <<<EOF
+{header}
+
+It is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License, either version 2
+of the License, or any later version.
+
+For the full copyright and license information, please read the
+LICENSE.txt file that was distributed with this source code.
+
+The TYPO3 project - inspiring people to share!
+EOF;
+
+    private static $typo3Rules = [
+        '@DoctrineAnnotation' => true,
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'cast_spaces' => ['space' => 'none'],
+        'concat_space' => ['spacing' => 'one'],
+        'declare_equal_normalize' => ['space' => 'single'],
+        'dir_constant' => true,
+        'function_typehint_space' => true,
+        'hash_to_slash_comment' => true,
+        'lowercase_cast' => true,
+        'modernize_types_casting' => true,
+        'native_function_casing' => true,
+        'no_alias_functions' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'no_empty_phpdoc' => true,
+        'no_empty_statement' => true,
+        'no_extra_consecutive_blank_lines' => true,
+        'no_leading_import_slash' => true,
+        'no_leading_namespace_whitespace' => true,
+        'no_null_property_initialization' => true,
+        'no_short_bool_cast' => true,
+        'no_singleline_whitespace_before_semicolons' => true,
+        'no_superfluous_elseif' => true,
+        'no_trailing_comma_in_singleline_array' => true,
+        'no_unneeded_control_parentheses' => true,
+        'no_unused_imports' => true,
+        'no_useless_else' => true,
+        'no_whitespace_in_blank_line' => true,
+        'ordered_imports' => true,
+        'php_unit_construct' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame'],
+        'php_unit_mock_short_will_return' => true,
+        'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
+        'phpdoc_no_access' => true,
+        'phpdoc_no_empty_return' => true,
+        'phpdoc_no_package' => true,
+        'phpdoc_scalar' => true,
+        'phpdoc_trim' => true,
+        'phpdoc_types' => true,
+        'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
+        'return_type_declaration' => ['space_before' => 'none'],
+        'single_quote' => true,
+        'whitespace_after_comma_in_array' => true
+    ];
+
+    public function __construct($name = 'TYPO3')
+    {
+        parent::__construct($name);
+    }
+
+    public static function create()
+    {
+        /** @var self $obj */
+        $obj = parent::create();
+        $obj->setRiskyAllowed(true);
+        // Apply our rules
+        $obj->setRules(static::$typo3Rules);
+        $obj->getFinder()->exclude(['vendor', 'typo3temp', 'var', '.build']);
+        return $obj;
+    }
+
+    public function addRules(array $rules)
+    {
+        $rules = array_replace_recursive($this->getRules(), $rules);
+        $this->setRules($rules);
+    }
+
+    public function setHeader(string $header = 'This file is part of the TYPO3 CMS project.', $replaceAll = false)
+    {
+        if (!$replaceAll) {
+            $header = str_replace('{header}', $header, static::$defaultHeader);
+        }
+        $rules = $this->getRules();
+        $rules['header_comment'] = [
+            'header' => $header,
+            'commentType' => 'comment',
+            'location' => 'after_declare_strict',
+            'separate' => 'both'
+        ];
+        return parent::setRules($rules);
+    }
+}

src/Setup.php

@@ -0,0 +1,69 @@
+<?php
+declare(strict_types = 1);
+namespace TYPO3\CodingStandards;
+
+/*
+ * This file is part of the TYPO3 project  - inspiring people to share!
+ * (c) 2019 Benni Mack
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+class Setup
+{
+    /**
+     * @var string
+     */
+    private $rootPath;
+
+    /**
+     * @var string
+     */
+    private $templatesPath;
+
+    public function __construct(string $rootPath)
+    {
+        $this->rootPath = $rootPath;
+        $this->templatesPath = dirname(__DIR__) . DIRECTORY_SEPARATOR . 'templates';
+    }
+
+    public function forProject(bool $force): int
+    {
+        $errors = $this->copyEditorConfig($force);
+        // copy php-cs-fixer configuration
+        if (file_exists($this->rootPath . '/.php_cs') && !$force) {
+            echo "A .php_cs file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+            $errors = true;
+        } else {
+            copy($this->templatesPath . '/project_php_cs.dist', $this->rootPath . '/.php_cs');
+        }
+        return $errors ? 1 : 0;
+    }
+
+    public function forExtension(bool $force): int
+    {
+        $errors = $this->copyEditorConfig($force);
+        // copy php-cs-fixer configuration
+        if (file_exists($this->rootPath . '/.php_cs') && !$force) {
+            echo "A .php_cs file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+            $errors = true;
+        } else {
+            copy($this->templatesPath . '/extension_php_cs.dist', $this->rootPath . '/.php_cs');
+        }
+        return $errors ? 1 : 0;
+    }
+
+    private function copyEditorConfig(bool $force): bool
+    {
+        $errors = false;
+        // copy editorconfig
+        if (file_exists($this->rootPath . '/.editorconfig') && !$force) {
+            echo "A .editorconfig file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+            $errors = true;
+        } else {
+            copy($this->templatesPath . '/editorconfig.dist', $this->rootPath . '/.editorconfig');
+        }
+        return $errors;
+    }
+}