[FEATURE] First working prototype

* CLI interface
* Basic syntax check
* Component structure check (with strict option)
* Parameter naming check (patterns, length)
* Parameter count (min/max)
* Used variables check

Author: s2b

.ecrc

@@ -0,0 +1,21 @@
+{
+    "Verbose": false,
+    "Debug": false,
+    "IgnoreDefaults": false,
+    "SpacesAftertabs": false,
+    "NoColor": false,
+    "Exclude": [
+        "vendor",
+        ".git",
+        ".DS_Store",
+        "node_modules"
+    ],
+    "AllowedContentTypes": [],
+    "PassedFiles": [],
+    "Disable": {
+        "EndOfLine": false,
+        "Indentation": false,
+        "InsertFinalNewline": false,
+        "TrimTrailingWhitespace": false
+    }
+}

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_style = unset
+
+[LICENSE]
+indent_style = unset

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock

composer.json

@@ -0,0 +1,44 @@
+{
+    "name": "sitegeist/fluid-components-linter",
+    "description": "Tool to validate fluid components based on a specified ruleset",
+    "homepage": "https://github.com/sitegeist/fluid-components-linter",
+    "license": "GPL-2.0-or-later",
+    "authors": [
+        {
+            "name": "Simon Praetorius",
+            "email": "[email protected]"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/sitegeist/fluid-components-linter/issues"
+    },
+    "require": {
+        "php": ">=7.2.0 <8",
+        "symfony/config": "^4.4 || ^5.0",
+        "symfony/console": "^4.4 || ^5.0",
+        "typo3fluid/fluid": "^2.6"
+    },
+    "require-dev": {
+        "editorconfig-checker/editorconfig-checker": "^10.0",
+        "squizlabs/php_codesniffer": "^3.0",
+        "phpunit/phpunit": "^9.2",
+        "symfony/var-dumper": "^5.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "Sitegeist\\FluidComponentsLinter\\": "src/Classes/"
+        }
+    },
+    "bin": [
+        "bin/fclint"
+    ],
+    "scripts": {
+        "lint": [
+            "@lint:php",
+            "@lint:editorconfig"
+        ],
+        "lint:php": "phpcs --standard=PSR2 --extensions=php --exclude=Generic.Files.LineLength --ignore='vendor' .",
+        "lint:editorconfig": "ec .",
+        "test": "phpunit tests/"
+    }
+}

fclint

@@ -0,0 +1,4 @@
+#!/usr/bin/env php
+<?php
+
+require __DIR__.'/src/FcLint.php';

fclint.json

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+namespace Sitegeist\FluidComponentsLinter\CodeQuality\Check;
+
+use Sitegeist\FluidComponentsLinter\CodeQuality\Component;
+use Sitegeist\FluidComponentsLinter\Service\FluidService;
+
+abstract class AbstractCheck implements CheckInterface
+{
+    protected $component;
+    protected $configuration;
+    protected $fluidService;
+
+    public function __construct(Component $component, array $configuration)
+    {
+        $this->component = $component;
+        $this->configuration = $configuration;
+
+        $this->fluidService = new FluidService;
+    }
+}

src/Classes/CodeQuality/Check/AbstractCheck.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace Sitegeist\FluidComponentsLinter\CodeQuality\Check;
+
+use Sitegeist\FluidComponentsLinter\CodeQuality\Component;
+
+interface CheckInterface
+{
+    public function __construct(Component $component, array $configuration);
+    public function check(): array;
+}

src/Classes/CodeQuality/Check/CheckInterface.php

@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+
+namespace Sitegeist\FluidComponentsLinter\CodeQuality\Check;
+
+use Sitegeist\FluidComponentsLinter\CodeQuality\Component;
+use Sitegeist\FluidComponentsLinter\Exception\CodeQualityException;
+use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ObjectAccessorNode;
+use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;
+
+class ComponentVariablesCheck extends AbstractCheck
+{
+    protected $predefinedVariables = [
+        'settings(\.|$)',
+        'class$',
+        'content$',
+        'component\.(class|prefix|namespace)$'
+    ];
+
+    public function check(): array
+    {
+        $allowedVariables = array_merge($this->predefinedVariables, $this->generateParamNamePatterns());
+        $allowedVariablesPattern = '#^(' . implode('|', $allowedVariables) . ')#';
+
+        $usedVariables = $this->fluidService->extractNodeType(
+            $this->component->rootNode,
+            ObjectAccessorNode::class
+        );
+        $usedVariableNames = array_map(function (ObjectAccessorNode $node) {
+            return $node->getObjectPath();
+        }, $usedVariables);
+
+        $invalidVariables = array_filter(
+            $usedVariableNames,
+            function (string $usedVariable) use ($allowedVariablesPattern) {
+                return !preg_match($allowedVariablesPattern, $usedVariable);
+            }
+        );
+
+        if (!empty($invalidVariables)) {
+            throw new CodeQualityException(sprintf(
+                'The following variables are used in the component, but were never defined: %s',
+                '{' . implode('}, {', $invalidVariables) . '}'
+            ), 1595870402);
+        }
+
+        return [];
+    }
+
+    protected function generateParamNamePatterns(): array
+    {
+        return array_map(function (ViewHelperNode $node) {
+            return preg_quote((string) $node->getArguments()['name'], '#') . '(\.|$)';
+        }, $this->component->paramNodes);
+    }
+}

src/Classes/CodeQuality/Check/ComponentVariablesCheck.php

@@ -0,0 +1,32 @@
+<?php
+declare(strict_types=1);
+
+namespace Sitegeist\FluidComponentsLinter\CodeQuality\Check;
+
+use Sitegeist\FluidComponentsLinter\Exception\CodeQualityException;
+
+class ParamCountCheck extends AbstractCheck
+{
+    public function check(): array
+    {
+        $count = $this->configuration['params']['count'];
+
+        if (count($this->component->paramNodes) > $count['max']) {
+            throw new CodeQualityException(sprintf(
+                'The component has %d parameters, but only %d are allowed.',
+                count($this->component->paramNodes),
+                $count['max']
+            ));
+        }
+
+        if (count($this->component->paramNodes) < $count['min']) {
+            throw new CodeQualityException(sprintf(
+                'The component has %d parameters, but at least %d are required.',
+                count($this->component->paramNodes),
+                $count['min']
+            ));
+        }
+
+        return [];
+    }
+}