Merge pull request #131 from OfficeDev/leddie24/add-comments-to-js-he…

…ader add version number to JS/CSS and component files
OfficeDev · Sep 27, 2016 · fa2d27d · fa2d27d
2 parents 4422431 + 5da65f0
commit fa2d27d
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 3 deletions.
diff --git a/gulp/ComponentJS.js b/gulp/ComponentJS.js
@@ -45,18 +45,21 @@ gulp.task('ComponentJS-typescript', ['Documentation-template'], function() {
 
       // place .d.ts outqput in both the Samples folder and the Components folder
       tscResult.dts.pipe(Plugins.concat("fabric.d.ts"))
-                   .pipe(Plugins.header(Banners.getJSCopyRight()))
+                   .pipe(Plugins.header(Banners.getBannerTemplate(), Banners.getBannerData()))
+                   .pipe(Plugins.header(Banners.getJSCopyRight(), Banners.getBannerData()))
                    .pipe(gulp.dest(Config.paths.distJS))
                    .pipe(Plugins.gulpif(Config.debugMode, Plugins.debug({
                      title: "Output Fabric Component .d.ts built from TypeScript"
                    }))),
 
       // place .js output in both the Samples folder and the Components folder
       tscResult.js.pipe(Plugins.concat("fabric.js"))
-                    .pipe(Plugins.header(Banners.getJSCopyRight()))
+                    .pipe(Plugins.header(Banners.getBannerTemplate(), Banners.getBannerData()))
                     .pipe(gulp.dest(Config.paths.distJS))
                     .pipe(Plugins.uglify())
                     .pipe(Plugins.rename('fabric.min.js'))
+                    .pipe(Plugins.header(Banners.getBannerTemplate(), Banners.getBannerData()))
+                    .pipe(Plugins.header(Banners.getJSCopyRight(), Banners.getBannerData()))
                     .pipe(gulp.dest(Config.paths.distJS))
                     .pipe(Plugins.gulpif(Config.debugMode, Plugins.debug({
                         title: "Output Fabric Component .d.ts built from TypeScript"

diff --git a/gulp/Documentation.js b/gulp/Documentation.js
@@ -89,6 +89,7 @@ gulp.task('Documentation-handlebars', function(cb) {
 gulp.task('Documentation-template', ["Documentation-handlebars"], function(cb) {
   var _template = new Template(folderList, Config.paths.distJS, Config.paths.componentsPath, function() {
     gulp.src(Config.paths.distJS + "/fabric.templates.ts")
+    .pipe(Plugins.header(Banners.getBannerTemplate(), Banners.getBannerData()))
     .pipe(Plugins.header(Banners.getJSCopyRight()))
     .pipe(Plugins.tsc(Config.typescriptProject))
     .js.pipe(gulp.dest(Config.paths.distJS))
@@ -99,6 +100,13 @@ gulp.task('Documentation-template', ["Documentation-handlebars"], function(cb) {
   _template.init();
 });
 
+gulp.task('Documentation-templateAddHeader', ['Documentation-template'], function(){
+  gulp.src(Config.paths.distJS + "/fabric.templates.ts")
+    .pipe(Plugins.header(Banners.getBannerTemplate(), Banners.getBannerData()))
+    .pipe(Plugins.header(Banners.getJSCopyRight()))
+    .pipe(gulp.dest(Config.paths.distJS));
+});
+
 //
 // Sample Component Building
 // ----------------------------------------------------------------------------
@@ -270,6 +278,7 @@ var DocumentationTasks = [
     'ComponentJS',
     'Documentation-copyIgnoredFiles',
     "Documentation-template",
+    "Documentation-templateAddHeader",
     "Documentation-buildStyles",
     "Documentation-convertMarkdown"
 ];

diff --git a/gulp/FabricComponents.js b/gulp/FabricComponents.js
@@ -25,7 +25,11 @@ gulp.task('FabricComponents-nuke', function () {
 
 gulp.task('FabricComponents-copyAssets', function () {
     // Copy all Components files.
-    return gulp.src([Config.paths.componentsPath + '/**', '!' + Config.paths.componentsPath + '/**/*.js', '!' + Config.paths.componentsPath + '/**/*.ts'])
+    return gulp.src([Config.paths.componentsPath + '/**/*.json',
+        '!' + Config.paths.componentsPath + '/**/*.js',
+        '!' + Config.paths.componentsPath + '/**/*.ts',
+        '!' + Config.paths.componentsPath + '/**/*.hbs',
+        '!' + Config.paths.componentsPath + '/**/*.scss'])
         .pipe(Plugins.plumber(ErrorHandling.onErrorInPipe))
         .pipe(Plugins.changed(Config.paths.distComponents))
         .pipe(Plugins.gulpif(Config.debugMode, Plugins.debug({
@@ -44,6 +48,28 @@ gulp.task('FabricCoreStyles-copyAssets', function() {
             .pipe(gulp.dest(Config.paths.distCSS));
 });
 
+//
+// Add Comments to Component Files (HBS and SCSS) and copy to Dist/Components
+// ----------------------------------------------------------------------------
+
+gulp.task('FabricComponents-addCommentsToComponentsHBS', ['FabricComponents-copyAssets'], function(){
+    return gulp.src(Config.paths.componentsPath + '/**/' + '*.hbs')
+            .pipe(Plugins.debug({
+                title: "Adding Comments to Component HBS"
+            }))
+            .pipe(Plugins.header(Banners.getBannerTemplateHTML(), Banners.getBannerData()))
+            .pipe(gulp.dest(Config.paths.distComponents));
+});
+
+gulp.task('FabricComponents-addCommentsToComponentsSCSS', ['FabricComponents-copyAssets'], function(){
+    return gulp.src(Config.paths.componentsPath + '/**/' + '*.scss')
+            .pipe(Plugins.debug({
+                title: "Adding Comments to Component SASS"
+            }))
+            .pipe(Plugins.header(Banners.getBannerTemplate(), Banners.getBannerData()))
+            .pipe(gulp.dest(Config.paths.distComponents));
+});
+
 
 //
 // Sass tasks
@@ -102,6 +128,8 @@ gulp.task('FabricComponents', [
         'FabricComponents-buildAndCombineStyles',
         'FabricComponents-copyAssets', 
         'FabricCoreStyles-copyAssets',
+        'FabricComponents-addCommentsToComponentsHBS',
+        'FabricComponents-addCommentsToComponentsSCSS',
         'ComponentJS'
     ]
 );

diff --git a/gulp/modules/Banners.js b/gulp/modules/Banners.js
@@ -26,6 +26,17 @@ var Banners = function() {
 					' **/',
       			''].join('\n');
 	};
+	/**
+     * Retrieve Banner Template with Template Variables
+     * @returns {String} with template variables for pkg version and pkg description
+     */
+	this.getBannerTemplateHTML = function() {
+		return ['<!--',
+					'Office UI Fabric JS <%= pkg.version %>',
+					'<%= pkg.description %>',
+					'-->',
+      			''].join('\n');
+	};
     /**
      * Retrieve Copyright Comment for Javascript
      * @returns {String} containing Javascript Comment Speicific Copyright Message