Merge branch 'release/1.12.1' into v1

.gitattributes

@@ -0,0 +1,15 @@
+# Do not export those files in the Composer archive (lighter dependency)
+/.craftplugin export-ignore
+/.gitattributes export-ignore
+/.github/ export-ignore
+/.gitignore export-ignore
+/.scrutinizer.yml export-ignore
+/codeception.yml export-ignore
+/composer.lock export-ignore
+/buildchain/ export-ignore
+/resources/ export-ignore
+/src/web/assets/src/
+/tests/ export-ignore
+
+# Auto detect text files and perform LF normalization
+* text=auto

.github/workflows/code-analysis.yaml

@@ -0,0 +1,40 @@
+name: Code Analysis
+
+on:
+  pull_request: null
+  push:
+    branches:
+      - develop
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  code_analysis:
+    strategy:
+      fail-fast: false
+      matrix:
+        actions:
+          - name: 'PHPStan'
+            run: composer phpstan
+          - name: 'Coding Standards'
+            run: composer fix-cs
+    name: ${{ matrix.actions.name }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
+      - name: Setup PHP
+        id: setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: 'ctype,curl,dom,iconv,imagick,intl,json,mbstring,openssl,pcre,pdo,reflection,spl,zip'
+          ini-values: post_max_size=256M, max_execution_time=180, memory_limit=512M
+          tools: composer:v2
+      - name: Install Composer dependencies
+        run: composer install --no-interaction --no-ansi --no-progress
+      - run: ${{ matrix.actions.run }}

.github/workflows/create-release.yml

@@ -0,0 +1,21 @@
+name: Create Release
+run-name: Create release for ${{ github.event.client_payload.version }}
+
+on:
+  repository_dispatch:
+    types:
+      - craftcms/new-release
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: ncipollo/release-action@v1
+        with:
+          body: ${{ github.event.client_payload.notes }}
+          makeLatest: ${{ github.event.client_payload.latest }}
+          name: ${{ github.event.client_payload.version }}
+          prerelease: ${{ github.event.client_payload.prerelease }}
+          tag: ${{ github.event.client_payload.tag }}

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.12.1 - 2024.04.15
+### Added
+* Stable release for Craft CMS 5
+* Add `phpstan` and `ecs` code linting
+* Add `code-analysis.yaml` GitHub action
+* Add `create-release.yml` for automated released
+
+### Changed
+* PHPstan code cleanup
+* ECS code cleanup
+
 ## 1.12.0 - 2024.01.25
 ### Added
 * Added support for Craft CMS 5

LICENSE.md

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 nystudio107
-Copyright (c) 2021 PutYourLightsOn
+Copyright (c) nystudio107
+Copyright (c) PutYourLightsOn
 
 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:
 

composer.json

@@ -2,7 +2,7 @@
   "name": "nystudio107/craft-autocomplete",
   "description": "Provides Twig template IDE autocomplete of Craft CMS & plugin variables",
   "type": "yii2-extension",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "keywords": [
     "craft",
     "cms",
@@ -30,7 +30,17 @@
     }
   ],
   "require": {
-    "craftcms/cms": "^3.0.0 || ^4.0.0 || ^5.0.0-alpha.1"
+    "craftcms/cms": "^3.0.0 || ^4.0.0 || ^5.0.0"
+  },
+  "require-dev": {
+    "craftcms/ecs": "dev-main",
+    "craftcms/phpstan": "dev-main",
+    "craftcms/rector": "dev-main"
+  },
+  "scripts": {
+    "phpstan": "phpstan --ansi --memory-limit=1G",
+    "check-cs": "ecs check --ansi",
+    "fix-cs": "ecs check --fix --ansi"
   },
   "config": {
     "allow-plugins": {

ecs.php

@@ -0,0 +1,13 @@
+<?php
+
+use craft\ecs\SetList;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function(ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+        __FILE__,
+    ]);
+    $ecsConfig->parallel();
+    $ecsConfig->sets([SetList::CRAFT_CMS_4]);
+};

phpstan.neon

@@ -0,0 +1,7 @@
+includes:
+    - %currentWorkingDirectory%/vendor/craftcms/phpstan/phpstan.neon
+
+parameters:
+    level: 5
+    paths:
+        - src

src/Autocomplete.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Autocomplete plugin for Craft CMS 3.x
+ * Autocomplete module for Craft CMS
  *
  * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
  *
  * @link      https://nystudio107.com
  * @link      https://putyourlightson.com
- * @copyright Copyright (c) 2021 nystudio107
- * @copyright Copyright (c) 2021 PutYourLightsOn
+ * @copyright Copyright (c) nystudio107
+ * @copyright Copyright (c) PutYourLightsOn
  */
 
 namespace nystudio107\autocomplete;
@@ -41,7 +41,7 @@ class Autocomplete extends Module implements BootstrapInterface
     // Constants
     // =========================================================================
 
-    const ID = 'craft-autocomplete';
+    public const ID = 'craft-autocomplete';
 
     /**
      * @event RegisterComponentTypesEvent The event that is triggered when registering
@@ -63,9 +63,9 @@ class Autocomplete extends Module implements BootstrapInterface
      * );
      * ```
      */
-    const EVENT_REGISTER_AUTOCOMPLETE_GENERATORS = 'registerAutocompleteGenerators';
+    public const EVENT_REGISTER_AUTOCOMPLETE_GENERATORS = 'registerAutocompleteGenerators';
 
