gulpfile.js

   1 'use strict';
   2
   3 // modules
   4 var browserSync = require('browser-sync');
   5 var csso = require('gulp-csso');
   6 var del = require('del');
   7 var fs = require('fs');
   8 var glob = require('glob');
   9 var gap = require('gulp-append-prepend');
  10 var gulp = require('gulp');
  11 var argv = require('minimist')(process.argv.slice(2));
  12 var gulpif = require('gulp-if');
  13 var prefix = require('gulp-autoprefixer');
  14 var reload = browserSync.reload;
  15 var rename = require('gulp-rename');
  16 var runSequence = require('run-sequence');
  17 var sass = require('gulp-sass');
  18 var sourcemaps = require('gulp-sourcemaps');
  19
  20 var packages = require('./package.json');
  21
  22 // configuration
  23 var config = {
  24     all : [], // must always be empty
  25
  26     /* Command Line Arguments */
  27     dev: argv['dev'],
  28     build: argv['b'],
  29     proxy: argv['p'],
  30     install: argv['i'],
  31
  32     /* Source file locations */
  33     src: {
  34         styles: {
  35             style_uni: 'interface/themes/style_*.scss',
  36             style_color: 'interface/themes/colors/*.scss',
  37             rtl: 'interface/themes/rtl.scss',
  38             all: 'public/themes/**/*style_*.css',
  39         }
  40     },
  41     dist: {
  42         assets: './public/assets/', // vendor assets dir
  43         fonts: './public/fonts/',
  44         storybook: '.docs/.out/'
  45     },
  46     dest: {
  47         themes: 'public/themes'
  48     }
  49 };
  50
  51 /**
  52  * Clean up lingering static assets
  53  */
  54 gulp.task('clean', function () {
  55     if (config.dev) {
  56         let ignore = "!" + config.dist.storybook + '.gitignore';
  57         del.sync([config.dist.storybook + "*", ignore]);
  58     }
  59
  60     return del.sync([config.dest.themes + "/*"]);
  61 });
  62
  63
  64 /**
  65  * Parses command line arguments
  66  */
  67 gulp.task('ingest', function() {
  68     if (config.dev && typeof config.dev !== "boolean") {
  69         // allows for custom proxy to be passed into script
  70         config.proxy = config.dev;
  71         config.dev = true;
  72     }
  73 });
  74
  75
  76 /**
  77  * Will start browser sync and/or watch changes to scss
  78  * - Runs task(styles) first
  79  * - Includes hack to dump fontawesome to the storybook dist
  80  */
  81 gulp.task('sync', function() {
  82     if (config.proxy) {
  83         browserSync.init({
  84             proxy: "127.0.0.1:" + config.proxy
  85         });
  86     }
  87
  88
  89     if (config.build) {
  90         if (config.dev) {
  91             // if building storybook, grab the public folder
  92             gulp.src(['./public/**/*'], {"base" : "."})
  93                 .pipe(gulp.dest(config.dist.storybook));
  94         } else {
  95             // copy all leftover root-level components to the theme directory
  96             // hoping this is only temporary
  97             gulp.src(['interface/themes/*.{css,php}'])
  98                 .pipe(gulp.dest(config.dest.themes));
  99         }
 100     } else {
 101         if (config.dev) {
 102             // watch for changes and run styles on change
 103             gulp.watch('inteface/themes/**/*.scss', ['styles']);
 104         }
 105     }
 106 });
 107
 108 // definition of header for all compiled css
 109 var autoGeneratedHeader = `
 110 /*! This style sheet was autogenerated using gulp + scss
 111  *  For usage instructions, see: https://github.com/openemr/openemr/blob/master/interface/README.md
 112  */
 113 `;
 114
 115
 116 // START style task definitions
 117
 118 /**
 119  * universal css compilcation
 120  */
 121 gulp.task('styles:style_uni', function () {
 122     gulp.src(config.src.styles.style_uni)
 123         .pipe(sourcemaps.init())
 124         .pipe(sass().on('error', sass.logError))
 125         .pipe(prefix('last 1 version'))
 126         .pipe(gap.prependText(autoGeneratedHeader))
 127         .pipe(gulpif(!config.dev, csso()))
 128         .pipe(gulpif(!config.dev,sourcemaps.write()))
 129         .pipe(gulp.dest(config.dest.themes))
 130         .pipe(gulpif(config.dev && config.build, gulp.dest(config.dist.storybook + config.dest.themes)))
 131         .pipe(gulpif(config.dev, reload({stream:true})));
 132 });
 133
 134 /**
 135  * color compilation for colored themes
 136  */
 137 gulp.task('styles:style_color', function () {
 138     gulp.src(config.src.styles.style_color)
 139         .pipe(sourcemaps.init())
 140         .pipe(sass().on('error', sass.logError))
 141         .pipe(prefix('last 1 version'))
 142         .pipe(gap.prependText(autoGeneratedHeader))
 143         .pipe(gulpif(!config.dev, csso()))
 144         .pipe(gulpif(!config.dev,sourcemaps.write()))
 145         .pipe(gulp.dest(config.dest.themes))
 146         .pipe(gulpif(config.dev && config.build, gulp.dest(config.dist.storybook + config.dest.themes)))
 147         .pipe(gulpif(config.dev, reload({stream:true})));
 148 });
 149
 150 /**
 151  * append rtl css to all style themes
 152  * also, create list of all themes for style_list to use
 153  */
 154 gulp.task('styles:rtl', function () {
 155     var uni = glob.sync(config.src.styles.style_uni);
 156     var colors = glob.sync(config.src.styles.style_color);
 157     config.all = uni.concat(colors);
 158
 159     for (var i=0; i<config.all.length; i++) {
 160         var name = config.all[i].split('themes/')[1];
 161         gulp.src(config.src.styles.rtl)
 162         .pipe(gap.prependText('@import "' + name + '";\n'))
 163             .pipe(sourcemaps.init())
 164             .pipe(sass().on('error', sass.logError))
 165             .pipe(prefix('last 1 version'))
 166             .pipe(gulpif(!config.dev, csso()))
 167             .pipe(gulpif(!name.startsWith('colors'), rename({
 168                 basename: name.slice(0,-5), // remove suffix from name
 169                 prefix:"rtl_"
 170             })))
 171             .pipe(gulpif(name.startsWith('colors'), rename({
 172                 basename: name.slice(7,-5), // remove prefix and suffix from name
 173                 prefix:"rtl_"
 174             })))
 175             .pipe(gulp.dest(config.dest.themes))
 176             .pipe(gulpif(config.dev && config.build, gulp.dest(config.dist.storybook + config.dest.themes)))
 177             .pipe(gulpif(config.dev, reload({stream:true})));
 178     }
 179
 180 });
 181
 182 gulp.task('styles', ['styles:style_uni', 'styles:style_color', 'styles:rtl']);
 183 // END style task definitions
 184
 185 /*
 186 * Create a JSON for storybook to use
 187 */
 188 gulp.task('style_list', function () {
 189     if (config.dev) {
 190         var style_list = [];
 191         for (var i=0; i<config.all.length; i++) {
 192             var theme_name = "style_" + config.all[i].split('style_')[1].slice(0,-5);
 193             style_list.push(theme_name);
 194             style_list.push('rtl_' + theme_name);
 195         }
 196         fs.writeFileSync('.storybook/themeOptions.json', JSON.stringify(style_list), 'utf8');
 197     }
 198 });
 199
 200
 201 /**
 202  * Copies node_modules to ./public
 203  */
 204 gulp.task('install', function() {
 205
 206     // combine dependencies and napa sources into one object
 207     var dependencies = packages.dependencies;
 208     for (var key in packages.napa) {
 209         if (packages.napa.hasOwnProperty(key)) {
 210             dependencies[key] = packages.napa[key];
 211         }
 212     }
 213
 214     for (var key in dependencies) {
 215         // check if the property/key is defined in the object itself, not in parent
 216         if (dependencies.hasOwnProperty(key)) {
 217             // only copy dist directory, if it exists
 218             // skip this if for dwv dependency
 219             if (key != 'dwv' && fs.existsSync('node_modules/' + key + '/dist')) {
 220                 gulp.src('node_modules/' + key + '/dist/**/*')
 221                     .pipe(gulp.dest(config.dist.assets + key + '/dist'));
 222             } else {
 223                 gulp.src('node_modules/' + key + '/**/*')
 224                     .pipe(gulp.dest(config.dist.assets + key));
 225             }
 226         }
 227     }
 228 });
 229
 230  /**
 231  * Default config
 232  * - runs by default when `gulp` is called from CLI
 233  */
 234 if (config.install) {
 235     gulp.task('default', [ 'install' ]);
 236 } else {
 237     gulp.task('default', function (callback) {
 238         runSequence(['ingest', 'clean'], [ 'styles', 'sync' ], 'style_list', callback)
 239     });
 240 }
 241