Breaking: Replace feature config helper methods with enum usages

Author: emmadesilva

RELEASE_NOTES.md

@@ -15,6 +15,7 @@ This serves two purposes:
 
 ### Changed
 - **Breaking:** The internals of the navigation system has been rewritten into a new Navigation API. This change is breaking for custom navigation implementations. For more information, see below.
+- **Breaking:** The `hyde.features` configuration format has changed to use Enums instead of static method calls. For more information, see below.
 - Minor: Navigation menu items are now no longer filtered by duplicates (meaning two items with the same label can now exist in the same menu) in https://github.com/hydephp/develop/pull/1573
 - Minor: Due to changes in the navigation system, it is possible that existing configuration files will need to be adjusted in order for menus to look the same (in terms of ordering etc.)
 - Minor: The documentation article component now supports disabling the semantic rendering using a falsy value in https://github.com/hydephp/develop/pull/1566
@@ -70,6 +71,55 @@ The following configuration entries have been updated:
 -  Changed configuration option `docs.table_of_contents` to `docs.sidebar.table_of_contents` in https://github.com/hydephp/develop/pull/1584
 -  Upgrade path: Move the `table_of_contents` option's array in the `config/docs.php` file into the `sidebar` array in the same file.
 
+### Features configuration changes
+
+The `hyde.features` configuration format has changed to use Enums instead of static method calls. This change is breaking as it will require you to update your `config/hyde.php` file.
+
+#### Instead of
+
+```php
+// filepath: config/hyde.php
+
+'features' => [
+    // Page Modules
+    Features::htmlPages(),
+    Features::markdownPosts(),
+    Features::bladePages(),
+    Features::markdownPages(),
+    Features::documentationPages(),
+    
+    // Frontend Features
+    Features::darkmode(),
+    Features::documentationSearch(),
+    
+    // Integrations
+    Features::torchlight(),
+],
+```
+
+#### Use instead
+
+```php
+// filepath: config/hyde.php
+
+'features' => [
+    // Page Modules
+    Feature::HtmlPages,
+    Feature::MarkdownPosts,
+    Feature::BladePages,
+    Feature::MarkdownPages,
+    Feature::DocumentationPages,
+
+    // Frontend Features
+    Feature::Darkmode,
+    Feature::DocumentationSearch,
+
+    // Integrations
+    Feature::Torchlight,
+],
+```
+
+Of course, if you have disabled any of the features, do not include them in the new array.
 
 ## General impact
 

config/hyde.php

@@ -23,8 +23,8 @@
 */
 
 use Hyde\Facades\Author;
-use Hyde\Facades\Features;
 use Hyde\Facades\Meta;
