doc: update examples of the final "callback" argument for fs.access() #20460

BeniCheni · 2018-05-01T23:52:47Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Per this following comment (as the origin of the aspiration to help out #17508), I've confirmed with the @ gireeshpunathil, and worked with the suggested content of #17578.

#17578 was never landed but has enough content in for a first timer to pick and progress.

Hope that the attempted fs.access snippets look okay in the PR. Happy to update according to review feedback. Thanks for reviewing in advance.

Trott · 2018-05-02T00:00:37Z

doc/api/fs.md

-argument will be an `Error` object. The following example checks if the file
-`/etc/passwd` can be read and written by the current process.
+argument will be an `Error` object. The following examples check if
+`package.json` exists, and/or if it could be written to.


Nits:

and/or -> and

could be written to -> is writable

Trott · 2018-05-02T00:01:20Z

doc/api/fs.md

+fs.access('./package.json', fs.constants.W_OK, (err) => {
+  console.log(
+    err ?
+      'package.json could not be written to' :


Nit: could not be written to -> is not writable

Trott · 2018-05-02T00:01:38Z

doc/api/fs.md

+
+// Check if package.json file could be read.
+fs.access('./package.json', fs.constants.R_OK, (err) => {
+  console.log(err ? 'package.json could not be read' : 'package.json read');


Nit: could not be read -> is readable

is not readable / is readable?

@vsemozhetbyt Yes, I forgot the not. Should be:

Nit: could not be read -> is not readable

Trott · 2018-05-02T00:01:51Z

doc/api/fs.md

+  console.log(
+    err ?
+      'package.json could not be written to' :
+      'package.json could be written to'


Nit: could be written to -> is writable

Trott · 2018-05-02T00:02:09Z

doc/api/fs.md

+});
+
+// Check if `package.json` exists in the current directory and it could be
+// written to.


Same with the comment: could be written to -> is writable

Trott · 2018-05-02T00:04:36Z

I wonder if the example code can be pared down a bit without losing any information. (I don't know if it can; I'm asking.)

@nodejs/documentation

@nodejs/fs

vsemozhetbyt · 2018-05-02T00:28:06Z

doc/api/fs.md

+  console.log(err ? 'package.json does not exist' : 'package.json exists');
+});
+
+// Check if package.json file could be read.


`package.json` for consistency?

vsemozhetbyt · 2018-05-02T03:33:55Z

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

BeniCheni · 2018-05-02T03:36:46Z

🙏 for 1st round of review @Trott & @vsemozhetbyt. I've read your feedback and updated the content to emphasize contextually more on the suggested "readable" & "writable" keywords in the latest updates. Please review again?

I also saw the "pared down a bit" comment, which I'll look out for any further suggested feedback to account for that potential update. (happy to update it to if any suggest arises on that topic)

vsemozhetbyt · 2018-05-02T03:49:33Z

doc/api/fs.md

+// Check if `package.json` is writable.
+fs.access('./package.json', fs.constants.W_OK, (err) => {
+  console.log(
+    err ?


It seems this can be unwrapped now like in the block above, to spare some lines)

vsemozhetbyt · 2018-05-02T04:10:23Z

@BeniCheni @Trott Minimal changes I could think of (-11 lines without major refactoring):

Code:

const file = 'package.json';

// Check if the file exists in the current directory.
fs.access(file, fs.constants.F_OK, (err) => {
  console.log(`${file} ${err ? 'does not exist' : 'exists'}`);
});

// Check if the file is readable.
fs.access(file, fs.constants.R_OK, (err) => {
  console.log(`${file} ${err ? 'is not readable' : 'is readable'}`);
});

// Check if the file is writable.
fs.access(file, fs.constants.W_OK, (err) => {
  console.log(`${file} ${err ? 'is not writable' : 'is writable'}`);
});

// Check if the file exists in the current directory, and if it is writable.
fs.access(file, fs.constants.F_OK | fs.constants.W_OK, (err) => {
  if (err) {
    console.error(
      `${file} ${err.code === 'ENOENT' ? 'does not exist' : 'is read-only'}`);
  } else {
    console.log(`${file} exists, and it is writable`);
  }
});

vsemozhetbyt · 2018-05-02T04:33:31Z

(And it seems // If there is an error, print the error in console and exit. can be deleted as self-evident; the proposal is updated.)

BeniCheni · 2018-05-02T04:51:18Z

@vsemozhetbyt , nice refactoring suggestion. I worked with the suggested code to update the PR, as well as removed the not so useful // if there is an error, comment. This draft should look better?

vsemozhetbyt · 2018-05-02T10:13:38Z

doc/api/fs.md

+const file = 'package.json';
+
+// Check if the file exists in the current directory.
+fs.access('./package.json', fs.constants.F_OK, (err) => {


We can also replace './package.json' with just file here and in the next calls)

…js examples for fs.access()

BeniCheni · 2018-05-02T18:16:04Z

Sounds good, @vsemozhetbyt. Updated the ./package.json to just file variable in relevant places. 👁 the PR again?

vsemozhetbyt · 2018-05-03T22:55:32Z

@Trott Can we land it in this variant?

Trott · 2018-05-03T23:51:06Z

@Trott Can we land it in this variant?

@vsemozhetbyt I have no objections.

vsemozhetbyt · 2018-05-04T00:09:15Z

(Missed CI-lite link: https://ci.nodejs.org/job/node-test-pull-request-lite/650/)

PR-URL: #20460 Fixes: #17508 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

vsemozhetbyt · 2018-05-04T00:16:12Z

Landed in b4ca3a4
Thank you!

PR-URL: #20460 Fixes: #17508 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels May 1, 2018

Trott reviewed May 2, 2018

View reviewed changes

vsemozhetbyt reviewed May 2, 2018

View reviewed changes

BeniCheni added 5 commits May 2, 2018 14:12

doc: update examples of the final "callback" argument for fs.access()

a8c52ec

doc: update "readable" and "writable" examples for fs.access()

a54e659

doc: update code format per max-len linting rule

9ee4767

doc: refactor js examples for fs.access()

7bb85fc

doc: update file namespace from "package.json" to "file" variable in …

59ad1f8

…js examples for fs.access()

vsemozhetbyt approved these changes May 2, 2018

View reviewed changes

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

trivikr approved these changes May 3, 2018

View reviewed changes

vsemozhetbyt pushed a commit that referenced this pull request May 4, 2018

doc: update examples for fs.access()

b4ca3a4

PR-URL: #20460 Fixes: #17508 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

vsemozhetbyt closed this May 4, 2018

MylesBorins pushed a commit that referenced this pull request May 4, 2018

doc: update examples for fs.access()

18bb358

PR-URL: #20460 Fixes: #17508 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

MylesBorins mentioned this pull request May 8, 2018

v10.1.0 proposal #20606

Merged

MylesBorins pushed a commit that referenced this pull request May 8, 2018

doc: update examples for fs.access()

d7db306

PR-URL: #20460 Fixes: #17508 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

BeniCheni mentioned this pull request Jun 18, 2018

dns.js not properly iterating through DNS array #21391

Closed

BeniCheni deleted the fs-md-updt-dot-access branch August 24, 2018 19:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: update examples of the final "callback" argument for fs.access() #20460

doc: update examples of the final "callback" argument for fs.access() #20460

BeniCheni commented May 1, 2018

Trott May 2, 2018

Trott May 2, 2018

Trott May 2, 2018

vsemozhetbyt May 2, 2018

Trott May 2, 2018

Trott May 2, 2018

Trott May 2, 2018

Trott commented May 2, 2018

vsemozhetbyt May 2, 2018 •

edited

Loading

vsemozhetbyt commented May 2, 2018

BeniCheni commented May 2, 2018

vsemozhetbyt May 2, 2018

vsemozhetbyt commented May 2, 2018 •

edited

Loading

vsemozhetbyt commented May 2, 2018

BeniCheni commented May 2, 2018 •

edited

Loading

vsemozhetbyt May 2, 2018

BeniCheni commented May 2, 2018

vsemozhetbyt commented May 3, 2018

Trott commented May 3, 2018

vsemozhetbyt commented May 4, 2018

vsemozhetbyt commented May 4, 2018

doc: update examples of the final "callback" argument for fs.access() #20460

doc: update examples of the final "callback" argument for fs.access() #20460

Conversation

BeniCheni commented May 1, 2018

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott commented May 2, 2018

vsemozhetbyt May 2, 2018 • edited Loading

Choose a reason for hiding this comment

vsemozhetbyt commented May 2, 2018

BeniCheni commented May 2, 2018

Choose a reason for hiding this comment

vsemozhetbyt commented May 2, 2018 • edited Loading

vsemozhetbyt commented May 2, 2018

BeniCheni commented May 2, 2018 • edited Loading

Choose a reason for hiding this comment

BeniCheni commented May 2, 2018

vsemozhetbyt commented May 3, 2018

Trott commented May 3, 2018

vsemozhetbyt commented May 4, 2018

vsemozhetbyt commented May 4, 2018

vsemozhetbyt May 2, 2018 •

edited

Loading

vsemozhetbyt commented May 2, 2018 •

edited

Loading

BeniCheni commented May 2, 2018 •

edited

Loading