Return paths of created files to the callback on success.

Signed-off-by: Yoshua Wuyts <i@yoshuawuyts.com>

Closes #6

README.md

@@ -22,8 +22,9 @@ const vars = { foo: 'bar' }
 const inDir = path.join(process.cwd(), 'templates')
 const outDir = path.join(process.cwd(), 'dist')
 
-copy(inDir, outDir, vars, (err) => {
+copy(inDir, outDir, vars, (err, createdFiles) => {
   if (err) throw err
+  createdFiles.forEach(filePath => console.log(`Created ${filePath}`))
   console.log('done!')
 })
 ```
@@ -37,7 +38,8 @@ with variables. Takes the following arguments:
   with a `_`. Files are populated with variables using the `{{varName}}` syntax.
 - __targetDir__: the output directory
 - __vars__: An object with variables that are injected into the template files.
-- __cb(err)__: A callback that is called on completion.
+- __cb(err, createdFiles)__: A callback that is called on completion, with
+paths to created files if there were no errors.
 
 ## See Also
 - [maxstache-stream](https://github.com/yoshuawuyts/maxstache-stream)

index.js

@@ -31,16 +31,21 @@ function copyTemplateDir (srcDir, outDir, vars, cb) {
 
     const rs = readdirp({ root: srcDir })
     const streams = []
+    const createdFiles = []
 
     // create a new stream for every file emitted
     rs.on('data', function (file) {
+      createdFiles.push(path.join(outDir, removeUnderscore(file.path)))
       streams.push(writeFile(outDir, vars, file))
     })
 
     // delegate errors & close streams
     eos(rs, function (err) {
       if (err) return cb(err)
-      parallel(streams, cb)
+      parallel(streams, function (err) {
+        if (err) return cb(err)
+        cb(null, createdFiles)
+      })
     })
   })
 }

test/index.js

@@ -16,25 +16,34 @@ test('should assert input values', function (t) {
 })
 
 test('should write a bunch of files', function (t) {
-  t.plan(11)
+  t.plan(21)
+
+  function checkCreatedFileNames (names, check) {
+    t.notEqual(names.indexOf('.a'), -1, '.a ' + check)
+    t.notEqual(names.indexOf('c'), -1, 'c ' + check)
+    t.notEqual(names.indexOf('1.txt'), -1, '1.txt ' + check)
+    t.notEqual(names.indexOf('2.txt'), -1, '2.txt ' + check)
+    t.notEqual(names.indexOf('3.txt'), -1, '3.txt ' + check)
+    t.notEqual(names.indexOf('foo' + path.sep + '.b'), -1, 'foo/.b ' + check)
+    t.notEqual(names.indexOf('foo' + path.sep + 'd'), -1, 'foo/d ' + check)
+    t.notEqual(names.indexOf('foo' + path.sep + '4.txt'), -1, 'foo/4.txt ' + check)
+  }
 
   const inDir = path.join(__dirname, 'fixtures')
   const outDir = path.join(__dirname, '../tmp')
-  copy(inDir, outDir, function (err) {
+  copy(inDir, outDir, function (err, createdFiles) {
     t.error(err)
+    t.ok(Array.isArray(createdFiles), 'createdFiles is an array')
+    t.equal(createdFiles.length, 8)
+    checkCreatedFileNames(createdFiles.map(function (filePath) {
+      return path.relative(outDir, filePath)
+    }), 'reported as created')
 
     readdirp({ root: outDir }).pipe(concat({ object: true }, function (arr) {
       t.ok(Array.isArray(arr), 'is array')
 
       const names = arr.map(function (file) { return file.path })
-      t.notEqual(names.indexOf('.a'), -1, '.a exists')
-      t.notEqual(names.indexOf('c'), -1, 'c exists')
-      t.notEqual(names.indexOf('1.txt'), -1, '1.txt exists')
-      t.notEqual(names.indexOf('2.txt'), -1, '2.txt exists')
-      t.notEqual(names.indexOf('3.txt'), -1, '3.txt exists')
-      t.notEqual(names.indexOf('foo' + path.sep + '.b'), -1, 'foo/.b exists')
-      t.notEqual(names.indexOf('foo' + path.sep + 'd'), -1, 'foo/d exists')
-      t.notEqual(names.indexOf('foo' + path.sep + '4.txt'), -1, 'foo/4.txt exists')
+      checkCreatedFileNames(names, 'exists')
 
       rimraf(outDir, function (err) {
         t.error(err)