-
Notifications
You must be signed in to change notification settings - Fork 776
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Show support for mode #587
Show support for mode #587
Conversation
69af26f
to
5a63e26
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh ya, that was missing in the docs. Thanks 👍
docs/ensureDir.md
Outdated
|
||
// With a callback: | ||
fs.ensureDir(dir, err => { | ||
console.log(err) // => null | ||
// dir has now been created, including the directory it is to be placed in | ||
}) | ||
|
||
// With a callback and a mode integer | ||
fs.ensureDir(dir, desireMode, err => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@robertjacobson should be desiredMode
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, good catch @manidlou. Fixed.
Node fs's mkdir supports mode specification. After reviewing the source fs-extra does as well, but is not documented. Update the documentation to include the `options` parameter and provide a few examples of using `mode`.
5a63e26
to
0957688
Compare
@jprichardson do you have any concerns about this? If not, we can merge it then. |
Per #96 (comment) `fs.ensureDir` has `mode` documented, as of jprichardson/node-fs-extra#587
Summary: Changes are mostly bug fixes, that shouldn't affect us. From the change log: 7.0.1 / 2018-11-07 ------------------ - Fix `removeSync()` on Windows, in some cases, it would error out with `ENOTEMPTY` ([#646](jprichardson/node-fs-extra#646)) - Document `mode` option for `ensureDir*()` ([#587](jprichardson/node-fs-extra#587)) - Don't include documentation files in npm package tarball ([#642](jprichardson/node-fs-extra#642), [#643](jprichardson/node-fs-extra#643)) 7.0.0 / 2018-07-16 ------------------ - **BREAKING:** Refine `copy*()` handling of symlinks to properly detect symlinks that point to the same file. ([#582](jprichardson/node-fs-extra#582)) - Fix bug with copying write-protected directories ([#600](jprichardson/node-fs-extra#600)) - Universalify `fs.lchmod()` ([#596](jprichardson/node-fs-extra#596)) - Add `engines` field to `package.json` ([#580](jprichardson/node-fs-extra#580)) 6.0.1 / 2018-05-09 ------------------ - Fix `fs.promises` `ExperimentalWarning` on Node v10.1.0 ([#578](jprichardson/node-fs-extra#578)) 6.0.0 / 2018-05-01 ------------------ - Drop support for Node.js versions 4, 5, & 7 ([#564](jprichardson/node-fs-extra#564)) - Rewrite `move` to use `fs.rename` where possible ([#549](jprichardson/node-fs-extra#549)) - Don't convert relative paths to absolute paths for `filter` ([#554](jprichardson/node-fs-extra#554)) - `copy*`'s behavior when `preserveTimestamps` is `false` has been OS-dependent since 5.0.0, but that's now explicitly noted in the docs ([#563](jprichardson/node-fs-extra#563)) - Fix subdirectory detection for `copy*` & `move*` ([#541](jprichardson/node-fs-extra#541)) - Handle case-insensitive paths correctly in `copy*` ([#568](jprichardson/node-fs-extra#568)) Reviewed By: jknoxville Differential Revision: D13023753 fbshipit-source-id: 1ecc6f40be4c8146f92dd29ede846b5ab56765ea
Node fs's
mkdir
(https://nodejs.org/api/fs.html#fs_fs_mkdir_path_mode_callback) supports mode specification. After reviewing the sourcefs-extra
does as well, but is not documented. Update the documentationto include the
options
parameter and provide a few examples of usingmode
.