Gulpfile.babel.js

/**
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


import cssnano from "cssnano";
import debounce from "debounce";
import del from "del";
import gulp from "gulp";
import brotli from "gulp-brotli";
import gulpConcat from "gulp-concat";
import gzip from "gulp-gzip";
import gulpImage from "gulp-image";
import postcss from "gulp-postcss";
import manifest from "gulp-rev-all";
import manifestClean from "gulp-rev-napkin";
import sass from "gulp-dart-sass";
import sourcemaps from "gulp-sourcemaps";
import composer from "gulp-uglify/composer";
import path from "path";
import uglifyjs from "uglify-js";
import named from "vinyl-named";
import webpack from "webpack";
import gulpWebpack from "webpack-stream";
import rtlcss from "gulp-rtlcss";
import rename from "gulp-rename";


// Configure where our files come from, where they get saved too, and what path
// they are served from.
let staticPrefix = "warehouse/static/";
let distPath = path.join(staticPrefix, "dist");
let publicPath = "/static/";


// We pass in our own uglify instance rather than allow
// gulp-uglify to use it's own. This makes the usage slightly
// more complicated, however it means that we have explicit
// control over the exact version of uglify-js used.
var uglify = composer(uglifyjs, console);

// Configure what plugins are used for postcss
var postCSSPlugins = [
  cssnano({
    preset: ["default", {
      discardComments: {
        removeAll: true,
      },
    }],
  }),
];

// Configure webpack so that it compiles all of our javascript into a bundle.
let webpackConfig = {
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: "babel-loader",
          options: {
            presets: ["@babel/preset-env"],
            plugins: ["@babel/plugin-proposal-class-properties"],
          },
        },
      },
    ],
  },
  plugins: [
    new webpack.ProvidePlugin({
      "fetch": "imports-loader?this=>global!exports-loader?global.fetch!whatwg-fetch",
      "jQuery": "jquery",
      "$": "jquery",
    }),
  ],
  // We tell it to use an inline source map, but only so that it can be loaded
  // by gulp-sourcemaps later on. It will actually be written out to disk and
  // *NOT* inlined when all is said and done.
  devtool: "inline-source-map",
  output: {
    publicPath: publicPath + "js/",
    filename: "[name].js",
    chunkFilename: "chunks/[chunkhash].js",
  },
  resolve: {
    modules: [path.resolve(staticPrefix, "js"), "node_modules"],
    alias: {
      "clipboard": "clipboard/dist/clipboard",
    },
  },
};


gulp.task("dist:js", () => {
  let files = [
    path.join(staticPrefix, "js", "warehouse", "index.js"),
  ];

  return gulp.src(files)
    // .pipe(named(() => { return "warehouse"; }))
    .pipe(named((file) => {
      // Get the filename that is relative to our js directory
      let relPath = path.relative(
        path.join(staticPrefix, "js"),
        file.path
      );
      // If this is our main application, then we want to call it
      // just "warehouse", otherwise, we'll use whatever the real
      // name is.
      if (relPath == "warehouse/index.js") { return "warehouse"; }
      else { return path.parse(relPath).name; }
    }))
    .pipe(gulpWebpack(webpackConfig, webpack))
    .pipe(sourcemaps.init({ loadMaps: true }))
    .pipe(uglify(
      // We don't care about IE6-8 so there's no reason to have
      // uglify contain to maintain compatibility for it.
      { compress: { ie8: false }, mangle: { ie8: false } }
    ))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest(path.join(distPath, "js")));
});

gulp.task("dist:noscript", () => {
  let sassPath = path.join(staticPrefix, "sass");

  return gulp.src(path.join(sassPath, "noscript.scss"))
    .pipe(sourcemaps.init())
    .pipe(
      sass({ includePaths: [sassPath] })
        .on("error", sass.logError))
    .pipe(postcss(postCSSPlugins))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest(path.join(distPath, "css")));
});


gulp.task("dist:admin:fonts", (done) => {
  gulp.src("warehouse/admin/static/fonts/*.*")
    .pipe(gulp.dest("warehouse/admin/static/dist/fonts"));
  gulp.src("warehouse/admin/static/webfonts/*.*")
    .pipe(gulp.dest("warehouse/admin/static/dist/webfonts"));

  done();
});


gulp.task("dist:admin:css", () => {
  let files = [ // Order matters!
    "warehouse/admin/static/css/bootstrap.min.css",
    "warehouse/admin/static/css/fontawesome.min.css",
    "warehouse/admin/static/css/ionicons.min.css",
    "warehouse/admin/static/css/AdminLTE.min.css",
    "warehouse/admin/static/css/skins/skin-purple.min.css",
    "warehouse/admin/static/css/admin.css",
  ];
  return gulp.src(files)
    .pipe(gulpConcat("all.css"))
    .pipe(sourcemaps.init({ loadMaps: true }))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest("warehouse/admin/static/dist/css"));
});


gulp.task("dist:admin:js", () => {
  return gulp.src("warehouse/admin/static/js/*.js")
    .pipe(named(() => { return "admin"; }))
    .pipe(gulpWebpack(webpackConfig, webpack))
    .pipe(sourcemaps.init({ loadMaps: true }))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest(path.join("warehouse/admin/static/dist/js")));
});


gulp.task("dist:admin:compress:gz", () => {
  return gulp.src(path.join("warehouse/admin/static/dist", "**", "*"))
    .pipe(gzip({
      skipGrowingFiles: true,
      gzipOptions: { level: 9, memLevel: 9 },
    }))
    .pipe(gulp.dest("warehouse/admin/static/dist"));
});


gulp.task("dist:admin:compress:br:generic", () => {
  let paths = [
    path.join("warehouse/admin/static/dist", "fonts", "*.otf"),
    path.join("warehouse/admin/static/dist", "fonts", "*.woff"),
    path.join("warehouse/admin/static/dist", "fonts", "*.woff2"),
    path.join("warehouse/admin/static/dist", "fonts", "*.ttf"),
    path.join("warehouse/admin/static/dist", "fonts", "*.eot"),
    path.join("warehouse/admin/static/dist", "fonts", "*.svg"),

    path.join("warehouse/admin/static/dist", "images", "*.jpg"),
    path.join("warehouse/admin/static/dist", "images", "*.png"),
    path.join("warehouse/admin/static/dist", "images", "*.svg"),
    path.join("warehouse/admin/static/dist", "images", "*.ico"),
  ];

  return gulp.src(paths, { base: "warehouse/admin/static/dist" })
    .pipe(brotli.compress({ skipLarger: true, mode: 0, quality: 11 }))
    .pipe(gulp.dest("warehouse/admin/static/dist"));
});


gulp.task("dist:admin:compress:br:text", () => {
  let paths = [
    path.join("warehouse/admin/static/dist", "css", "*.css"),
    path.join("warehouse/admin/static/dist", "css", "*.map"),
    path.join("warehouse/admin/static/dist", "js", "*.js"),
    path.join("warehouse/admin/static/dist", "js", "*.map"),
    path.join("warehouse/admin/static/dist", "manifest.json"),
  ];

  return gulp.src(paths, { base: "warehouse/admin/static/dist" })
    .pipe(brotli.compress({ skipLarger: true, mode: 1, quality: 11 }))
    .pipe(gulp.dest("warehouse/admin/static/dist"));
});


gulp.task(
  "dist:admin:compress:br",
  gulp.parallel("dist:admin:compress:br:generic", "dist:admin:compress:br:text")
);


gulp.task("dist:admin:compress", gulp.parallel("dist:admin:compress:gz", "dist:admin:compress:br"));


gulp.task("dist:admin:manifest", () => {
  let paths = [
    // Cachebust our CSS files and the source maps for them.
    path.join("warehouse/admin/static/dist", "css", "*.css"),
    path.join("warehouse/admin/static/dist", "css", "*.map"),

    // Cachebust our Font files.
    path.join("warehouse/admin/static/dist", "fonts", "*"),
    path.join("warehouse/admin/static/dist", "webfonts", "*"),

    // Cachebust our JS files and the source maps for them.
    path.join("warehouse/admin/static/dist", "js", "*.js"),
    path.join("warehouse/admin/static/dist", "js", "*.map"),

    // Cachebust our vendored JS files and the source maps for them.
    path.join("warehouse/admin/static/dist", "js", "vendor", "*.js"),
    path.join("warehouse/admin/static/dist", "js", "vendor", "*.map"),

    // Cachebust our Image files.
    path.join("warehouse/admin/static/dist", "images", "*"),
  ];

  return gulp.src(paths, { base: "warehouse/admin/static/dist" })
    .pipe(manifest.revision({
      fileNameManifest: "manifest.json",
      includeFilesInManifest: [
        ".css",
        ".map",
        ".woff",
        ".woff2",
        ".svg",
        ".eot",
        ".ttf",
        ".otf",
        ".png",
        ".jpg",
        ".ico",
        ".js",
      ],
    }))
    .pipe(gulp.dest("warehouse/admin/static/dist"))
    .pipe(manifestClean({ verbose: false }))
    .pipe(manifest.manifestFile())
    .pipe(gulp.dest("warehouse/admin/static/dist"));
});



gulp.task("dist:css-ltr", () => {
  let sassPath = path.join(staticPrefix, "sass");

  return gulp.src(path.join(sassPath, "warehouse.scss"))
    .pipe(sourcemaps.init())
    .pipe(
      sass({ includePaths: [sassPath] })
        .on("error", sass.logError))
    .pipe(rename({ suffix: "-ltr" }))
    .pipe(postcss(postCSSPlugins))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest(path.join(distPath, "css")));
});

gulp.task("dist:css-rtl", () => {
  let sassPath = path.join(staticPrefix, "sass");

  return gulp.src(path.join(sassPath, "warehouse.scss"))
    .pipe(sourcemaps.init())
    .pipe(
      sass({ includePaths: [sassPath] })
        .on("error", sass.logError))
    .pipe(rtlcss()) // Convert to RTL.
    .pipe(rename({ suffix: "-rtl" }))
    .pipe(postcss(postCSSPlugins))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest(path.join(distPath, "css")));
});


gulp.task("dist:fontawesome:css", () => {
  let fABasePath = path.dirname(require.resolve("@fortawesome/fontawesome-free/package.json")); // eslint-disable-line no-undef
  let fACSSPath = path.resolve(fABasePath, "css", "*.css");

  return gulp.src(fACSSPath)
    .pipe(sourcemaps.init({ loadMaps: true }))
    .pipe(postcss(postCSSPlugins))
    .pipe(sourcemaps.write("."))
    .pipe(gulp.dest(path.join(distPath, "css")));
});

gulp.task("dist:fontawesome:fonts", () => {
  let fABasePath = path.dirname(require.resolve("@fortawesome/fontawesome-free/package.json")); // eslint-disable-line no-undef
  let faFontPath = path.resolve(fABasePath, "webfonts", "*.*");

  return gulp.src(faFontPath)
    .pipe(gulp.dest(path.join(distPath, "webfonts")));
});


gulp.task("dist:fontawesome", gulp.parallel("dist:fontawesome:css", "dist:fontawesome:fonts"));


gulp.task("dist:images", () => {
  return gulp.src(path.join(staticPrefix, "images", "**", "*"))
    .pipe(gulpImage({
      "svgo": false,  // SVGO is currently broken.
    }))
    .pipe(gulp.dest(path.join(distPath, "images")));
});

gulp.task("dist:vendor", () => {
  return gulp.src(path.join(staticPrefix, "js", "vendor", "**", "*"))
    .pipe(gulp.dest(path.join(distPath, "js", "vendor")));
});


gulp.task("dist:manifest", () => {
  let paths = [
    // Cachebust our CSS files and the source maps for them.
    path.join(distPath, "css", "*.css"),
    path.join(distPath, "css", "*.map"),

    // Cachebust our Font files.
    path.join(distPath, "fonts", "*"),
    path.join(distPath, "webfonts", "*"),

    // Cachebust our JS files and the source maps for them.
    path.join(distPath, "js", "*.js"),
    path.join(distPath, "js", "*.map"),

    // Cachebust our vendored JS files and the source maps for them.
    path.join(distPath, "js", "vendor", "*.js"),
    path.join(distPath, "js", "vendor", "*.map"),

    // Cachebust our Image files.
    path.join(distPath, "images", "*"),
  ];

  return gulp.src(paths, { base: distPath })
    .pipe(manifest.revision({
      fileNameManifest: "manifest.json",
      includeFilesInManifest: [
        ".css",
        ".map",
        ".woff",
        ".woff2",
        ".svg",
        ".eot",
        ".ttf",
        ".otf",
        ".png",
        ".jpg",
        ".ico",
        ".js",
      ],
    }))
    .pipe(gulp.dest(distPath))
    .pipe(manifestClean({ verbose: false }))
    .pipe(manifest.manifestFile())
    .pipe(gulp.dest(distPath));
});


gulp.task("dist:compress:gz", () => {
  return gulp.src(path.join(distPath, "**", "*"))
    .pipe(gzip({
      skipGrowingFiles: true,
      gzipOptions: { level: 9, memLevel: 9 },
    }))
    .pipe(gulp.dest(distPath));
});


gulp.task("dist:compress:br:generic", () => {
  let paths = [
    path.join(distPath, "fonts", "*.otf"),
    path.join(distPath, "fonts", "*.woff"),
    path.join(distPath, "fonts", "*.woff2"),
    path.join(distPath, "fonts", "*.ttf"),
    path.join(distPath, "fonts", "*.eot"),
    path.join(distPath, "fonts", "*.svg"),

    path.join(distPath, "images", "*.jpg"),
    path.join(distPath, "images", "*.png"),
    path.join(distPath, "images", "*.svg"),
    path.join(distPath, "images", "*.ico"),
  ];

  return gulp.src(paths, { base: distPath })
    .pipe(brotli.compress({ skipLarger: true, mode: 0, quality: 11 }))
    .pipe(gulp.dest(distPath));
});


gulp.task("dist:compress:br:text", () => {
  let paths = [
    path.join(distPath, "css", "*.css"),
    path.join(distPath, "css", "*.map"),
    path.join(distPath, "js", "*.js"),
    path.join(distPath, "js", "*.map"),
    path.join(distPath, "manifest.json"),
  ];

  return gulp.src(paths, { base: distPath })
    .pipe(brotli.compress({ skipLarger: true, mode: 1, quality: 11 }))
    .pipe(gulp.dest(distPath));
});


gulp.task(
  "dist:compress:br",
  gulp.parallel("dist:compress:br:generic", "dist:compress:br:text")
);


gulp.task("dist:compress", gulp.parallel("dist:compress:gz", "dist:compress:br"));


gulp.task("clean", () => { return del([distPath, "warehouse/admin/static/dist"]); });

gulp.task("dist", gulp.series(
  // Ensure that we have a good clean base to start out with, by blowing away
  // any previously built files.
  "clean",
  // Build all of our static assets.
  gulp.parallel(
    "dist:fontawesome",
    "dist:css-ltr",
    "dist:css-rtl",
    "dist:noscript",
    "dist:js",
    "dist:admin:fonts",
    "dist:admin:css",
    "dist:admin:js",
    "dist:vendor",
  ),
  // We have this here, instead of in the list above even though there is no
  // ordering dependency so that all of it's output shows up together which
  // makes it easier to read.
  "dist:images",
  // This has to be on it's own, and it has to be one of the last things we do
  // because otherwise we won't catch all of the files in the revisioning
  // process.
  gulp.parallel("dist:manifest", "dist:admin:manifest"),
  // Finally, once we've done everything else, we'll compress everything that
  // we've gotten.
  gulp.parallel("dist:compress", "dist:admin:compress"),
));


gulp.task("watch", gulp.series(
  // We need to build our static files at least once to start.
  "dist",

  // Finally we can start our watch task, which will watch our static files, and then
  // kick off a new dist task whenever it finds changes.
  () => {
    let watchPaths = [
      "warehouse/static/**/*",
      "!warehouse/static/dist",
      "warehouse/admin/static/**/*",
      "!warehouse/admin/static/dist/**/*",
    ];

    gulp.watch(watchPaths, debounce(gulp.series("dist"), 200));
  },
));


gulp.task("default", gulp.series("dist"));