Get ready for Kirby 3

Author: RobertCordes

.editorconfig

@@ -0,0 +1,20 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.php]
+indent_size = 4
+
+[*.md,*.txt]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[composer.json]
+indent_size = 4

.gitignore

@@ -0,0 +1,8 @@
+# OS files
+.DS_Store
+
+# npm modules
+/node_modules
+
+# Composer files
+/vendor

CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change log
+
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [1.1.0] - 2019-02-19
+
+### Added
+
+- Throw exceptions when in debug mode, otherwise just fail silently
+- Make it possible to install via composer
+
+### Changed
+
+- Change config identifiers to keep them inline with the new [Kirby convention](https://getkirby.com/docs/guide/plugins/plugin-basics#plugin-options)
+
 ## [1.0.1] - 2017-01-30
+
 ### Changed
+
 - Change config identifiers to keep them inline with the Kirby convention (thanks [fvsch](https://github.com/fvsch))

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2019
+
+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.

README.md

@@ -4,96 +4,106 @@ Use the `mix` helper function to get the correct path to your versioned CSS and
 
 ## Installation
 
-Copy or link the `laravel-mix-kirby` directory to `site/plugins` or use the [Kirby CLI](https://github.com/getkirby/cli): `kirby plugin:install diverently/laravel-mix-kirby`.
+### Download
 
-You should also install [Laravel Mix](https://github.com/JeffreyWay/laravel-mix), otherwise this plugin is pretty useless ;-) See the [installation guide](https://github.com/JeffreyWay/laravel-mix/blob/master/docs/installation.md) for further information, though it's actually pretty straight forward:
+Download and copy this repository to `site/plugins/laravel-mix-kirby`.
 
-1. If you haven't already, create a `package.json` inside your project root: `npm init -y`
-2. Install Laravel Mix: `npm install laravel-mix --save-dev`
-3. Move the `webpack.config.js` and `webpack.mix.js` files into your root: `cp -r node_modules/laravel-mix/setup/** ./`
-
-After that you can start using Laravel Mix in your project.
+### Git submodule
 
-### NPM scripts
+```
+git submodule add https://github.com/Diverently/laravel-mix-kirby.git site/plugins/laravel-mix-kirby
+```
 
-You should add the following NPM scripts to your `package.json` to speed up your workflow:
+### Composer
 
-```json
-"scripts": {
-  "dev": "cross-env NODE_ENV=development webpack --progress --hide-modules",
-  "watch": "cross-env NODE_ENV=development webpack --watch --progress --hide-modules",
-  "production": "cross-env NODE_ENV=production webpack --progress --hide-modules"
-}
+```
+composer require diverently/laravel-mix-kirby
 ```
 
+### Laravel Mix
 
+You should also install **Laravel Mix**, otherwise this plugin is pretty useless ;-) See the [installation guide](https://laravel-mix.com/docs/4.0/installation) for further information, though it's actually pretty straight forward:
 
-## Usage
+## Setup
 
-### Initial setup
-Depending on your preferred project structure you have to make some changes to your `webpack.mix.js`. You should set the paths where the `mix-manifest.json` as well as the CSS and JS files will be stored.
-I keep my source files outside the `kirby` (or `dist`) directory but you may have a different setup. Mine looks as follows:
+In your `site/config/config.php` you can set two options to make this helper work with your specific setup:
 
-```
-- kirby (or dist)
-  |- assets
-     |- css
-     |- js
-     |- ...
-- src
-  |- css
-     |- main.scss
-     |- ...
-  |- js
-     |- main.js
-     |- ...
-  |- ...
-```
+### `diverently.laravel-mix-kirby.manifestPath`
 
-With that setup I start with the following `webpack.mix.js`:
+This is where the helper function will look for the manifest created by Laravel Mix.
 
-```js
-mix.setPublicPath('kirby/assets/')
-mix.browserSync('my-website.dev')
-mix.sourceMaps()
-   .js('src/js/main.js', 'kirby/assets/js/')
-   .sass('src/css/main.scss', 'kirby/assets/css')
-   .version();
-```
+Default: `assets/mix-manifest.json`
 
-When you run `npm run dev` your `main.js` and `main.css` files will be created. They will also be versioned which makes referencing them via the standard `css()` and `js()` methods pretty tedious. That’s where the helper function comes in (and thus this entire plugin).
+### `diverently.laravel-mix-kirby.assetsDirectory`
+
+This will be prepended to the individual file paths given to the `mix()` function when creating the final HTML tags.
+
+Default: `assets`
+
+## Options
 
 ### `mix()` helper function
-The `mix()` helper function reads the `mix-manifest.json` file and returns the right HTML tag with the correct (versioned) path to the requested file. In our example we would call it like so:
+
+The `mix()` helper function reads the `mix-manifest.json` file and returns the right HTML tag with the correct path to the requested file. In our example we would call it like so:
 
 ```php
-// snippets/header.php
+<html>
 <head>
-  // ...
-
-  <?= mix('/css/main.css') ?>
+    // ...
+    <?php echo mix('/main.css') ?>
 </head>
-
-// snippets/footer.php
-  <?= mix('/js/main.js') ?>
+<body>
+    // ...
+    <?php echo mix('/main.js') ?>
 </body>
 </html>
 ```
 
 And that's it, actually.
 
-### Options
+## Development
 
-In your `site/config/config.php` you can set two options to make this helper work with your specific setup:
+1. If you haven't already, create a `package.json` inside your project root: `npm init -y`
+2. Install Laravel Mix: `npm install laravel-mix --save-dev`
+3. Copy the `webpack.mix.js` file into your root: `cp node_modules/laravel-mix/setup/webpack.mix.js ./`
 
-#### `mix.manifest`
-This is where the helper function will look for the manifest created by Laravel Mix.
+After that you can start using Laravel Mix in your project.
 
-Default: `assets/mix-manifest.json`
+### `webpack.mix.js`
 
-#### `mix.assets`
-This will be prepended to the individual file paths given to the `mix()` function when creating the final HTML tags.
+See the [official document](https://laravel-mix.com/docs/4.0/basic-example) for more information.
 
-Default: `assets`
+```js
+let mix = require('laravel-mix)
+mix.setPublicPath('assets')
+mix.browserSync('my-website.dev')
+mix.sourceMaps()
+   .js('src/js/main.js', 'assets')
+   .sass('src/css/main.scss', 'assets')
+   .version();
+```
+
+### NPM scripts
+
+Add the following NPM scripts to your `package.json`:
+
+```json
+"scripts": {
+    "dev": "npm run development",
+    "development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
+    "watch": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --watch --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
+    "prod": "npm run production",
+    "production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
+}
+```
+
+## License
+
+MIT
+
+## Credits
+
+[Robert Cordes](https://github.com/RobertCordes)
+[Diverently](https://diverently.com)
 
-> The idea behind this originally came from the `mix` Blade helper created for the Laravel framework. This is merely just a "translation" for the Kirby CMS, only that it also generates the correct HTML tag depending on what file type you request.
+> The idea behind this originally came from the `mix` Blade helper created for the Laravel framework. This is merely a "translation" for the Kirby CMS, only that it also generates the correct HTML tag depending on what file type you request.

composer.json

@@ -0,0 +1,13 @@
+{
+    "name": "diverently/laravel-mix-kirby",
+    "description": "Laravel Mix helper for the Kirby CMS",
+    "type": "kirby-plugin",
+    "license": "MIT",
+    "authors": [{
+        "name": "Robert Cordes",
+        "email": "[email protected]"
+    }],
+    "require": {
+        "getkirby/composer-installer": "^1.1"
+    }
+}

index.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * Laravel Mix helper for the Kirby CMS
+ */
+
+if (! function_exists('mix')) {
+    /**
+     * Get the appropriate HTML tag with the right path for the (versioned) Mix file.
+     *
+     * @param string $path Path as it appears in the mix-manifest.json
+     *
+     * @return string Either a <link> or a <script> tag, depending on the $path
+     *
+     * @throws \Exception
+     */
+    function mix($path)
+    {
+        static $manifest = [];
+
+        // Get the correct $path
+        if (!Str::startsWith($path, '/')) {
+            $path = "/{$path}";
+        }
+
+        // Get the correct $manifestPath
+        $manifestPath = option('diverently.laravel-mix-kirby.manifestPath', 'assets/mix-manifest.json');
+
+        if (Str::startsWith($manifestPath, '/')) {
+            $manifestPath = Str::substr($manifestPath, 1);
+        }
+
+        // Get the correct $$assetsDirectory
+        $assetsDirectory = option('diverently.laravel-mix-kirby.assetsDirectory', '/assets/');
+
+        if (! Str::startsWith($assetsDirectory, '/')) {
+            $assetsDirectory = "/{$assetsDirectory}";
+        }
+
+        if (! Str::endsWith($assetsDirectory, '/')) {
+            $assetsDirectory = "{$assetsDirectory}/";
+        }
+
+        // Get the manifest contents
+        if (!$manifest) {
+            if (! F::exists($manifestPath)) {
+                if (option('debug')) {
+                    throw new Exception('The Mix manifest does not exists.');
+                } else {
+                    return false;
+                }
+            }
+
+            $manifest = json_decode(F::read($manifestPath), 'json');
+        }
+
+        // Check if the manifest contains the given $path
+        if (! array_key_exists($path, $manifest)) {
+            if (option('debug')) {
+                throw new Exception("Unable to locate Mix file: {$path}.");
+            } else {
+                return false;
+            }
+        }
+
+        // Get the actual file path for the given $path
+        $mixFilePath = $assetsDirectory . $manifest[$path];
+
+        // Use the appropriate Kirby helper method to get the correct HTML tag
+        $pathExtension = F::extension($mixFilePath);
+
+        if (Str::contains($pathExtension, 'css')) {
+            $mixFileLink = css($mixFilePath);
+        } elseif (Str::contains($pathExtension, 'js')) {
+            $mixFileLink = js($mixFilePath);
+        } else {
+            if (option('debug')) {
+                throw new Exception("File type not recognized");
+            } else {
+                return false;
+            }
+        }
+
+        return $mixFileLink;
+    }
+}