fs: default open/openSync flags argument to 'r' #23767

bnoordhuis · 2018-10-19T21:07:35Z

Make fs.open() and fs.openSync() more economic to use by making the
flags argument optional. You can now write:

fs.open(file, cb)

Instead of the more verbose:

fs.open(file, 'r', cb)

This idiom is already supported by functions like fs.readFile().

nodejs-github-bot · 2018-10-19T21:07:36Z

@bnoordhuis build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1304/pipeline

jasnell

LGTM. What would the semver-iness of this be? minor?

vsemozhetbyt · 2018-10-19T22:41:42Z

doc/api/fs.md

@@ -2318,7 +2318,8 @@ changes:
 -->

 * `path` {string|Buffer|URL}
-* `flags` {string|number} See [support of file system `flags`][].
+* `flags` {string|number} **Default:** `'r'`


Nits:

Missing period.

One unneeded space in the next line indent alignment,

It seems our common style is to place **Default:** notes at the end of a parameter description:

* `flags` {string|number} See [support of file system `flags`][]. **Default:** `'r'`.

vsemozhetbyt · 2018-10-19T22:43:33Z

doc/api/fs.md

@@ -2351,7 +2352,8 @@ changes:
 -->

 * `path` {string|Buffer|URL}
-* `flags` {string|number} See [support of file system `flags`][].
+* `flags` {string|number} **Default:** `'r'`


Ditto:

* `flags` {string|number} See [support of file system `flags`][]. **Default:** `'r'`.

vsemozhetbyt · 2018-10-19T22:57:38Z

Should the fsPromises.open(path, flags[, mode]) be unified?

lpinca · 2018-10-21T06:20:00Z

doc/api/fs.md

@@ -2304,7 +2304,7 @@ this API: [`fs.mkdtemp()`][].
 The optional `options` argument can be a string specifying an encoding, or an
 object with an `encoding` property specifying the character encoding to use.

-## fs.open(path, flags[, mode], callback)
+## fs.open(path[, flags, mode], callback)


Suggested change

## fs.open(path[, flags, mode], callback)

## fs.open(path[, flags[, mode]], callback)

Is this a style we use elsewhere? It looks unfamiliar to me.

Yes, see https://nodejs.org/api/buffer.html#buffer_buf_fill_value_offset_end_encoding for example.

The [, flags[, mode]], is the right doc convention, and looks to agree with how it is now implemented.

Make fs.open() and fs.openSync() more economic to use by making the flags argument optional. You can now write: fs.open(file, cb) Instead of the more verbose: fs.open(file, 'r', cb) This idiom is already supported by functions like fs.readFile().

bnoordhuis · 2018-10-23T21:46:06Z

Updated based on feedback:

doc nits
updated fs.promises.open()

refack · 2018-10-23T21:50:41Z

Is this semver minor or major? i.e. could any existing code break?

CI: ~~https://ci.nodejs.org/job/node-test-pull-request/18088/~~
Resume: https://ci.nodejs.org/job/node-test-pull-request/18111/

bnoordhuis · 2018-10-23T21:56:48Z

What would the semver-iness of this be? minor?

Yes, minor.

bnoordhuis · 2018-10-24T14:36:29Z

Test failure is #23807 and unrelated (wasn't fixed yet when the CI was started.)

Trott · 2018-10-26T03:04:19Z

Last CI was green. Any reason this shouldn't land?

lpinca · 2018-10-26T05:35:08Z

I think this can land, my nit can be addressed in another PR if wanted.

Trott · 2018-10-26T05:57:26Z

Applied the nit.

CI: https://ci.nodejs.org/job/node-test-pull-request/18165/

Make fs.open() and fs.openSync() more economic to use by making the flags argument optional. You can now write: fs.open(file, cb) Instead of the more verbose: fs.open(file, 'r', cb) This idiom is already supported by functions like fs.readFile(). PR-URL: nodejs#23767 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

Trott · 2018-10-26T13:38:16Z

Landed in 482b56a

Make fs.open() and fs.openSync() more economic to use by making the flags argument optional. You can now write: fs.open(file, cb) Instead of the more verbose: fs.open(file, 'r', cb) This idiom is already supported by functions like fs.readFile(). PR-URL: #23767 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

Was missed on original PR. Ref: nodejs#23767

