Remove mkdirp and rimraf in favor of Node.js builtins #31725
Conversation
…ttps://nodejs.org/api/fs.html#fsmkdirsyncpath-options). This option allows you to create a directory and all its parent directories if they do not exist. In Node.js v14.14.0, [`fs.rmSync`](https://nodejs.org/api/fs.html#fsrmsyncpath-options) was added. It's a built-in module that removes files and directories. The `recursive` option is used to remove directories and their contents. Since this repository requires Node.js 18 and up, it's safe to assume `mkdirp` and `rimraf` can be safely replaced, thus reducing the number of dependencies in this project.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
github-actions
bot
added
the
triage
|
👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:
You'll need to revert all of the files you changed that match that list using GitHub Desktop or The complete list of files we can't accept are:
We also can't accept contributions to files in the content directory with frontmatter |
wojtekmaj
changed the title
recursive option was added to [fs.mkdirSync](https://nodejs.org/api/fs.html#fsmkdirsyncpath-options). This option allows you to create a directory and all its parent directories if they do not exist.
nguyenalex836
removed
the
triage
|
@wojtekmaj Hi 👋 Unfortunately, per the automated response above, we are unable to accept this contribution. We appreciate your desire to contribute to GitHub Docs. I'll go ahead and close this PR 💛 |
Why:
In Node.js v14.14.0,
fs.rmSyncwas added. It's a built-in module that removes files and directories. Therecursiveoption is used to remove directories and their contents.Since this repository requires Node.js 18 and up, it's safe to assume
mkdirpandrimrafcan be safely replaced, thus reducing the number of dependencies in this project.What's being changed (if available, include any code snippets, screenshots, or gifs):
mkdirp(PATH)->(fs.)mkdir(PATH, { recursive: true })rimraf(PATH)->(fs.)rm(Sync)(PATH, { recursive: true, force: true })Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
datadirectory.For content changes, I have completed the self-review checklist.