Merge pull request #18 from craftcms/feature/webalias

Adds @web alias checks for site and asset base urls
craftcms · Apr 17, 2022 · 1ed5b5d · 1ed5b5d
2 parents d787e1b + e431d7e
commit 1ed5b5d
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog for Craft CMS Server Check
 
+## Unreleased
+
+### Added
+- Added checks for relying on the default `@web` alias.
+
 ## 1.2.1 - 2021-05-25
 
 ### Added

diff --git a/server/requirements/RequirementsChecker.php b/server/requirements/RequirementsChecker.php
@@ -538,6 +538,28 @@ function maxExecutionTimeRequirement()
         );
     }
 
+    /**
+     * @return array
+     */
+    function webAliasRequirement()
+    {
+        $aliases = Craft::$app->getConfig()->getGeneral()->aliases;
+        $memo = 'We recommend explicitly overriding the <a rel="noopener" target="_blank" href="https://craftcms.com/docs/3.x/config/#aliases">@web alias</a>.';
+        $pass = false;
+
+        if (isset($aliases['web']) || isset($aliases['@web'])) {
+            $memo = 'Your @web alias is set correctly';
+            $pass = true;
+        }
+
+        return array(
+            'name' => 'Ensure @web alias is explicitly overridden',
+            'mandatory' => false,
+            'condition' => $pass,
+            'memo' => $memo,
+        );
+    }
+
     /**
      * @return array
      */

diff --git a/server/requirements/requirements.php b/server/requirements/requirements.php
@@ -65,6 +65,7 @@
 // Only run this requirement check if we're running in the context of Craft.
 if (class_exists('Craft')) {
     $requirements[] = $this->webrootRequirement();
+    $requirements[] = $this->webAliasRequirement();
 }
 
 $requirements = array_merge($requirements, array(