xocs.test.ts

import { xocs, Thread } from "./dist";

/**
 * @dev Initialize 'xocs' procedure with srcRoot & publicRoot.
 */
xocs.init({
  env: ".env.development", // default is s".env"
  srcRoot: "test/src", // default is "src"
  publicRoot: "test/public", // default is "public"
});

const { srcRoot, publicRoot } = xocs.config;

/**
 * @dev Watch src files to compile, imagemin, copy, etc.
 */
xocs.task("compile", () => {
  // For example, src/index.html => public/pages/index.html
  xocs.watch(srcRoot + "/**/*.@(html|php)", (thread: Thread, path: string) => {
    thread.copy(path, "pages");
  });
  xocs.watch(srcRoot + "/assets/js/**/*.js", (thread: Thread) => {
    thread.babel();
  });
  xocs.watch(srcRoot + "/assets/css/**/*.scss", (thread: Thread) => {
    thread.sass().postcss();
  });
  xocs.watch(
    srcRoot + "/assets/img/**/*.@(jpg|jpeg|png|gif|svg|webp)",
    (thread: Thread) => {
      thread.imagemin();
    }
  );
});

/**
 * @dev Here, FTP_HOST etc. are defined in '.env' file using 'dotenv' module
 * @link https://www.npmjs.com/package/dotenv
 */
xocs.task("preview", () => {
  // Start BrowserSync
  xocs.browser({
    proxy: process.env.PUBLIC_URL,
  });

  // Create FTP connection
  xocs.remote({
    host: process.env.FTP_HOST,
    port: process.env.FTP_PORT,
    user: process.env.FTP_USER,
    password: process.env.FTP_PASS,
    localRoot: process.env.FTP_LOCAL_ROOT,
    remoteRoot: process.env.FTP_REMOTE_ROOT,
  });

  // Upload file to remote host when files in public directory are updated & run BrowserSync
  xocs.watch(
    [publicRoot + "/assets/**/*", publicRoot + "/pages/**/*"],
    (thread: Thread) => {
      thread.upload().reload();
    }
  );
});

/**
 * @dev Execute registered tasks
 */
xocs.run("compile", "preview");