-    const DEFAULT_AUTOCOMPLETE_GENERATORS = [
+    public const DEFAULT_AUTOCOMPLETE_GENERATORS = [
         AutocompleteVariableGenerator::class,
         AutocompleteTwigExtensionGenerator::class,
     ];
@@ -186,7 +186,7 @@ public function getAllAutocompleteGenerators(): array
         }
 
         $event = new RegisterComponentTypesEvent([
-            'types' => self::DEFAULT_AUTOCOMPLETE_GENERATORS
+            'types' => self::DEFAULT_AUTOCOMPLETE_GENERATORS,
         ]);
         $this->trigger(self::EVENT_REGISTER_AUTOCOMPLETE_GENERATORS, $event);
         $this->allAutocompleteGenerators = $event->types;

src/base/Generator.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Autocomplete plugin for Craft CMS 3.x
+ * Autocomplete module for Craft CMS
  *
  * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
  *
  * @link      https://nystudio107.com
  * @link      https://putyourlightson.com
- * @copyright Copyright (c) 2021 nystudio107
- * @copyright Copyright (c) 2021 PutYourLightsOn
+ * @copyright Copyright (c) nystudio107
+ * @copyright Copyright (c) PutYourLightsOn
  */
 
 namespace nystudio107\autocomplete\base;
@@ -41,7 +41,7 @@ abstract class Generator implements GeneratorInterface
      * );
      * ```
      */
-    const EVENT_BEFORE_GENERATE = 'beforeGenerate';
+    public const EVENT_BEFORE_GENERATE = 'beforeGenerate';
 
     // Public Static Methods
     // =========================================================================

src/base/GeneratorInterface.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Autocomplete plugin for Craft CMS 3.x
+ * Autocomplete module for Craft CMS
  *
  * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
  *
  * @link      https://nystudio107.com
  * @link      https://putyourlightson.com
- * @copyright Copyright (c) 2021 nystudio107
- * @copyright Copyright (c) 2021 PutYourLightsOn
+ * @copyright Copyright (c) nystudio107
+ * @copyright Copyright (c) PutYourLightsOn
  */
 
 namespace nystudio107\autocomplete\base;
@@ -22,9 +22,9 @@ interface GeneratorInterface
     // Constants
     // =========================================================================
 
-    const TEMPLATE_EXTENSION = '.php';
-    const STUBS_EXTENSION = '.php.stub';
-    const STUBS_DIR = DIRECTORY_SEPARATOR . 'stubs';
+    public const TEMPLATE_EXTENSION = '.php';
+    public const STUBS_EXTENSION = '.php.stub';
+    public const STUBS_DIR = DIRECTORY_SEPARATOR . 'stubs';
 
     // Public Static Methods
     // =========================================================================

src/console/controllers/AutocompleteController.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Autocomplete plugin for Craft CMS 3.x
+ * Autocomplete module for Craft CMS
  *
  * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
  *
  * @link      https://nystudio107.com
  * @link      https://putyourlightson.com
- * @copyright Copyright (c) 2021 nystudio107
- * @copyright Copyright (c) 2021 PutYourLightsOn
+ * @copyright Copyright (c) nystudio107
+ * @copyright Copyright (c) PutYourLightsOn
  */
 
 namespace nystudio107\autocomplete\console\controllers;

src/events/DefineGeneratorValuesEvent.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Autocomplete plugin for Craft CMS 3.x
+ * Autocomplete module for Craft CMS
  *
  * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
  *
  * @link      https://nystudio107.com
  * @link      https://putyourlightson.com
- * @copyright Copyright (c) 2021 nystudio107
- * @copyright Copyright (c) 2021 PutYourLightsOn
+ * @copyright Copyright (c) nystudio107
+ * @copyright Copyright (c) PutYourLightsOn
  */
 
 namespace nystudio107\autocomplete\events;

src/generators/AutocompleteTwigExtensionGenerator.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Autocomplete plugin for Craft CMS 3.x
+ * Autocomplete module for Craft CMS
  *
  * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
  *
  * @link      https://nystudio107.com
  * @link      https://putyourlightson.com
- * @copyright Copyright (c) 2021 nystudio107
- * @copyright Copyright (c) 2021 PutYourLightsOn
+ * @copyright Copyright (c) nystudio107
+ * @copyright Copyright (c) PutYourLightsOn
  */
 
 namespace nystudio107\autocomplete\generators;
@@ -29,9 +29,9 @@ class AutocompleteTwigExtensionGenerator extends Generator
     // Constants
     // =========================================================================
 
-    const ELEMENT_ROUTE_EXCLUDES = [
+    public const ELEMENT_ROUTE_EXCLUDES = [
         'matrixblock',
-        'globalset'
+        'globalset',
     ];
 
     // Public Static Methods
@@ -63,13 +63,13 @@ public static function regenerate()
         self::generateInternal();
     }
 
-    // Private Static Methods
+    // Protected Static Methods
     // =========================================================================
 
     /**
      * Core function that generates the autocomplete class
      */
-    private static function generateInternal()
+    protected static function generateInternal()
     {
         $values = [];
         // Iterate through the globals in the Twig context
@@ -136,7 +136,7 @@ private static function generateInternal()
      *
      * @return array
      */
-    private static function elementRouteVariables(): array
+    protected static function elementRouteVariables(): array
     {
         $routeVariables = [];
         $elementTypes = Craft::$app->elements->getAllElementTypes();
@@ -157,7 +157,7 @@ private static function elementRouteVariables(): array
      *
      * @return array
      */
-    private static function globalVariables(): array
+    protected static function globalVariables(): array
     {
         $globalVariables = [];
         // See if the GlobalsExtension class is available (Craft CMS 3.7.8 or later) and use it
@@ -182,7 +182,7 @@ private static function globalVariables(): array
      *
      * @return array
      */
-    private static function overrideValues(): array
+    protected static function overrideValues(): array
     {
         return [
             // Swap in our variable in place of the `craft` variable