feat: add css at-rule lint

Signed-off-by: Emilien Escalle <[email protected]>

Author: neilime

.github/workflows/update-css-referential.yml

@@ -21,14 +21,8 @@ jobs:
         with:
           php-version: 8.3
 
-      - name: Run CSS Referential Scraper
-        run: php bin/css-referential-scraper
-
-      - name: Run CSS Referential Generator
-        run: php bin/css-referential-generator
-
-      - name: Run PHP CS Fixer
-        run: composer php-cs-fixer:fix
+      - name: Generate CSS Referential
+        run: composer run-script generate-css-referential
 
       - name: Push changes and create pull request
         uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8

Makefile

@@ -34,9 +34,18 @@ test-load-fixtures: ## Execute tests and load fixtures for given PHP version
 	@$(call run-php,composer test:load-fixtures $(filter-out $@,$(MAKECMDGOALS)))
 
 lint: ## Execute lint for given PHP version
-	@$(call run-php,composer php-cs-fixer $(filter-out $@,$(MAKECMDGOALS)))
+	$(MAKE) php-cs-fixer $(filter-out $@,$(MAKECMDGOALS))
+	$(MAKE) rector $(filter-out $@,$(MAKECMDGOALS))
+	$(MAKE) phpstan $(filter-out $@,$(MAKECMDGOALS))
 
 lint-fix: ## Execute lint fixing for given PHP version
+	$(MAKE) php-cs-fixer-fix $(filter-out $@,$(MAKECMDGOALS))
+	$(MAKE) rector-fix $(filter-out $@,$(MAKECMDGOALS))
+
+php-cs-fixer: ## Execute php-cs-fixer for given PHP version
+	@$(call run-php,composer php-cs-fixer $(filter-out $@,$(MAKECMDGOALS)))
+
+php-cs-fixer-fix: ## Execute php-cs-fixer fixing for given PHP version
 	@$(call run-php,composer php-cs-fixer:fix $(filter-out $@,$(MAKECMDGOALS)))	
 
 rector: ## Execute rector for given PHP version
@@ -51,6 +60,9 @@ phpstan: ## Execute PHPStan for given PHP version
 ci: ## Execute CI scripts for given PHP version
 	@$(call run-php,composer ci $(filter-out $@,$(MAKECMDGOALS)))
 
+generate-css-referentials: ## Generate referentials for given PHP version
+	@$(call run-php,composer generate-css-referentials $(filter-out $@,$(MAKECMDGOALS)))
+
 ## Run PHP for given version
 define run-php
 	@docker run -it --rm -v ${PWD}:${PWD} -w ${PWD} "${IMAGE}" $(1)

composer.json

