Merge pull request pgaultier#1 from pgaultier/feature/init

Init files

Author: pgaultier

.gitignore

@@ -0,0 +1,3 @@
+.idea
+vendor
+tests/_output/*

LICENSE.md

@@ -0,0 +1,27 @@
+Sweelix Webpack Manager is free software. It is released under the terms of the following BSD License.
+
+Copyright 2010-2017 by Sweelix SAS
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of Sweelix SAS nor the names of its contributors may be used
+  to endorse or promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,215 @@
+Yii2 Webpack integration
+========================
+
+This extension allow the developper to use [Webpack 2](https://webpack.js.org/) as the asset manager.
+
+Webpack2 comes preconfigured with the following loaders 
+ * javascript
+ * typescript
+ * sass
+ * less
+ * css
+
+
+[![Latest Stable Version](https://poser.pugx.org/sweelix/yii2-webpack/v/stable)](https://packagist.org/packages/sweelix/yii2-webpack)
+[![Build Status](https://api.travis-ci.org/pgaultier/yii2-webpack.svg?branch=master)](https://travis-ci.org/pgaultier/yii2-webpack)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/?branch=master)
+[![License](https://poser.pugx.org/sweelix/yii2-webpack/license)](https://packagist.org/packages/sweelix/yii2-webpack)
+
+[![Latest Development Version](https://img.shields.io/badge/unstable-devel-yellowgreen.svg)](https://packagist.org/packages/sweelix/yii2-webpack)
+[![Build Status](https://travis-ci.org/pgaultier/yii2-webpack.svg?branch=devel)](https://travis-ci.org/pgaultier/yii2-webpack)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/badges/quality-score.png?b=devel)](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/?branch=devel)
+[![Code Coverage](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/badges/coverage.png?b=devel)](https://scrutinizer-ci.com/g/pgaultier/yii2-webpack/?branch=devel)
+
+Installation
+------------
+
+If you use Packagist for installing packages, then you can update your `composer.json like this :
+
+``` json
+{
+    "require": {
+        "sweelix/yii2-webpack": "*"
+    }
+}
+```
+
+Howto use it
+------------
+
+Add extension to your console configuration to enable CLI commands
+
+``` php
+return [
+    // add webpack to console bootstrap to attach console controllers 
+    'bootstrap' => ['log', 'webpack'],   
+    //....
+    'modules' => [
+        'webpack' => [
+            'class' => 'sweelix\webpack\Module',
+        ],
+        // ...
+    ],
+];
+```
+
+### Generate everything from scratch (init webpack stuff)
+
+```
+php protected/yii webpack
+```
+
+ * **Generating package.json**
+   * **Relative path to composer.json ?** If you are in main directory, this is probably `composer.json` 
+   * **Application name ?** Application name which will be used in package.json
+   * **Author ?** Your name 
+   * **Description ?** Description of package.json 
+   * **License ?** License of the application
+
+ * **Generating webpack-yii2.json**
+   * **Webpack assets path relative to package.json** This is where you will write your front app (`protected/assets/webpack` for example)  
+   * **Webpack assets source directory ?** Name of the directory (inside webpack assets relative path) where you will create sources `src`
+   * **Webpack assets distribution directory ?** Name of the directory (inside webpack assets relative path) where bundles will be generated `dist`
+   * **Webpack assets distribution scripts directory ?** Name of the directory (inside `dist`) where scripts will be stored (`js`)
+   * **Webpack assets distribution styles directory ?** Name of the directory (inside `dist`) where styles will be stored (`css`)
+   * **Webpack catalog filename ?** Name of catalog file which will allow the asset manager to find the bundles
+
+ * **Generating webpack.config.js** 
+ 
+if you need to regenerate one of the files, you can use the following CLI commands :
+ 
+  * `php protected/yii webpack/generate-config` : regenerate `webpack-yii2.json`
+  * `php protected/yii webpack/generate-package` : regenerate `package.json`
+  * `php protected/yii webpack/generate-webpack` : regenerate `webpack.config.js`
+  
+### Sample application structure
+  
+If your application has the following directory structure : 
+  
+ * *index.php*
+ * *composer.json*
+ * **protected**
+   * *yii* (console script)
+   * **assets**
+     * *WebpackAsset.php*
+     * **webpack**
+       * **src**
+         * *app.ts*
+         * **css**
+           * *app.css*
+   * *...*      
+  
+#### Run webpack init to prepare application 
+  
+The typical answer when running `php protected/yii webpack` would be :
+   
+ * **Generating package.json**
+   * **Relative path to composer.json ?** Leave default value
+   * **Application name ?** Leave default value
+   * **Author ?** Leave default value 
+   * **Description ?** Leave default value 
+   * **License ?** Leave default value
+
+ * **Generating webpack-yii2.json**
+   * **Webpack assets path relative to package.json** `protected/assets/webpack`  
+   * **Webpack assets source directory ?** Leave default value
+   * **Webpack assets distribution directory ?** Leave default value
+   * **Webpack assets distribution scripts directory ?** Leave default value
+   * **Webpack assets distribution styles directory ?** Leave default value
+   * **Webpack catalog filename ?** Leave default value
+
+ * **Generating webpack.config.js** 
+
+Application structure with generated files will be
+
+ * *index.php*
+ * *composer.json*
+ * *package.json*
+ * *webpack-yii2.json*
+ * *webpack.config.js*
+ * **protected**
+   * *yii* (console script)
+   * **assets**
+     * *WebpackAsset.php*
+     * **webpack**
+       * *assets-catalog.json* -> generated by webpack
+       * **dist** -> generated by webpack
+         * **js**
+           * *js bundles*
+         * **css**
+           * *css bundles*
+       * **src**
+         * *app.ts*
+         * **css**
+           * *app.css*
+   * *...*      
+
+#### Create Webpack aware asset
+
+```php
+namespace app\assets;
+
+use sweelix\webpack\WebpackAssetBundle;
+
+class WebpackAsset extends WebpackAssetBundle
+{
+    /**
+     * @var string base webpack alias (do not add /src nor /dist, they are automagically handled)
+     */
+    public $webpackPath = '@app/assets/webpack';
+
+    /**
+     * @var array list of webpack bundles to publish (these are the entries from webpack)
+     * the bundles (except for the manifest one which should be in first position) must be defined
+     * in the webpack-yii2.json configuration file
+     */
+    public $webpackBundles = [
+        'manifest',
+        'app'
+    ];
+
+}
+```  
+
+#### Generate the assets
+
+For development run
+
+```
+webpack
+```
+or to enable automatic build on file change
+```
+webpack --watch
+```
+
+
+For production run
+
+```
+webpack -p
+```
+
+#### Add files to your repository
+
+When your assets are ready, you have to make sure following files are added to your repository :
+
+ * `package.json` node package management
+ * `webpack.config.js` needed to run webpack
+ * `webpack-yii2.json` needed by webpack.config.js to define you app entry points and the target directories
+
+ * `<appdir>/assets/webpack/assets-catalog.json` to let the webpack aware asset find the dist files
+ * `<appdir>/assets/webpack/dist` to keep the assets (they are not dynamically generated when asset is registered)
+ * `<appdir>/assets/webpack/src` because you want to keep your sources :-)
+ 
+
+
+Contributing
+------------
+
+All code contributions - including those of people having commit access -
+must go through a pull request and approved by a core developer before being
+merged. This is to ensure proper review of all the code.
+
+Fork the project, create a [feature branch ](http://nvie.com/posts/a-successful-git-branching-model/), and send us a pull request.

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "sweelix/yii2-webpack",
+    "description": "PHP 5.6+ Webpack integration for the Yii framework",
+    "keywords": ["yii2", "webpack", "assets"],
+    "type": "yii2-extension",
+    "license": "BSD-3-Clause",
+    "authors": [
+        {
+            "name": "Philippe Gaultier",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "yiisoft/yii2": "~2.0",
+        "php" : ">=5.6.0"
+    },
+    "require-dev" : {
+        "php" : ">=5.6.0",
+        "codeception/codeception": "~2.2"
+    },
+    "autoload": {
+        "psr-4": { "sweelix\\webpack\\": "src" }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-devel": "1.0.x-dev"
+        }
+    }
+}

src/Module.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Module.php
+ *
+ * PHP version 5.6+
+ *
+ * @author Philippe Gaultier <[email protected]>
+ * @copyright 2010-2017 Philippe Gaultier
+ * @license http://www.sweelix.net/license license
+ * @version XXX
+ * @link http://www.sweelix.net
+ * @package sweelix\webpack
+ */
+
+namespace sweelix\webpack;
+
+use yii\base\BootstrapInterface;
+use yii\base\Module as BaseModule;
+use yii\console\Application as ConsoleApplication;
+
+
+/**
+ * Oauth2 server Module definition
+ *
+ * @author Philippe Gaultier <[email protected]>
+ * @copyright 2010-2017 Philippe Gaultier
+ * @license http://www.sweelix.net/license license
+ * @version XXX
+ * @link http://www.sweelix.net
+ * @package sweelix\webpack
+ * @since XXX
+ */
+class Module extends BaseModule implements BootstrapInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function bootstrap($app)
+    {
+        if ($app instanceof ConsoleApplication) {
+            $this->mapConsoleControllers($app);
+        }
+    }
+
+    /**
+     * Update controllers map to add console commands
+     * @param ConsoleApplication $app
+     * @since XXX
+     */
+    protected function mapConsoleControllers(ConsoleApplication $app)
+    {
+        $app->controllerMap['webpack'] = [
+            'class' => 'sweelix\webpack\commands\WebpackController',
+        ];
+    }
+}