add docs

Author: michalsn

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2020 Michal Sniatala
+Copyright (c) 2019-2023 Michal Sniatala
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,16 +1,25 @@
-# Minifier [![](https://github.com/michalsn/minifier/workflows/PHP%20Tests/badge.svg)](https://github.com/michalsn/minifier/actions?query=workflow%3A%22PHP+Tests%22)
+# Minifier
 
 Asset minification and versioning library for CodeIgniter 4.
 
+[![PHPUnit](https://github.com/michalsn/minifier/actions/workflows/phpunit.yml/badge.svg)](https://github.com/michalsn/minifier/actions/workflows/phpunit.yml)
+[![PHPStan](https://github.com/michalsn/minifier/actions/workflows/phpstan.yml/badge.svg)](https://github.com/michalsn/minifier/actions/workflows/phpstan.yml)
+[![Deptrac](https://github.com/michalsn/minifier/actions/workflows/deptrac.yml/badge.svg)](https://github.com/michalsn/minifier/actions/workflows/deptrac.yml)
+[![Coverage Status](https://coveralls.io/repos/github/michalsn/minifier/badge.svg?branch=develop)](https://coveralls.io/github/michalsn/minifier?branch=develop)
+
 ## Installation
 
-    > composer require michalsn/minifier
+```console
+composer require michalsn/minifier
+```
 
 ## Configuration
 
 Run command:
 
-    > php spark minify:publish
+```console
+php spark minify:publish
+```
 
 This command will copy a config file to your app namespace.
 Then you can adjust it to your needs. By default, file will be present in `app/Config/Minifier.php`.
@@ -20,7 +29,7 @@ You should define an array of files that you want to minify, ie:
 ```php
 public $js = [
     'all.min.js' => [
-        'jquery-3.2.1.min.js', 'bootstrap-3.3.7.min.js', 'main.js',
+        'jquery-3.7.1.min.js', 'bootstrap-3.3.7.min.js', 'main.js',
     ]
 ];
 ```
@@ -37,71 +46,7 @@ public $css = [
 
 This way requesting for a `all.min.js` or `all.min.css` file will return a minified and combined version of all files in a given array.
 
-## Usage
-
-To actually minify all the files we have to run command:
-
-    > php spark minify:all
-
-This will prepare everything and will set up a versioning. Make sure to load a minifier helper in your controller, by calling:
-
-```php
-helper('minifier');
-```
-
-Now to generate a proper tag with desired file to load, you have to make a simple call in your code:
-
-```php
-minifier('all.min.js');
-```
-
-or
-
-```php
-minifier('all.min.css');
-```
-
-This will produce:
-
-```html
-<script type="text/javascript" src="http://localhost/assets/js/all.min.js?v=9ef881911da8d7c4a1c2f19c4878d122"></script> 
-```
-
-or
-
-```html
-<link rel="stylesheet" href="http://localhost/assets/css/all.min.css?v=50a35b0b1d1c3798aa556b8245314930">
-```
+## Docs
 
-## Config options
-
-After running command:
-
-    > php spark minify:publish
-
-You can modify the config file which by default is copied to the path `app/Config/Minifier.php`. Here are your options with a description.
-
-Variable | Default value | Options | Desctiption
--------- | ------------- | ------- | -----------
-`$minify`| `true` | `true`, `false` | Use this variable to turn on and off minification of the assets. Turning off can be useful during app development - for easy debugging.
-`$baseUrl` | `null` | | Use this variable when you want to set absolute path to the asset files. If no other URLs are set, like `$baseJsUrl` or `$baseCssUrl` then values set to `$dirJS` and `$dirCss` will be added to the final URL.
-`$baseJsUrl` | `null` | | Use this variable when your JS assets are served from subdomain. Bare in mind that in this case variable `$dirJs` won't be added to the URL.
-`$baseCssUrl` | `null` | | Use this variable when your CSS assets are served from subdomain. Bare in mind that in this case variable `$dirCSS` won't be added to the URL.
-`$adapterJs` | `\Michalsn\Minifier\Adapters\Js\MinifyAdapter::class` | | Adapter to use for minifying JS files. You can also implement your own JS adapter to minify assets and replace this class.
-`$adapterCss` | `\Michalsn\Minifier\Adapters\Css\MinifyAdapter::class` | | Adapter to use for minifying CSS files. You can also implement your own CSS adapter to minify assets and replace this class.
-`$dirJs` | `./assets/js` | | JS assets directory.
-`$dirCss` | `./assets/css` | | CSS assets directory.
-`$dirMinJs` | `null` | | Minified JS asset directory. If not set the value from `$dirJs` will be used instead.
-`$dirMinCss` | `null` | | Minified CSS asset directory. If not set the value from `$dirCss` will be used instead.
-`$dirVersion` | `./assets` | | Directory to store assets versioning.
-`$tagJs` | `<script type="text/javascript" src="%s"></script>` | | JS tag to use in HTML when displaying JS assets.
-`$tagCss` | `<link rel="stylesheet" href="%s">` | | CSS tag to use in HTML when displaying CSS assets.
-`$returnType` | `html` | `html`, `json`, `array` | Determines how the files will be returned. The dafault value is `html` and it uses the `$tagJs` and `$tagCss` variables. Using `array` will return the php array and `json` type will return a json string.
-`$autoDeployOnChange` | `false` | `true`, `false` | Specifies if we want to automatically deploy whenever there is a change to any of our assets files. Keep in mind that enabling this feature will have an impact on performance.
-`$js` | | | This array defines JS files to minify.
-`$css` | | | This array defines CSS files to minify.
-
-## License
-
-The MIT License (MIT). Please see [License File](LICENSE) for more information.
+Read the full documentation: https://michalsn.github.io/minifier/
 

composer.json

@@ -16,8 +16,7 @@
     "homepage": "https://github.com/michalsn/minifier",
     "require": {
         "php" : "^8.1",
-        "matthiasmullie/minify": "^1.3",
-        "ext-json": "*"
+        "matthiasmullie/minify": "^1.3"
     },
     "require-dev": {
         "codeigniter4/devkit": "^1.0",

docs/assets/favicon.ico

@@ -0,0 +1,15 @@
+pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*!
+  Theme: GitHub Dark Dimmed
+  Description: Dark dimmed theme as seen on github.com
+  Author: github.com
+  Maintainer: @Hirse
+  Updated: 2021-05-15
+  Modified: 2022:12:27 by @michalsn
+
+  Colors taken from GitHub's CSS
+*/.hljs{color:#adbac7 !important;background-color:#22272e !important}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#f47067}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#dcbdfb}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#6cb6ff}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#96d0ff}.hljs-built_in,.hljs-symbol{color:#f69d50}.hljs-code,.hljs-comment,.hljs-formula{color:#768390}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#8ddb8c}.hljs-subst{color:#adbac7}.hljs-section{color:#316dca;font-weight:700}.hljs-bullet{color:#eac55f}.hljs-emphasis{color:#adbac7;font-style:italic}.hljs-strong{color:#adbac7;font-weight:700}.hljs-addition{color:#b4f1b4;background-color:#1b4721}.hljs-deletion{color:#ffd8d3;background-color:#78191b}
+
+[data-md-color-scheme="default"] {
+    --md-default-fg-color--lightest: #575757;
+    --md-default-fg-color--light: #959595;
+}

docs/assets/flame.svg

@@ -0,0 +1,3 @@
+window.document$.subscribe(() => {
+    hljs.highlightAll();
+});

docs/assets/github-dark-dimmed.css

@@ -0,0 +1,39 @@
+# Basic Usage
+
+After [defining our files](configuration.md#config-file) we want to actually minify all the files we have. This is easy enough as running the command:
+
+```console
+php spark minify:all
+```
+
+This will prepare everything and will set up a versioning. Make sure to load a minifier helper in your controller, by calling:
+
+```php
+helper('minifier');
+```
+
+Now to generate a proper tag with desired file to load, you have to make a simple call in your code:
+
+```php
+minifier('all.min.js');
+```
+
+or
+
+```php
+minifier('all.min.css');
+```
+
+This will produce:
+
+```html
+<script type="text/javascript"
+        src="http://localhost/assets/js/all.min.js?v=9ef881911da8d7c4a1c2f19c4878d122"></script>
+```
+
+or
+
+```html
+<link rel="stylesheet"
+      href="http://localhost/assets/css/all.min.css?v=50a35b0b1d1c3798aa556b8245314930">
+```

docs/assets/hljs.js

@@ -0,0 +1,141 @@
+# Configuration
+
+## Config File
+
+To make changes to the config file, we have to have our copy in the `app/Config/Minifier.php`. Luckily, this package comes with handy command that will make this easy.
+
+When we run:
+
+```console
+php spark minify:publish
+```
+
+We will get our copy ready for modifications.
+
+Now, you should define an array of files that you want to minify, ie:
+
+```php
+public $js = [
+    'all.min.js' => [
+        'jquery-3.7.1.min.js', 'bootstrap-3.3.7.min.js', 'main.js',
+    ]
+];
+```
+
+or
+
+```php
+public $css = [
+    'all.min.css' => [
+        'bootstrap-3.3.7.min.css', 'font-awesome-4.7.0.min.css', 'main.css',
+    ]
+];
+```
+
+This way requesting for a `all.min.js` or `all.min.css` file will return a minified and combined version of all files in a given array.
+
+## Config Options
+
+### $minify
+
+Use this variable to turn on and off minification of the assets. Turning off can be useful during app development - for easy debugging.
+
+**Available options**: `true`, `false`
+
+**Default value**: `true`
+
+### $baseUrl
+
+Use this variable when you want to set absolute path to the asset files. If no other URLs are set, like `$baseJsUrl` or `$baseCssUrl` then values set to `$dirJS` and `$dirCss` will be added to the final URL.
+
+**Default value**: `null`
+
+### $baseJsUrl
+
+Use this variable when your JS assets are served from subdomain. Keep in mind that in this case variable `$dirJs` won't be added to the URL.
+
+**Default value**: `null`
+
+### $baseCssUrl
+
+Use this variable when your CSS assets are served from subdomain. Keep in mind that in this case variable `$dirCSS` won't be added to the URL.
+
+**Default value**: `null`
+
+### $adapterJs
+
+Adapter to use for minifying JS files. You can also implement your own JS adapter to minify assets and replace this class.
+
+**Default value**: `\Michalsn\Minifier\Adapters\Js\MinifyAdapter::class`
+
+### $adapterCss
+
+Adapter to use for minifying CSS files. You can also implement your own CSS adapter to minify assets and replace this class.
+
+**Default value**: `\Michalsn\Minifier\Adapters\Css\MinifyAdapter::class`
+
+### $dirJs
+
+JS assets directory.
+
+**Default value**: `./assets/js`
+
+### $dirCss
+
+CSS assets directory.
+
+**Default value**: `./assets/css`
+
+### $dirMinJs
+
+Minified JS asset directory. If not set the value from `$dirJs` will be used instead.
+
+**Default value**: `null`
+
+### $dirMinCss
+
+Minified CSS asset directory. If not set the value from `$dirCss` will be used instead.
+
+**Default value**: `null`
+
+### $dirVersion
+
+Directory to store assets versioning.
+
+**Default value**: `./assets`
+
+### $tagJs
+
+JS tag to use in HTML when displaying JS assets.
+
+**Default value**: `<script type="text/javascript" src="%s"></script>`
+
+### $tagCss
+
+CSS tag to use in HTML when displaying CSS assets.
+
+**Default value**: `<link rel="stylesheet" href="%s">`
+
+### $returnType
+
+Determines how the files will be returned. The default value is `html` and it uses the `$tagJs` and `$tagCss` variables. Using `array` will return the php array and `json` type will return a json string.
+
+**Available options**: `html`, `json`, `array`
+
+**Default value**: `html`
+
+### $autoDeployOnChange
+
+Specifies if we want to automatically deploy whenever there is a change to any of our assets files. Keep in mind that enabling this feature will have an impact on performance.
+
+**Available options**: `true`, `false`
+
+**Default value**: `false`
+
+### $js
+
+This array defines JS files to minify.
+
+### $css
+
+This array defines CSS files to minify.

docs/basic-usage.md

@@ -0,0 +1,18 @@
+# CodeIgniter Minifier Documentation
+
+Asset minification and versioning library for CodeIgniter 4.
+
+### Requirements
+
+![PHP](https://img.shields.io/badge/PHP-%5E8.1-blue)
+![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.1-blue)
+
+## Overview
+
+We can define files we want to combine and minify and then use it with only one line:
+
+```php
+echo minifier('all.min.js');
+// <script src="http://localhost/assets/js/all.min.js?v=9ef881911da8d7c4a1c2f19c4878d122" type="text/javascript"></script>
+```
+

docs/configuration.md

@@ -0,0 +1,9 @@
+# Installation
+
+## Composer Installation
+
+The only thing you have to do is to run this command, and you're ready to go.
+
+```console
+composer require michalsn/minifier
+```