Merge branch 'release/4.1.0'

Author: ravorona

.env.example

@@ -1,7 +1,6 @@
 # Dev server configuration
 HMR_HOST=localhost
 HMR_PORT=3000
-HMR_ENTRYPOINT=https://${HMR_HOST}:${HMR_PORT}
 
 # Certificates
 HMR_HTTPS_CERT=path_to_cert

.stylelintrc

@@ -3,5 +3,8 @@
     "@ravorona/stylelint-config",
     "stylelint-config-recommended-scss"
   ],
-  "customSyntax": "postcss-scss"
+  "customSyntax": "postcss-scss",
+  "rules": {
+    "import-notation": "string"
+  }
 }

CHANGELOG.md

@@ -1,3 +1,19 @@
+## [4.1.0](https://github.com/ravorona/sage/compare/4.0.4...4.1.0) (2023-04-26)
+
+
+### Features
+
+* Dependencies update ([17a0d1c](https://github.com/ravorona/sage/commit/17a0d1ceb79298291fcb92560de83038ac1f7cef)), closes [#14](https://github.com/ravorona/sage/issues/14)
+* Documentation update ([c7b08d2](https://github.com/ravorona/sage/commit/c7b08d21b79488cb79435ff3aaa26be88c7a8d70))
+* Localized vars example ([763625f](https://github.com/ravorona/sage/commit/763625fff087332e32e1c27e3ab472e0fac6e9b5))
+* Sage 10.5.1 ([193958f](https://github.com/ravorona/sage/commit/193958f28829780d21832233a4533059f05ba30d)), closes [#13](https://github.com/ravorona/sage/issues/13)
+* Vite watch option example for windows os user ([603c16c](https://github.com/ravorona/sage/commit/603c16c5af9eca7f2f6a03ea00f3d17d26dcf62f))
+
+
+### Bug Fixes
+
+* Assets path in HMR Mode ([17907fa](https://github.com/ravorona/sage/commit/17907fa0b3e72a456ce7f82524711436af749dcc)), closes [#12](https://github.com/ravorona/sage/issues/12)
+
 ### [4.0.4](https://github.com/ravorona/sage/compare/4.0.3...4.0.4) (2023-03-24)
 
 

README.md

@@ -2,21 +2,24 @@
 
 # 🧩 Wordpress Starter Theme
 
--   Based on [Sage](https://roots.io/sage/) version [10](https://github.com/roots/sage/)
--   Using [Vite](https://vitejs.dev)
+- Based on [Sage](https://roots.io/sage/) version [10](https://github.com/roots/sage/)
+- Using [Vite](https://vitejs.dev)
 
 ## Requirements
 
--   [Acorn](https://docs.roots.io/acorn/2.x/installation/) v2
--   [PHP](https://secure.php.net/manual/en/install.php) >= 8.0.2 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled)
--   [Composer](https://getcomposer.org/download/)
--   [Vite](https://vitejs.dev) >= 3.1.0
--   [Node.js](http://nodejs.org/) >= 14.0.0
--   [Yarn](https://yarnpkg.com/en/docs/install)
+- [Acorn](https://roots.io/acorn/docs/installation/) v3
+- [PHP](https://secure.php.net/manual/en/install.php) >= 8.0 (
+  with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled)
+- [Composer](https://getcomposer.org/download/)
+- [Vite](https://vitejs.dev) >= 3.1.0
+- [Node.js](http://nodejs.org/) >= 16.0.0
+- [Yarn](https://yarnpkg.com/en/docs/install)
 
 ## Theme installation
 
-Install Sage using Composer from your WordPress themes directory (replace `your-theme-name` below with the name of your theme):
+- **Make sure that you have [Acorn installed](https://roots.io/acorn/docs/installation/)**
+- Install Sage using Composer from your WordPress themes directory (replace `your-theme-name` below with the name of
+  your theme):
 
 ```shell
 # @ app/themes/ or wp-content/themes/
@@ -66,35 +69,39 @@ themes/your-theme-name/   # → Root of your Sage based theme
 
 ## Theme development
 
--   Run `yarn` from the theme directory to install dependencies
--   Update `vite.config.ts` for bundler fine tuning
+- Run `yarn` from the theme directory to install dependencies
+- Update `vite.config.ts` for bundler fine tuning
 
 ### Build commands
 
--   `yarn dev` — Start dev server
--   `yarn build` — Compile assets
--   `yarn lint` — Lint stylesheets & javascripts
--   `yarn lint:css` — Lint stylesheets
--   `yarn lint:js` — Lint javascripts
+- `yarn dev` — Start dev server
+- `yarn build` — Compile assets
+- `yarn lint` — Lint stylesheets & javascripts
+- `yarn lint:css` — Lint stylesheets
+- `yarn lint:js` — Lint javascripts
 
-### Hot reload mode
+### Hot Module Replacement
 
 #### Project Side
+
 Add the following variables in your project `.env`
 
 ```sh
-# If true hot reload is active
+# If true hot reload is active.
+# If not specified or set to false, and if the `public/manifest.json` file is missing, HMR is automatically enabled.
 HMR_ENABLED=true
 
 # Endpoint where the bundler serve your assets
 HMR_ENTRYPOINT=http://example.com:3000
 ```
 
 #### Theme side
-For advanced dev server configuration, copy `.env.example` according to [Vite naming convention and loading order](https://vitejs.dev/guide/env-and-mode.html#env-files) and update variables
+
+For advanced dev server configuration, copy `.env.example` according
+to [Vite naming convention and loading order](https://vitejs.dev/guide/env-and-mode.html#env-files) and update variables
 
 ## Documentation
 
--   [Sage documentation](https://roots.io/sage/docs/)
--   [Controller documentation](https://github.com/soberwp/controller#usage)
--   [Vite](https://vitejs.dev/guide/)
+- [Sage documentation](https://roots.io/sage/docs/)
+- [Controller documentation](https://github.com/soberwp/controller#usage)
+- [Vite](https://vitejs.dev/guide/)

app/Providers/ThemeServiceProvider.php

@@ -1,10 +1,30 @@
 <?php
+/*
+ * Copyright (c) 2023 яαvoroηα
+ *
+ *  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:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
 namespace App\Providers;
 
-use Roots\Acorn\ServiceProvider;
+use Roots\Acorn\Sage\SageServiceProvider;
 
-class ThemeServiceProvider extends ServiceProvider
+class ThemeServiceProvider extends SageServiceProvider
 {
     /**
      * Register any application services.
@@ -13,7 +33,7 @@ class ThemeServiceProvider extends ServiceProvider
      */
     public function register()
     {
-        //
+        parent::register();
     }
 
     /**
@@ -23,6 +43,6 @@ public function register()
      */
     public function boot()
     {
-        //
+        parent::boot();
     }
 }

app/View/Components/Alert.php

@@ -1,7 +1,28 @@
 <?php
+/*
+ * Copyright (c) 2023 яαvoroηα
+ *
+ *  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:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
 namespace App\View\Components;
 
+use Illuminate\View\View;
 use Roots\Acorn\View\Component;
 
 class Alert extends Component
@@ -35,8 +56,9 @@ class Alert extends Component
     /**
      * Create the component instance.
      *
-     * @param  string  $type
-     * @param  string  $message
+     * @param string $type
+     * @param string $message
+     *
      * @return void
      */
     public function __construct($type = 'default', $message = null)
@@ -48,7 +70,7 @@ public function __construct($type = 'default', $message = null)
     /**
      * Get the view / contents that represent the component.
      *
-     * @return \Illuminate\View\View|string
+     * @return View|string
      */
     public function render()
     {

app/View/Composers/App.php

@@ -1,4 +1,24 @@
 <?php
+/*
+ * Copyright (c) 2023 яαvoroηα
+ *
+ *  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:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
 namespace App\View\Composers;
 

app/View/Composers/Post.php

@@ -1,4 +1,24 @@
 <?php
+/*
+ * Copyright (c) 2023 яαvoroηα
+ *
+ *  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:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
 namespace App\View\Composers;
 
@@ -54,7 +74,7 @@ public function title()
 
         if (is_search()) {
             return sprintf(
-                /* translators: %s is replaced with the search query */
+            /* translators: %s is replaced with the search query */
                 __('Search Results for %s', 'sage'),
                 get_search_query()
             );

app/filters.php

@@ -1,4 +1,24 @@
 <?php
+/*
+ * Copyright (c) 2023 яαvoroηα
+ *
+ *  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:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
 /**
  * Theme filters.
@@ -15,7 +35,6 @@
     return sprintf(' &hellip; <a href="%s">%s</a>', get_permalink(), __('Continued', 'sage'));
 });
 
-
 /**
  * Load scripts asset as module
  *

app/helpers.php

@@ -1,26 +1,24 @@
 <?php
 
 /*
- * MIT License
+ * Copyright (c) 2023 яαvoroηα
  *
- * Copyright (c) 2022 яαvoroηα
+ *  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:
  *
- * 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:
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
  *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
- * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
- * THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
 namespace App;
@@ -32,18 +30,19 @@
  */
 function hmr_enabled(): bool
 {
-    return env('HMR_ENABLED') ?: false;
+    return env('HMR_ENABLED') ?: !file_exists(get_theme_file_path('/public/manifest.json'));
 }
 
 /**
  * Build assets hmr uri
  *
  * @param string $asset
+ *
  * @return string
  */
 function hmr_assets(string $asset): string
 {
-    $entrypoint = env('HMR_ENTRYPOINT');
+    $entrypoint = env('HMR_ENTRYPOINT') ?: 'http://localhost:5173';
 
     return $entrypoint ? "{$entrypoint}/{$asset}" : asset($asset);
 }