MAGETWO-38002: Automate UI Documentation build process with Grunt.js

- Added Grunt replace plugin
- Automated Grunt documentation task

Author: Bogdan Plieshka

Gruntfile.js

@@ -68,12 +68,17 @@ module.exports = function (grunt) {
             'less:luma',
             'less:backend'
         ],
+
         /**
          * Documentation
          */
         documentation: [
+            'replace:documentation',
             'less:documentation',
             'styledocco:documentation',
+            'usebanner:documentationCss',
+            'usebanner:documentationLess',
+            'usebanner:documentationHtml',
             'clean:var',
             'clean:pub'
         ],
@@ -82,12 +87,6 @@ module.exports = function (grunt) {
             'mage-minify:legacy'
         ],
 
-        'documentation-banners': [
-            'usebanner:documentationCss',
-            'usebanner:documentationLess',
-            'usebanner:documentationHtml'
-        ],
-
         spec: function (theme) {
             var runner = require('./dev/tests/js/jasmine/spec_runner');
 

dev/tools/grunt/configs/replace.js

@@ -0,0 +1,46 @@
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+'use strict';
+
+function findCopyright(lang) {
+    var copyrightText = {
+        firstLine: 'Copyright © 2015 Magento. All rights reserved.',
+        secondLine: 'See COPYING.txt for license details.'
+    };
+    switch (lang) {
+        case 'less':
+            return new RegExp(
+                '// /\\*\\*\r\n//  \\* ' +
+                copyrightText.firstLine +
+                '\r\n//  \\* ' +
+                copyrightText.secondLine +
+                '\r\n//  \\*/\r\n\r\n'
+            );
+            break;
+        default:
+            return;
+    }
+}
+
+module.exports = {
+    documentation: {
+        options: {
+            patterns: [{
+                match: findCopyright('less'),
+                replacement: ''
+            }]
+        },
+        files: [{
+            expand: true,
+            flatten: true,
+            src: [
+                '<%= path.doc %>/source/**/*.less'
+            ],
+            dest: '<%= path.doc %>/source/'
+        }]
+    }
+
+};

dev/tools/grunt/configs/usebanner.js

@@ -5,22 +5,25 @@
 
 'use strict';
 
-var banner = {
-    firstLine: 'Copyright © 2015 Magento. All rights reserved.',
-    secondLine: 'See COPYING.txt for license details.',
-
-    css: function () {
-        return '/**\n * ' + this.firstLine + '\n * ' + this.secondLine + '\n */\n';
-    },
-
-    less: function () {
-        return '// /**\n//  * ' + this.firstLine + '\n//  * ' + this.secondLine + '\n//  */\n';
-    },
-
-    html: function () {
-        return '<!--\n/**\n * ' + this.firstLine + '\n * ' + this.secondLine + '\n */\n-->\n';
+function printCopyright(lang) {
+    var copyrightText = {
+        firstLine: 'Copyright © 2015 Magento. All rights reserved.',
+        secondLine: 'See COPYING.txt for license details.'
+    };
+    switch (lang) {
+        case 'css':
+            return '/**\n * ' + copyrightText.firstLine + '\n * ' + copyrightText.secondLine + '\n */\n';
+            break;
+        case 'less':
+            return '// /**\n//  * ' + copyrightText.firstLine + '\n//  * ' + copyrightText.secondLine + '\n//  */\n';
+            break;
+        case 'html':
+            return '<!--\n/**\n * ' + copyrightText.firstLine + '\n * ' + copyrightText.secondLine + '\n */\n-->\n';
+            break;
+        default:
+            return;
     }
-};
+}
 
 module.exports = {
     options: {
@@ -29,31 +32,31 @@ module.exports = {
     },
     setup: {
         options: {
-            banner: banner.css()
+            banner: printCopyright('css')
         },
         files: {
             src: '<%= path.css.setup %>/*.css'
         }
     },
     documentationCss: {
         options: {
-            banner: banner.css()
+            banner: printCopyright('css')
         },
         files: {
             src: '<%= path.doc %>/**/*.css'
         }
     },
     documentationLess: {
         options: {
-            banner: banner.less()
+            banner: printCopyright('less')
         },
         files: {
             src: '<%= path.doc %>/**/*.less'
         }
     },
     documentationHtml: {
         options: {
-            banner: banner.html()
+            banner: printCopyright('html')
         },
         files: {
             src: '<%= path.doc %>/**/*.html'

package.json

@@ -20,6 +20,7 @@
     "grunt-contrib-less": "^0.12.0",
     "grunt-contrib-watch": "^0.6.1",
     "grunt-exec": "^0.4.6",
+    "grunt-replace": "^0.9.2",
     "grunt-styledocco": "^0.1.4",
     "grunt-template-jasmine-requirejs": "^0.2.3",
     "grunt-text-replace": "^0.4.0",