Add helper for copying files and dirs

texastribune · Dec 11, 2020 · fbbe36f · fbbe36f
1 parent 17b8299
commit fbbe36f
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 2 deletions.
diff --git a/examples/index.js b/examples/index.js
@@ -1,10 +1,11 @@
-const { styles, icons, amp } = require('../lib');
-const { AMP_MAP, CSS_MAP, MANIFEST_FILE, SVG_MAP } = require('./paths');
+const { styles, icons, amp, copy } = require('../lib');
+const { AMP_MAP, CSS_MAP, MANIFEST_FILE, SVG_MAP, COPY_MAP } = require('./paths');
 
 async function build() {
   await styles(CSS_MAP, MANIFEST_FILE);
   await icons(SVG_MAP);
   await amp(AMP_MAP);
+  await copy(COPY_MAP);
 }
 
 build().catch(err => {

diff --git a/examples/paths.js b/examples/paths.js
@@ -29,11 +29,23 @@ const SVG_MAP = [
   },
 ];
 
+const COPY_MAP = [
+  {
+    in: inputPath('bug.svg'),
+    out: outputPath('copied-file/bug.svg'),
+  },
+  {
+    in: inputPath('icons'),
+    out: outputPath('copied-dir/icons'),
+  },
+];
+
 const MANIFEST_FILE = outputPath('styles.json');
 
 module.exports = {
   AMP_MAP,
   CSS_MAP,
   SVG_MAP,
   MANIFEST_FILE,
+  COPY_MAP,
 };
diff --git a/lib/constants.js b/lib/constants.js
@@ -1,6 +1,7 @@
 const SCSS_SUCCESS = 'Compiled SCSS';
 const SVG_SUCCESS = 'Built sprite';
 const AMP_SUCCESS = 'Built AMP stylesheet';
+const COPY_SUCCESS = 'Copied assets';
 const AMP_BOILERPLATE = `<!doctype html>
 <html amp lang="en">
   <head>
@@ -19,6 +20,7 @@ const AMP_BOILERPLATE = `<!doctype html>
 module.exports = {
   AMP_BOILERPLATE,
   AMP_SUCCESS,
+  COPY_SUCCESS,
   SCSS_SUCCESS,
   SVG_SUCCESS,
 };
diff --git a/lib/copy.js b/lib/copy.js
@@ -0,0 +1,34 @@
+// utility packages
+const fs = require('fs-extra');
+const ora = require('ora');
+
+// internal
+const { COPY_SUCCESS } = require('./constants');
+
+const spinner = ora();
+
+const copyDirs = async dirMap => {
+  try {
+    await fs.copy(dirMap.in, dirMap.out, { preserveTimestamps: true });
+  } catch (err) {
+    spinner.warn(
+      'Copying assets: Note that if input is a file, output cannot be a directory.'
+    );
+    throw err
+  }
+  return COPY_SUCCESS;
+};
+
+module.exports = async dirs => {
+  spinner.start('Copying assets');
+
+  return Promise.all(dirs.map(dirMap => copyDirs(dirMap)))
+    .then(resp => {
+      spinner.succeed();
+      return resp;
+    })
+    .catch(error => {
+      spinner.fail();
+      throw new Error(error.message);
+    });
+};
diff --git a/lib/index.js b/lib/index.js
@@ -2,10 +2,12 @@ const styles = require('./styles.js');
 const icons = require('./icons.js');
 const utils = require('./utils.js');
 const amp = require('./amp.js');
+const copy = require('./copy.js');
 
 module.exports = {
   styles,
   icons,
   utils,
   amp,
+  copy
 };
diff --git a/tests/copy.test.js b/tests/copy.test.js
@@ -0,0 +1,8 @@
+const { copy } = require('../lib');
+const { COPY_MAP } = require('../examples/paths');
+const { COPY_SUCCESS } = require('../lib/constants');
+
+it('Copies directories or files', async () => {
+  const data = await copy(COPY_MAP);
+  expect(data).toStrictEqual([COPY_SUCCESS, COPY_SUCCESS]);
+});