notifications-admin/gulpfile.js

const { src, dest, series } = require('gulp');
const rollup = require('@rollup/stream');
const rollupPluginCommonjs = require('@rollup/plugin-commonjs');
const rollupPluginNodeResolve = require('@rollup/plugin-node-resolve');
const source = require('vinyl-source-stream');
const buffer = require('vinyl-buffer');
const gulpMerge = require('gulp-merge');
const uswds = require('@uswds/compile');
const { exec } = require('child_process');
const plugins = {};
plugins.addSrc = require('gulp-add-src');
plugins.babel = require('gulp-babel');
plugins.cleanCSS = require('gulp-clean-css');
plugins.concat = require('gulp-concat');
plugins.jshint = require('gulp-jshint');
plugins.prettyerror = require('gulp-prettyerror');
plugins.uglify = require('gulp-uglify');

const paths = {
  src: 'app/assets/',
  dist: 'app/static/',
  npm: 'node_modules/',
  toolkit: 'node_modules/govuk_frontend_toolkit/',
  govuk_frontend: 'node_modules/govuk-frontend/',
};

const javascripts = () => {
  const vendored = rollup({
    input: paths.src + 'javascripts/modules/all.mjs',
    plugins: [
      rollupPluginNodeResolve({
        mainFields: ['module', 'main'],
      }),
      rollupPluginCommonjs({
        include: 'node_modules/**',
      }),
    ],
    output: {
      format: 'iife',
      name: 'GOVUK',
    },
  })
    .pipe(source('all.mjs'))
    .pipe(buffer())
    .pipe(
      plugins.addSrc.prepend([
        paths.npm + 'jquery/dist/jquery.min.js',
        paths.npm + 'query-command-supported/dist/queryCommandSupported.min.js',
        paths.npm + 'textarea-caret/index.js',
        paths.npm + 'cbor-js/cbor.js',
        paths.npm + 'd3/dist/d3.min.js',
        paths.npm + 'socket.io-client/dist/socket.io.min.js'
      ])
    );

  const local = src([
    paths.toolkit + 'javascripts/govuk/modules.js',
    paths.toolkit + 'javascripts/govuk/show-hide-content.js',
    paths.src + 'javascripts/copyToClipboard.js',
    paths.src + 'javascripts/enhancedTextbox.js',
    paths.src + 'javascripts/fileUpload.js',
    paths.src + 'javascripts/radioSelect.js',
    paths.src + 'javascripts/updateContent.js',
    paths.src + 'javascripts/listEntry.js',
    paths.src + 'javascripts/liveSearch.js',
    paths.src + 'javascripts/errorTracking.js',
    paths.src + 'javascripts/preventDuplicateFormSubmissions.js',
    paths.src + 'javascripts/fullscreenTable.js',
    paths.src + 'javascripts/templateFolderForm.js',
    paths.src + 'javascripts/collapsibleCheckboxes.js',
    paths.src + 'javascripts/radioSlider.js',
    paths.src + 'javascripts/updateStatus.js',
    paths.src + 'javascripts/errorBanner.js',
    paths.src + 'javascripts/notifyModal.js',
    paths.src + 'javascripts/timeoutPopup.js',
    paths.src + 'javascripts/date.js',
    paths.src + 'javascripts/loginAlert.js',
    paths.src + 'javascripts/main.js',
    paths.src + 'javascripts/totalMessagesChart.js',
    paths.src + 'javascripts/activityChart.js',
    paths.src + 'javascripts/sidenav.js',
    paths.src + 'javascripts/validation.js',
    paths.src + 'javascripts/socketio.js',
  ])
    .pipe(plugins.prettyerror())
    .pipe(
      plugins.babel({
        presets: ['@babel/preset-env'],
      })
    );

  return gulpMerge(vendored, local)
    .pipe(plugins.uglify())
    .pipe(plugins.concat('all.js'))
    .pipe(dest(paths.dist + 'javascripts/'));
};

// Task to copy `gtm_head.js`
const copyGtmHead = () => {
  return src(paths.src + 'js/gtm_head.js').pipe(dest(paths.dist + 'js/'));
};

// Task to copy `setTimezone.js`
const copySetTimezone = () => {
  return src(paths.src + 'js/setTimezone.js').pipe(dest(paths.dist + 'js/'));
};

// Task to copy images
const copyImages = () => {
  return src(paths.src + 'images/**/*', { encoding: false }).pipe(
    dest(paths.dist + 'images/')
  );
};

// Task to pdf files
const copyPDF = () => {
  return src(paths.src + 'pdf/**/*', { encoding: false }).pipe(
    dest(paths.dist + 'pdf/')
  );
};

const copyUSWDSJS = () => {
  return src('node_modules/@uswds/uswds/dist/js/uswds.min.js')
    .pipe(dest(paths.dist + 'js/'));
};

// Configure USWDS paths
uswds.settings.version = 3;
uswds.settings.compile = {
  sass: true,
  javascript: true,
  sprites: false
};

uswds.paths.dist.css = paths.dist + 'css';
uswds.paths.dist.js = paths.dist + 'js';
uswds.paths.dist.img = paths.dist + 'img';
uswds.paths.dist.pdf = paths.dist + 'pdf';
uswds.paths.dist.fonts = paths.dist + 'fonts';
uswds.paths.dist.theme = paths.src + 'sass/uswds';

// Task to compile USWDS styles
const styles = async () => {
  await uswds.compileSass();
};

// Task to copy USWDS assetsconst
const copyUSWDSAssets = () => {
  return src([
    'node_modules/@uswds/uswds/dist/img/**/*',
    'node_modules/@uswds/uswds/dist/fonts/**/*'
  ], { encoding: false })
    .pipe(dest((file) => {
      if (file.path.includes('/img/')) {
        return paths.dist + 'img/';
      } else if (file.path.includes('/fonts/')) {
        return paths.dist + 'fonts/';
      }
      return paths.dist;
    }));
};

// Optional backstopJS task
// Install gulp globally and run `gulp backstopTest`
const backstopTest = (done) => {
  exec(
    'npx backstop test --configPath=backstop.config.js',
    (err, stdout, stderr) => {
      console.log(stdout);
      console.error(stderr);
      done(err);
    }
  );
};

// Optional backstopJS reference task
// Install gulp globally and run `gulp backstopReference`
const backstopReference = (done) => {
  exec(
    'npx backstop reference --configPath=backstop.config.js',
    (err, stdout, stderr) => {
      console.log(stdout);
      console.error(stderr);
      done(err);
    }
  );
};

// Export tasks
exports.default = series(
  styles,
  javascripts,
  copyGtmHead,
  copySetTimezone,
  copyImages,
  copyPDF,
  copyUSWDSAssets,
  copyUSWDSJS
);
exports.backstopTest = backstopTest;
exports.backstopReference = backstopReference;