+use Hyde\Foundation\Concerns\Feature;
 
 return [
 
@@ -248,24 +248,23 @@
     |
     | Some of Hyde's features are optional. Feel free to disable the features
     | you don't need by removing or commenting them out from this array.
-    | This config concept is directly inspired by Laravel Jetstream.
     |
     */
 
     'features' => [
         // Page Modules
-        Features::htmlPages(),
-        Features::markdownPosts(),
-        Features::bladePages(),
-        Features::markdownPages(),
-        Features::documentationPages(),
+        Feature::HtmlPages,
+        Feature::MarkdownPosts,
+        Feature::BladePages,
+        Feature::MarkdownPages,
+        Feature::DocumentationPages,
 
         // Frontend Features
-        Features::darkmode(),
-        Features::documentationSearch(),
+        Feature::Darkmode,
+        Feature::DocumentationSearch,
 
         // Integrations
-        Features::torchlight(),
+        Feature::Torchlight,
     ],
 
     /*

docs/creating-content/documentation-pages.md

@@ -290,12 +290,12 @@ that runs during the build command, and a frontend JavaScript plugin that adds t
 
 >info Tip: The HydeSearch plugin is what powers the search feature on this site! Why not [try it out](search)?
 
-The search feature is enabled by default. You can disable it by removing the `documentationSearch` from the Hyde `Features` config array.
+The search feature is enabled by default. You can disable it by removing the `DocumentationSearch` option from the Hyde `Features` config array.
 
 ```php
 // filepath: config/hyde.php
 'features' => [
-    Features::documentationSearch(), // [tl! --]
+    Feature::DocumentationSearch, // [tl! --]
 ],
 ```
 

packages/framework/config/hyde.php

@@ -23,8 +23,8 @@
 */
 
 use Hyde\Facades\Author;
-use Hyde\Facades\Features;
 use Hyde\Facades\Meta;
+use Hyde\Foundation\Concerns\Feature;
 
 return [
 
@@ -248,24 +248,23 @@
     |
     | Some of Hyde's features are optional. Feel free to disable the features
     | you don't need by removing or commenting them out from this array.
-    | This config concept is directly inspired by Laravel Jetstream.
     |
     */
 
     'features' => [
         // Page Modules
-        Features::htmlPages(),
-        Features::markdownPosts(),
-        Features::bladePages(),
-        Features::markdownPages(),
-        Features::documentationPages(),
+        Feature::HtmlPages,
+        Feature::MarkdownPosts,
+        Feature::BladePages,
+        Feature::MarkdownPages,
+        Feature::DocumentationPages,
 
         // Frontend Features
-        Features::darkmode(),
-        Features::documentationSearch(),
+        Feature::Darkmode,
+        Feature::DocumentationSearch,
 
         // Integrations
-        Features::torchlight(),
+        Feature::Torchlight,
     ],
 
     /*

packages/framework/src/Facades/Features.php

@@ -56,82 +56,38 @@ public static function enabled(): array
         return Hyde::features()->features;
     }
 
-    // =================================================
-    // Configure features to be used in the config file.
-    // =================================================
-
-    public static function htmlPages(): Feature
-    {
-        return Feature::HtmlPages;
-    }
-
-    public static function bladePages(): Feature
-    {
-        return Feature::BladePages;
-    }
-
-    public static function markdownPages(): Feature
-    {
-        return Feature::MarkdownPages;
-    }
-
-    public static function markdownPosts(): Feature
-    {
-        return Feature::MarkdownPosts;
-    }
-
-    public static function documentationPages(): Feature
-    {
-        return Feature::DocumentationPages;
-    }
-
-    public static function documentationSearch(): Feature
-    {
-        return Feature::DocumentationSearch;
-    }
-
-    public static function darkmode(): Feature
-    {
-        return Feature::Darkmode;
-    }
-
-    public static function torchlight(): Feature
-    {
-        return Feature::Torchlight;
-    }
-
     // ================================================
     // Determine if a given feature is enabled.
     // ================================================
 
     public static function hasHtmlPages(): bool
     {
-        return static::has(static::htmlPages());
+        return static::has(Feature::HtmlPages);
     }
 
     public static function hasBladePages(): bool
     {
-        return static::has(static::bladePages());
+        return static::has(Feature::BladePages);
     }
 
     public static function hasMarkdownPages(): bool
     {
-        return static::has(static::markdownPages());
+        return static::has(Feature::MarkdownPages);
     }
 
     public static function hasMarkdownPosts(): bool
     {
-        return static::has(static::markdownPosts());
+        return static::has(Feature::MarkdownPosts);
     }
 
     public static function hasDocumentationPages(): bool
     {
-        return static::has(static::documentationPages());
+        return static::has(Feature::DocumentationPages);
     }
 
     public static function hasDarkmode(): bool
     {
-        return static::has(static::darkmode());
+        return static::has(Feature::Darkmode);
     }
 
     // ====================================================
@@ -167,14 +123,14 @@ public static function hasRss(): bool
      */
     public static function hasTorchlight(): bool
     {
-        return static::has(static::torchlight())
+        return static::has(Feature::Torchlight)
             && (Config::getNullableString('torchlight.token') !== null)
             && (app('env') !== 'testing');
     }
 
     public static function hasDocumentationSearch(): bool
     {
-        return static::has(static::documentationSearch())
+        return static::has(Feature::DocumentationSearch)
             && static::hasDocumentationPages()
             && count(DocumentationPage::files()) > 0;
     }

packages/framework/src/Framework/Services/ValidationService.php

@@ -10,6 +10,7 @@
 use Hyde\Pages\BladePage;
 use Hyde\Pages\MarkdownPage;
 use Hyde\Pages\DocumentationPage;
+use Hyde\Foundation\Concerns\Feature;
 use Hyde\Support\Models\ValidationResult as Result;
 
 use function count;
@@ -121,7 +122,7 @@ public function check_site_has_a_base_url_set(Result $result): Result
 
     public function check_a_torchlight_api_token_is_set(Result $result): Result
     {
-        if (! Features::has(Features::torchlight())) {
+        if (! Features::has(Feature::Torchlight)) {
             return $result->skip('Check a Torchlight API token is set')
                 ->withTip('Torchlight is an API for code syntax highlighting. You can enable it in the Hyde config.');
         }

packages/framework/tests/Feature/ConfigurableFeaturesTest.php

@@ -7,6 +7,7 @@
 use Hyde\Hyde;
 use Hyde\Facades\Features;
 use Hyde\Testing\TestCase;
+use Hyde\Foundation\Concerns\Feature;
 use Illuminate\Support\Facades\Config;
 
 use function config;
@@ -82,9 +83,9 @@ public function testToArrayMethodContainsAllSettings()
     public function testToArrayMethodContainsAllSettingsIncludingFalseValues()
     {
         config(['hyde.features' => [
-            Features::htmlPages(),
-            Features::markdownPosts(),
-            Features::bladePages(),
+            Feature::HtmlPages,
+            Feature::MarkdownPosts,
+            Feature::BladePages,
         ]]);
 
         $this->assertSame([
@@ -102,9 +103,9 @@ public function testToArrayMethodContainsAllSettingsIncludingFalseValues()
     public function testSerializedClassState()
     {
         config(['hyde.features' => [
-            Features::htmlPages(),
-            Features::markdownPosts(),
-            Features::bladePages(),
+            Feature::HtmlPages,
+            Feature::MarkdownPosts,
+            Feature::BladePages,
         ]]);
 
         $this->assertSame(<<<'JSON'
@@ -168,9 +169,9 @@ public function testGetEnabledUsesDefaultOptionsWhenConfigIsEmpty()
     public function testGetEnabledUsesConfiguredOptions()
     {
         config(['hyde.features' => [
-            Features::htmlPages(),
-            Features::markdownPosts(),
-            Features::bladePages(),
+            Feature::HtmlPages,
+            Feature::MarkdownPosts,
+            Feature::BladePages,
         ]]);
 
         $this->assertSame([
@@ -185,9 +186,9 @@ public function testCannotUseArbitraryValuesInEnabledOptions()
         $this->expectException(\TypeError::class); // Todo: Consider if we should handle this again by ignoring it, or throw with a more specific message
 
         $config = [
-            Features::htmlPages(),
-            Features::markdownPosts(),
-            Features::bladePages(),
+            Feature::HtmlPages,
+            Feature::MarkdownPosts,
+            Feature::BladePages,
             'foo',
         ];