colleqtor - npm Package Compare versions

Comparing version 1.1.0 to 2.0.0

colleqtor.js

@@ -1,48 +0,100 @@
-// deps ========================================================================
+const { version } = require('./package.json');
 const fs = require('fs');
-const zaq = require('zaq');
+const zaq = require('zaq').as('colleqtor@' + version);
 const path = require('path');
-const _ = require('underscore');
 const jawn = require('node-jawn');
 
-let Colleqtor = { version: '1.1.0' };
+function checkOptions (methodName = '?', options) {
+  if (typeof options !== 'object') {
+    throw new TypeError(`
+        API changed in V2.0:
+        colleqtor.${methodName} now requires an options *object* instead of individual string/bool arguments:
+        { extension: string?, stripDirPath: bool?, recursive: bool? }
+    `);
+  }
+}
 
-Colleqtor.listFiles = (dir, ext = null, strip = false) => {
-  let all = _.map(fs.readdirSync(dir), (item) => (strip ? '' : dir + '/') + item);
-  return !ext ? all : _.filter(all, (item) => jawn.getFileExtension(item) === ext.toLowerCase());
+function listFiles (dir, options = {}) {
+  checkOptions('listFiles', options);
+
+  const {
+    extension = null,
+    stripDirPath = null,
+    recursive = null
+  } = options;
+
+  const cleanName = p => stripDirPath ? p : path.join(dir, p);
+  const dirContents = fs.readdirSync(dir, { withFileTypes: true });
+  const fileNames = dirContents.reduce(function (output, dirItem) {
+    if (dirItem.isFile())
+      return [
+        ...output,
+        cleanName(dirItem.name)
+      ];
+    else if (dirItem.isDirectory() && recursive)
+      return [
+        ...output,
+        ...listFiles(path.join(dir, dirItem.name), { extension, stripDirPath, recursive })
+      ];
+    else return output;
+  }, []);
+
+  const resultFilter = item => !extension
+    || (jawn.getFileExtension(item) === extension.toLowerCase());
+
+  return fileNames.filter(resultFilter);
 };
 
-Colleqtor.gatherFileNames = (dir, ext = null, strip = false) => {
-  return _.map(Colleqtor.listFiles(dir, ext, strip), jawn.removeFileExtension);
+function gatherFileNames (dir, options = {}) {
+  const { extension = null, stripDirPath = false } = options;
+
+  return listFiles(dir, options)
+    .map(p => jawn.removeFileExtension(p));
 };
 
-Colleqtor.getFileContent = (list, objMode = true, useBasename = true, baseDir = '') => {
-  let contents = (objMode ? {} : []);
-  _.each(list, (path) => {
-    let content = fs.readFileSync(baseDir + path, 'utf-8');
-    let basename = useBasename ? jawn.removeFileExtension(jawn.filenameFromPath(path)) : path;
-    if (objMode) contents[basename] = content;
-    else contents.push(content);
-  });
-  return contents;
+function getFileContent (filePathList, objMode = true, stripFileExtensions = true, baseDir = null) {
+  return filePathList.reduce((output, filePath) => {
+    const fullPath = path.resolve(baseDir || '', filePath);
+    const shortPath = path.relative('.', fullPath);
+    const content = fs.readFileSync(fullPath, 'utf-8');
+    const pathKey = stripFileExtensions ? jawn.removeFileExtension(shortPath) : shortPath;
+
+    return objMode
+      ? { ...output, [pathKey]: content }
+      : [ ...output, content ];
+  }, objMode ? {} : []);
 };
 
-Colleqtor.collect = (dir, extension, objMode) => {
-  return Colleqtor.getFileContent(Colleqtor.listFiles(dir, extension), objMode);
+function collect (dir, extension, objMode) {
+  return getFileContent(listFiles(dir, { extension: extension }), objMode);
 };
 
-Colleqtor.require = (dir, ext = 'js') => {
-  let keys = Colleqtor.gatherFileNames(dir, ext, true);
-  let output = {};
-  _.each(keys, (key) => {
-    let uri = path.join(dir, key + '.' + ext);
+function requireAll (dir, extension = 'js') {
+  const fileNames = gatherFileNames(dir, { extension, stripDirPath: true });
+
+  return fileNames.reduce((output, fileName) => {
+    const uri = path.join(dir, `${fileName}.${extension}`);
+
     try {
-      output[key] = require(uri);
+      output[fileName] = require(uri);
     } catch (e) {
-      zaq.err(`Error requiring [${ext}] file: ${uri}`, e);
+      zaq.err(e);
+      throw Error(`colleqtor: couldn\'t require [${extension}] file: ${uri}`);
     }
-  });
-  return output;
+
+    return output;
+  }, {});
 };
 
-module.exports = Colleqtor;
+module.exports = {
+    version,
+    listFiles,
+    gatherFileNames,
+    getFileContent,
+    collect,
+    requireAll,
+    require: (...args) => {
+      zaq.warn('colleqtor.require() is deprecated and will be removed in future versions of colleqtor. Please use colleqtor.requireAll() instead.')
+      return requireAll(...args);
+    }
+};

package.json

 {
   "name": "colleqtor",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Seize the directory.",
@@ -31,4 +31,3 @@ "main": "colleqtor.js",
     "node-jawn": "^1.2.1",
-    "underscore": "^1.8.3",
-    "zaq": "^1.1.4"
+    "zaq": "^2.1.3"
   },
@@ -35,0 +34,0 @@ "devDependencies": {

test.js

@@ -7,14 +7,9 @@ const zaq = require('zaq');
 
-zaq.info('LIST FILES: Only dir provided:', colleqtor.listFiles(testDir));
-
-zaq.info('LIST FILES: Dir and extension (log) provided:', colleqtor.listFiles(testDir, 'log'));
-zaq.info('LIST FILES: Dir and extension (txt) provided:', colleqtor.listFiles(testDir, 'txt'));
-zaq.info('LIST FILES: Dir and extension (xml) provided:', colleqtor.listFiles(testDir, 'xml'));
-
-zaq.info('LIST FILES: Dir and extension (txt) provided, stripping directory:', colleqtor.listFiles(testDir, 'txt', true));
-
-zaq.info('GATHER FILENAMES: Only dir provided:', colleqtor.gatherFileNames(testDir));
-
-let reqd = colleqtor.require(testDir + '/requirable');
-zaq.info('Require\'m', reqd);
-zaq.info('is gamma a thing?', reqd.gamma);
+zaq.ok('LIST FILES: Only dir provided:', colleqtor.listFiles(testDir));
+zaq.ok('lsitFiles: Dir and extension (log) provided:', colleqtor.listFiles(testDir, { extension: 'log' }));
+zaq.ok('listFiles: Dir and extension (txt) provided:', colleqtor.listFiles(testDir, { extension: 'txt' }));
+zaq.ok('listFiles: Dir and extension (xml) provided:', colleqtor.listFiles(testDir, { extension: 'xml' }));
+zaq.ok('listFiles: Dir and extension (txt) provided, stripping directory:', colleqtor.listFiles(testDir, { extension: 'txt', stripDirPath: true }));
+zaq.ok('gatherFileNames: Only dir provided:', colleqtor.gatherFileNames(testDir));
+zaq.ok('.requireAll(testDir + \'/requireable\')', colleqtor.requireAll(testDir + '/requirable'));
+zaq.ok('getFileContent(listFiles(testDir, \'txt\'))', colleqtor.getFileContent(colleqtor.listFiles(testDir, { extension: 'txt' })));

No alert changes

Improved metrics

Total package byte prevSize

13489

increased by12.56%

Dependency count

2

decreased by-33.33%

Lines of code

103

increased by68.85%

Worsened metrics

Number of package files

16

decreased by-5.88%

Dependency changes

• + Addedzaq@2.2.0(transitive)

• - Removedunderscore@^1.8.3

• - Removedzaq@1.4.2(transitive)

• Updatedzaq@^2.1.3