Fix fs.promises ExperimentalWarning on Node 10.1.0 (#578)

Author: bajtos

lib/__tests__/promise.test.js

@@ -2,6 +2,8 @@
 
 /* eslint-env mocha */
 
+const assert = require('assert')
+const fs = require('fs')
 const fse = require('..')
 
 const methods = [
@@ -22,4 +24,12 @@ describe('promise support', () => {
       fse[method]().catch(() => done())
     })
   })
+
+  if (Object.getOwnPropertyDescriptor(fs, 'promises')) {
+    it('provides fse.promises API', () => {
+      const desc = Object.getOwnPropertyDescriptor(fse, 'promises')
+      assert.ok(desc)
+      assert.equal(typeof desc.get, 'function')
+    })
+  }
 })

lib/fs/index.js

@@ -46,6 +46,11 @@ const api = [
 
 // Export all keys:
 Object.keys(fs).forEach(key => {
+  if (key === 'promises') {
+    // fs.promises is a getter property that triggers ExperimentalWarning
+    // Don't re-export it here, the getter is defined in "lib/index.js"
+    return
+  }
   exports[key] = fs[key]
 })
 

lib/index.js

@@ -17,3 +17,12 @@ module.exports = Object.assign(
   require('./path-exists'),
   require('./remove')
 )
+
+// Export fs.promises as a getter property so that we don't trigger
+// ExperimentalWarning before fs.promises is actually accessed.
+const fs = require('fs')
+if (Object.getOwnPropertyDescriptor(fs, 'promises')) {
+  Object.defineProperty(module.exports, 'promises', {
+    get () { return fs.promises }
+  })
+}