@@ -52,13 +52,22 @@
   ],
   "scripts": {
     "test": "phpunit --colors --configuration tests/phpunit.xml",
-    "test:load-fixtures": "php scripts/css-referential-scraper && php scripts/css-popular-downloader",
+    "test:load-fixtures": [
+      "php scripts/css-referential-scraper",
+      "php scripts/css-popular-downloader"
+    ],
     "test:ci": "@test -d pcov.enabled=1 -d max_execution_time=0 --coverage-text --coverage-clover ./build/logs/clover.xml --coverage-html ./build/coverage/",
     "php-cs-fixer": "@php-cs-fixer:fix --dry-run",
     "php-cs-fixer:fix": "tools/vendor/bin/php-cs-fixer fix --show-progress=dots --diff --config=.php-cs-fixer.dist.php",
     "rector": "@rector:fix --dry-run",
     "rector:fix": "tools/vendor/bin/rector process src",
     "phpstan": "tools/vendor/bin/phpstan analyse --level max src",
+    "generate-css-referentials": [
+      "php scripts/css-referential-scraper",
+      "php scripts/css-referential-generator",
+      "@php-cs-fixer:fix src/CssLint/Referential",
+      "tools/vendor/bin/rector process src/CssLint/Referential"
+    ],
     "ci": [
       "@php-cs-fixer",
       "@rector",

scripts/css-referential-generator

@@ -3,7 +3,7 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-function saveDataset(string $className, array $referential): void
+function saveReferentialData(string $className, array $referential): void
 {
     $datasetClass = new ReflectionClass($className);
     $datasetFile = $datasetClass->getFileName();
@@ -27,13 +27,12 @@ $cssProperties = json_decode(file_get_contents($cssPropertiesFile), true);
 
 $standardsProperties = [];
 $nonStandardsProperties = [];
-
-foreach ($cssProperties as $propertyName => $property) {
+foreach ($cssProperties as $atRuleName => $property) {
     $isStandard = $property['standard'] ?? false;
     if ($isStandard) {
-        $standardsProperties[$propertyName] = true;
+        $standardsProperties[$atRuleName] = true;
     } else {
-        $nonStandardsProperties[$propertyName] = true;
+        $nonStandardsProperties[$atRuleName] = true;
     }
 }
 
@@ -43,14 +42,45 @@ $missingNonStandardsProperties = [
     '-webkit-margin-end',
     '-moz-osx-font-smoothing',
 ];
-foreach ($missingNonStandardsProperties as $propertyName) {
-    if (isset($standardsProperties[$propertyName]) || isset($nonStandardsProperties[$propertyName])) {
-        throw new Exception("Property $propertyName already exists in either standards or non-standards properties.");
+foreach ($missingNonStandardsProperties as $atRuleName) {
+    if (isset($standardsProperties[$atRuleName]) || isset($nonStandardsProperties[$atRuleName])) {
+        throw new Exception("Property $atRuleName already exists in either standards or non-standards properties.");
     }
-    $nonStandardsProperties[$propertyName] = true;
+    $nonStandardsProperties[$atRuleName] = true;
 }
 
 ksort($standardsProperties);
+saveReferentialData(CssLint\Referential\Standard\PropertiesReferential::class, $standardsProperties);
 ksort($nonStandardsProperties);
-saveDataset(CssLint\Referential\StandardPropertiesReferential::class, $standardsProperties);
-saveDataset(CssLint\Referential\NonStandardPropertiesReferential::class, $nonStandardsProperties);
+saveReferentialData(CssLint\Referential\NonStandard\PropertiesReferential::class, $nonStandardsProperties);
+
+$cssAtRulesFile = __DIR__ . '/../tests/fixtures/css-at-rules.json';
+$cssAtRules = json_decode(file_get_contents($cssAtRulesFile), true);
+$standardsAtRules = [];
+$nonStandardsAtRules = [];
+
+foreach ($cssAtRules as $atRuleName => $atRule) {
+    $isStandard = $atRule['standard'] ?? false;
+    if ($isStandard) {
+        $standardsAtRules[$atRuleName] = true;
+    } else {
+        $nonStandardsAtRules[$atRuleName] = true;
+    }
+}
+
+// Add missing non-standard at-rules
+$missingNonStandardsAtRules = [
+    'theme',
+    'tailwind'
+];
+foreach ($missingNonStandardsAtRules as $atRuleName) {
+    if (isset($standardsAtRules[$atRuleName]) || isset($nonStandardsAtRules[$atRuleName])) {
+        throw new Exception("At-rules $atRuleName already exists in either standards or non-standards at-rules.");
+    }
+    $nonStandardsAtRules[$atRuleName] = true;
+}
+
+ksort($standardsAtRules);
+saveReferentialData(CssLint\Referential\Standard\AtRulesReferential::class, $standardsAtRules);
+ksort($nonStandardsAtRules);
+saveReferentialData(CssLint\Referential\NonStandard\AtRulesReferential::class, $nonStandardsAtRules);

scripts/css-referential-scraper

@@ -9,12 +9,17 @@ $forceRefresh = in_array('--force-refresh', $argv);
 
 $scraper = new CssReferentialScraper($forceRefresh);
 
-echo "Fetching CSS property list...\n";
+echo "Fetching CSS referentials...\n";
 $referentials = $scraper->fetchReferentials();
 
-echo "Fetched " . count($referentials['properties']) . " properties\n";
+echo "Fetched " . count($referentials['properties']) . " propertie(s)\n";
 $cssPropertiesFile = __DIR__ . '/../tests/fixtures/css-properties.json';
 $scraper->saveToJson($referentials['properties'], $cssPropertiesFile);
 echo "Saved to {$cssPropertiesFile}\n";
 
+echo "Fetched " . count($referentials['at-rules']) . " at-rule(s)\n";
+$cssAtRulesFile = __DIR__ . '/../tests/fixtures/css-at-rules.json';
+$scraper->saveToJson($referentials['at-rules'], $cssAtRulesFile);
+echo "Saved to {$cssAtRulesFile}\n";
+
 echo "Done.\n";

src/CssLint/CharLinter/CommentCharLinter.php

@@ -8,7 +8,7 @@
 
 class CommentCharLinter implements CharLinter
 {
-    private static $COMMENT_DELIMITER = '/';
+    private static string $COMMENT_DELIMITER = '/';
 
     /**
      * Performs lint for a given char, check comment part
@@ -21,6 +21,7 @@ public function lintChar(string $charValue, LintContext $lintContext): ?bool
             if ($this->isCommentEnd($charValue, $lintContext)) {
                 $lintContext->setComment(false);
             }
+
             $lintContext->setPreviousChar($charValue);
             return true;
         }
@@ -42,8 +43,6 @@ public function lintChar(string $charValue, LintContext $lintContext): ?bool
 
     /**
      * Check if the current char is a comment
-     * @param string $charValue
-     * @return bool
      */
     private function isCommentDelimiter(string $charValue): bool
     {
@@ -52,8 +51,6 @@ private function isCommentDelimiter(string $charValue): bool
 
     /**
      * Check if the current char is the end of a comment
-     * @param string $charValue
-     * @return bool
      */
     private function isCommentEnd(string $charValue, LintContext $lintContext): bool
     {
@@ -62,8 +59,6 @@ private function isCommentEnd(string $charValue, LintContext $lintContext): bool
 
     /**
      * Check if the current char is the start of a comment
-     * @param string $charValue
-     * @return bool
      */
     private function isCommentStart(string $charValue, LintContext $lintContext): bool
     {

src/CssLint/CharLinter/EndOfLineCharLinter.php

@@ -21,8 +21,10 @@ public function lintChar(string $charValue, LintContext $lintContext): ?bool
                     ->incrementLineNumber()
                     ->resetCharNumber();
             }
+
             return true;
         }
+
         return null;
     }
 

src/CssLint/CharLinter/ImportCharLinter.php

@@ -9,7 +9,7 @@
 
 class ImportCharLinter implements CharLinter
 {
-    private static $IMPORT_RULE = '@import';
+    private static string $IMPORT_RULE = '@import';
 
     /**
      * Performs lint for a given char, check @import rules

src/CssLint/CharLinter/PropertyCharLinter.php

@@ -6,12 +6,12 @@
 
 use CssLint\LintContext;
 use CssLint\LintContextName;
-use CssLint\Properties;
+use CssLint\LintConfiguration;
 
 class PropertyCharLinter implements CharLinter
 {
     public function __construct(
-        protected readonly Properties $cssLintProperties,
+        protected readonly LintConfiguration $lintConfiguration,
     ) {}
 
     /**
@@ -30,6 +30,7 @@ public function lintChar(string $charValue, LintContext $lintContext): ?bool
 
         return null;
     }
+
     /**
      * Performs lint for a given char, check property name part
      * @return bool|null : true if the process should continue, else false, null if this char is not a property name
@@ -50,7 +51,7 @@ protected function lintPropertyNameChar(string $charValue, LintContext $lintCont
             }
 
             // Check if property name exists
-            if (!$this->cssLintProperties->propertyExists($propertyName)) {
+            if (!$this->lintConfiguration->propertyExists($propertyName)) {
                 $lintContext->addError('Unknown CSS property "' . $propertyName . '"');
             }
 
@@ -84,14 +85,18 @@ protected function lintPropertyContentChar(string $charValue, LintContext $lintC
         $lintContext->appendCurrentContent($charValue);
 
         // End of the property content
-        if ($charValue === ';') {
-            // Check if the ";" is not quoted
+        if ($charValue === ';' || $charValue === '}') {
+            // Check if the char is not quoted
             $contextContent = $lintContext->getCurrentContent();
             if ((substr_count($contextContent, '"') & 1) === 0 && (substr_count($contextContent, "'") & 1) === 0) {
                 $lintContext->setCurrentContext(LintContextName::CONTEXT_SELECTOR_CONTENT);
             }
 
             if (trim($contextContent) !== '' && trim($contextContent) !== '0') {
+                if ($charValue === '}') {
+                    $lintContext->resetCurrentContext();
+                }
+
                 return true;
             }