fs: move fs/promises to fs.promises

PR-URL: #20504 Refs: nodejs/TSC#389 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>

Author: cjihrig

benchmark/fs/bench-stat-promise.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const common = require('../common');
-const fsPromises = require('fs/promises');
+const fsPromises = require('fs').promises;
 
 const bench = common.createBenchmark(main, {
  n: [20e4],

doc/api/fs.md

@@ -3382,9 +3382,9 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
 
 > Stability: 1 - Experimental
 
-The `fs/promises` API provides an alternative set of asynchronous file system
+The `fs.promises` API provides an alternative set of asynchronous file system
 methods that return `Promise` objects rather than using callbacks. The
-API is accessible via `require('fs/promises')`.
+API is accessible via `require('fs').promises`.
 
 ### class: FileHandle
 <!-- YAML

lib/fs.js

@@ -45,7 +45,8 @@ const { Readable, Writable } = require('stream');
 const EventEmitter = require('events');
 const { FSReqWrap, statValues, kFsStatsFieldsLength } = binding;
 const { FSEvent } = process.binding('fs_event_wrap');
-const internalFS = require('internal/fs');
+const promises = require('internal/fs/promises');
+const internalFS = require('internal/fs/utils');
 const { getPathFromURL } = require('internal/url');
 const internalUtil = require('internal/util');
 const {
@@ -72,6 +73,21 @@ const {
  CHAR_BACKWARD_SLASH,
 } = require('internal/constants');
 
+let warn = true;
+
+Object.defineProperty(fs, 'promises', {
+ configurable: true,
+ enumerable: true,
+ get() {
+ if (warn) {
+ warn = false;
+ process.emitWarning('The fs.promises API is experimental',
+ 'ExperimentalWarning');
+ }
+ return promises;
+ }
+});
+
 Object.defineProperty(exports, 'constants', {
  configurable: false,
  enumerable: true,

lib/fs/promises.js renamed to lib/internal/fs/promises.js

@@ -1,8 +1,5 @@
 'use strict';
 
-process.emitWarning('The fs/promises API is experimental',
- 'ExperimentalWarning');
-
 const {
  F_OK,
  O_SYMLINK,
@@ -37,7 +34,7 @@ const {
  validateOffsetLengthWrite,
  validatePath,
  validateUint32
-} = require('internal/fs');
+} = require('internal/fs/utils');
 const pathModule = require('path');
 
 const kHandle = Symbol('handle');

lib/internal/fs.js renamed to lib/internal/fs/utils.js

@@ -28,7 +28,7 @@ const { getURLFromFilePath } = require('internal/url');
 const vm = require('vm');
 const assert = require('assert').ok;
 const fs = require('fs');
-const internalFS = require('internal/fs');
+const internalFS = require('internal/fs/utils');
 const path = require('path');
 const {
  internalModuleReadJSON,

lib/internal/modules/cjs/loader.js

@@ -2,7 +2,7 @@
 
 const { URL } = require('url');
 const CJSmodule = require('internal/modules/cjs/loader');
-const internalFS = require('internal/fs');
+const internalFS = require('internal/fs/utils');
 const { NativeModule, internalBinding } = require('internal/bootstrap/loaders');
 const { extname } = require('path');
 const { realpathSync } = require('fs');

lib/internal/modules/esm/default_resolve.js

@@ -158,7 +158,7 @@ function createWritableStdioStream(fd) {
  break;
 
  case 'FILE':
- var fs = require('internal/fs');
+ var fs = require('internal/fs/utils');
  stream = new fs.SyncWriteStream(fd, { autoClose: false });
  stream._type = 'fs';
  break;

lib/internal/process/stdio.js

@@ -39,7 +39,6 @@
  'lib/domain.js',
  'lib/events.js',
  'lib/fs.js',
- 'lib/fs/promises.js',
  'lib/http.js',
  'lib/http2.js',
  'lib/_http_agent.js',
@@ -103,7 +102,8 @@
  'lib/internal/errors.js',
  'lib/internal/fixed_queue.js',
  'lib/internal/freelist.js',
- 'lib/internal/fs.js',
+ 'lib/internal/fs/promises.js',
+ 'lib/internal/fs/utils.js',
  'lib/internal/http.js',
  'lib/internal/inspector_async_hook.js',
  'lib/internal/linkedlist.js',

node.gyp

@@ -5,7 +5,7 @@ const common = require('../common');
 const assert = require('assert');
 const path = require('path');
 const fs = process.binding('fs');
-const { stringToFlags } = require('internal/fs');
+const { stringToFlags } = require('internal/fs/utils');
 
 // Verifies that the FileHandle object is garbage collected and that a
 // warning is emitted if it is not closed.