feat!: esm, async/await, updates and add linting

Author: rvagg

README.md

@@ -6,17 +6,17 @@ Deserialise an file/directory tree into an object. Available in npm as *readfile
 
 Particularly useful for testing where you need to do a `deepStrictEqual()` on a simple tree of files. **See [mkfiletree](https://github.com/rvagg/mkfiletree) for file tree serialisation.**
 
-### require('readfiletree')(directory[, callback])
+### async readfiletree(directory)
 
-Read the directory and the files it contains, recursively, and return an object representing the directory structure with nodes containing the utf8 string contents of each file. The arguments of the optional callback are: `(err, object)`. If no callback is supplied, a `Promise` is returned which can be used to `await` the serialised `object`.
+Read the directory and the files it contains, recursively, and return an object representing the directory structure with nodes containing the utf8 string contents of each file.
 
 Using both *mkfiletree* and *readfiletree* we can do the following:
 
 ```js
-const mkfiletree = require('mkfiletree')
-const readfiletree = require('readfiletree')
+import * as mkfiletree from 'mkfiletree'
+import { readfiletree } from 'readfiletree'
 
-let dir = await mkfiletree.makeTemp('testfiles',
+const dir = await mkfiletree.makeTemp('testfiles',
   {
     'adir': {
       'one.txt': '1\n2\n3\n',
@@ -28,7 +28,7 @@ let dir = await mkfiletree.makeTemp('testfiles',
     'afile.txt': 'file contents'
   })
 
-let obj = await readfiletree(dir)
+const obj = await readfiletree(dir)
 console.log(obj)
 ```
 
@@ -67,14 +67,6 @@ And the output of the program should be the same as the input to *mkfiletree*:
 }
 ```
 
-## Contributing
-
-Tests can be run with `npm test`. I'm more than happy to receive contributions so fork away!
-
-## Synchronous version
-
-No, there is no sync version, do it async, it's good for your health and contains additional vitamin C, B1, B2 and folate.
-
 *Copyright (c) 2012 [Rod Vagg](https://github.com/rvagg)
 
 Made available under the MIT licence:

package.json

@@ -1,27 +1,30 @@
 {
-    "author": "Rod Vagg @rvagg <rod@vagg.org>",
-    "name": "readfiletree",
-    "description": "Serialize a tree of files and directories into object form",
-    "keywords": [
-        "temp",
-        "tree",
-        "test",
-        "serialize",
-        "deserialize"
-    ],
-    "version": "1.1.1",
-    "main": "readfiletree.js",
-    "scripts": {
-        "test": "node tests.js"
-    },
-    "dependencies": {
-        "after": "~0.8.2"
-    },
-    "devDependencies": {
-        "mkfiletree": "~2.0.0"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/rvagg/node-readfiletree.git"
-    }
+  "author": "Rod Vagg @rvagg <rod@vagg.org>",
+  "name": "readfiletree",
+  "description": "Serialize a tree of files and directories into object form",
+  "keywords": [
+    "temp",
+    "tree",
+    "test",
+    "serialize",
+    "deserialize"
+  ],
+  "version": "1.1.1",
+  "main": "readfiletree.js",
+  "type": "module",
+  "license": "MIT",
+  "scripts": {
+    "lint": "standard",
+    "test": "npm run lint && node tests.js",
+    "test:ci": "npm run lint && node tests.js",
+    "build": "true"
+  },
+  "devDependencies": {
+    "mkfiletree": "^3.0.0",
+    "standard": "^17.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rvagg/node-readfiletree.git"
+  }
 }

readfiletree.js

@@ -1,65 +1,21 @@
 /* Copyright (c) 2012 Rod Vagg <@rvagg> */
-const fs = require('fs')
-const path = require('path')
-const after = require('after')
+import fs from 'fs/promises'
+import path from 'path'
 
-function readfiletree (dir, obj, callback) {
-  if (typeof obj === 'function') {
-    callback = obj
+export async function readfiletree (dir, obj) {
+  if (obj == null) {
     obj = {}
   }
-
-  fs.readdir(dir, afterReaddir)
-
-  function afterReaddir (err, list) {
-    if (err) {
-      return callback(err)
-    }
-
-    const done = after(list.length, (err) => {
-      if (err) {
-        return callback(err)
-      }
-      callback(null, obj)
-    })
-    list.forEach((f) => eachFile(f, done))
-  }
-
-  function eachFile (f, callback) {
-    var p = path.join(dir, f)
-    fs.stat(p, (err, stat) => {
-      if (err) {
-        return callback(err)
-      }
-      if (stat.isDirectory()) {
-        obj[f] = {}
-        return readfiletree(p, obj[f], callback)
-      } else if (stat.isFile()) {
-        fs.readFile(p, 'utf8', (err, data) => {
-          if (err) {
-            return callback(err)
-          }
-          obj[f] = data
-          callback()
-        })
-      }
-    })
-  }
-}
-
-module.exports = function maybePromiseWrap (dir, callback) {
-  if (typeof callback === 'function') {
-    return readfiletree(dir, callback)
-  }
-
-  return new Promise((resolve, reject) => {
-    callback = (err, data) => {
-      if (err) {
-        return reject(err)
-      }
-      resolve(data)
+  const list = await fs.readdir(dir)
+  await Promise.all(list.map(async (f) => {
+    const p = path.join(dir, f)
+    const stat = await fs.stat(p)
+    if (stat.isDirectory()) {
+      obj[f] = {}
+      await readfiletree(p, obj[f])
+    } else if (stat.isFile()) {
+      obj[f] = await fs.readFile(p, 'utf8')
     }
-
-    readfiletree(dir, callback)
-  })
+  }))
+  return obj
 }

tests.js

@@ -1,42 +1,29 @@
-const assert = require('assert')
-const mkfiletree = require('mkfiletree')
-const readfiletree = require('./readfiletree')
+import assert from 'assert'
+import * as mkfiletree from 'mkfiletree'
+import { readfiletree } from './readfiletree.js'
+
 function mkfixture () { // make a new copy each time, ensure no edits at any depth
   return {
     'foo.txt': 'FOO!',
-    'bar': {
-      'bang': {
+    bar: {
+      bang: {
         '1.dat': '1\n',
         '2.dat': '2\n\n',
         '3.dat': '3\n\n\n'
       },
-      'BAM': 'WOO HOO!!!\n'
+      BAM: 'WOO HOO!!!\n'
     }
   }
 }
 
-async function test (asPromises) {
+async function test () {
   const dir = await mkfiletree.makeTemp('readfiletree_test', mkfixture())
   assert(dir)
-
-  if (!asPromises) {
-    readfiletree(dir, (err, obj) => {
-      assert(!err)
-      verify(obj)
-    })
-  } else {
-    readfiletree(dir)
-      .then(verify)
-  }
-
-  function verify (obj) {
-    assert.deepStrictEqual(obj, mkfixture())
-  }
+  const obj = await readfiletree(dir)
+  assert.deepStrictEqual(obj, mkfixture())
 }
 
-test(false).then(() => {
-  return test(true)
-}).catch((err) => {
+test().catch((err) => {
   console.error(err)
   process.exit(1)
 })