Was missed on original PR. Ref: nodejs#23767 PR-URL: nodejs#24240 Refs: nodejs#23767 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Was missed on original PR. Ref: #23767 PR-URL: #24240 Refs: #23767 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Was missed on original PR. Ref: nodejs#23767 PR-URL: nodejs#24240 Refs: nodejs#23767 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Was missed on original PR. Ref: #23767 PR-URL: #24240 Refs: #23767 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Make fs.open() and fs.openSync() more economic to use by making the flags argument optional. You can now write: fs.open(file, cb) Instead of the more verbose: fs.open(file, 'r', cb) This idiom is already supported by functions like fs.readFile(). PR-URL: #23767 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>

nodejs-github-bot added the fs Issues and PRs related to the fs subsystem / file system. label Oct 19, 2018

jasnell approved these changes Oct 19, 2018

View reviewed changes

vsemozhetbyt reviewed Oct 19, 2018

View reviewed changes

lpinca reviewed Oct 21, 2018

View reviewed changes

lpinca approved these changes Oct 21, 2018

View reviewed changes

cjihrig approved these changes Oct 22, 2018

View reviewed changes

bnoordhuis added 3 commits October 23, 2018 22:26

squash! doc nits

4686ff9

squash! update fs.promises.open()

43e6f91

bnoordhuis force-pushed the fs-open-default-r branch from 38bfd21 to 43e6f91 Compare October 23, 2018 21:45

refack added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 23, 2018

refack approved these changes Oct 23, 2018

View reviewed changes

refack added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 23, 2018

trivikr approved these changes Oct 24, 2018

View reviewed changes

lpinca mentioned this pull request Oct 24, 2018

src: prefer param function check over args length #23835

Closed

2 tasks

squash! lpinca nit

079ed33

Trott closed this Oct 26, 2018

targos mentioned this pull request Oct 27, 2018

Release proposal: v11.1.0 #23922

Merged

rvagg mentioned this pull request Nov 8, 2018

doc: update fs.open() changes record for optional 'flags' #24240

Closed

rvagg added a commit to rvagg/io.js that referenced this pull request Nov 12, 2018

doc: update fs.open() changes record for optional 'flags'

4c9089d

Was missed on original PR. Ref: nodejs#23767

BethGriggs mentioned this pull request May 1, 2019

v10.16.0 proposal #27514

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fs: default open/openSync flags argument to 'r' #23767

fs: default open/openSync flags argument to 'r' #23767

bnoordhuis commented Oct 19, 2018

nodejs-github-bot commented Oct 19, 2018

jasnell left a comment

vsemozhetbyt Oct 19, 2018

vsemozhetbyt Oct 19, 2018

vsemozhetbyt commented Oct 19, 2018

lpinca Oct 21, 2018

bnoordhuis Oct 23, 2018

lpinca Oct 24, 2018

sam-github Oct 24, 2018

bnoordhuis commented Oct 23, 2018

refack commented Oct 23, 2018 •

edited

Loading

bnoordhuis commented Oct 23, 2018

bnoordhuis commented Oct 24, 2018

Trott commented Oct 26, 2018

lpinca commented Oct 26, 2018

Trott commented Oct 26, 2018

Trott commented Oct 26, 2018

	## fs.open(path[, flags, mode], callback)
	## fs.open(path[, flags[, mode]], callback)

fs: default open/openSync flags argument to 'r' #23767

fs: default open/openSync flags argument to 'r' #23767

Conversation

bnoordhuis commented Oct 19, 2018

nodejs-github-bot commented Oct 19, 2018

jasnell left a comment

Choose a reason for hiding this comment

vsemozhetbyt Oct 19, 2018

Choose a reason for hiding this comment

vsemozhetbyt Oct 19, 2018

Choose a reason for hiding this comment

vsemozhetbyt commented Oct 19, 2018

lpinca Oct 21, 2018

Choose a reason for hiding this comment

bnoordhuis Oct 23, 2018

Choose a reason for hiding this comment

lpinca Oct 24, 2018

Choose a reason for hiding this comment

sam-github Oct 24, 2018

Choose a reason for hiding this comment

bnoordhuis commented Oct 23, 2018

refack commented Oct 23, 2018 • edited Loading

bnoordhuis commented Oct 23, 2018

bnoordhuis commented Oct 24, 2018

Trott commented Oct 26, 2018

lpinca commented Oct 26, 2018

Trott commented Oct 26, 2018

Trott commented Oct 26, 2018

refack commented Oct 23, 2018 •

edited

Loading