Skip to content
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

Detect if fs.rmSync is available to avoid the runtime deprecation warning #1348

Merged
merged 7 commits into from
Apr 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions extra/download-dist.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const tar = require("tar");

const packageJSON = require("../package.json");
const fs = require("fs");
const rmSync = require("./fs-rmSync.js");
const version = packageJSON.version;

const filename = "dist.tar.gz";
Expand All @@ -21,7 +22,7 @@ function download(url) {
if (fs.existsSync("./dist")) {

if (fs.existsSync("./dist-backup")) {
fs.rmdirSync("./dist-backup", {
rmSync("./dist-backup", {
recursive: true
});
}
Expand All @@ -35,7 +36,7 @@ function download(url) {

tarStream.on("close", () => {
if (fs.existsSync("./dist-backup")) {
fs.rmdirSync("./dist-backup", {
rmSync("./dist-backup", {
recursive: true
});
}
Expand Down
20 changes: 20 additions & 0 deletions extra/fs-rmSync.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
const fs = require("fs");
/**
* Detect if `fs.rmSync` is available
* to avoid the runtime deprecation warning triggered for using `fs.rmdirSync` with `{ recursive: true }` in Node.js v16,
* or the `recursive` property removing completely in the future Node.js version.
* See the link below.
* @link https://nodejs.org/docs/latest-v16.x/api/deprecations.html#dep0147-fsrmdirpath--recursive-true-
* @param {fs.PathLike} path Valid types for path values in "fs".
* @param {fs.RmDirOptions} [options] options for `fs.rmdirSync`, if `fs.rmSync` is available and property `recursive` is true, it will automatically have property `force` with value `true`.
*/
const rmSync = (path, options) => {
if (typeof fs.rmSync === "function") {
if (options.recursive) {
options.force = true;
}
return fs.rmSync(path, options);
}
return fs.rmdirSync(path, options);
};
module.exports = rmSync;
7 changes: 4 additions & 3 deletions extra/update-language-files/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import fs from "fs";
import path from "path";
import util from "util";
import rmSync from "../fs-rmSync.js";

// https://stackoverflow.com/questions/13786160/copy-folder-recursively-in-node-js
/**
Expand Down Expand Up @@ -30,7 +31,7 @@ console.log("Arguments:", process.argv);
const baseLangCode = process.argv[2] || "en";
console.log("Base Lang: " + baseLangCode);
if (fs.existsSync("./languages")) {
fs.rmdirSync("./languages", { recursive: true });
rmSync("./languages", { recursive: true });
}
copyRecursiveSync("../../src/languages", "./languages");

Expand All @@ -40,7 +41,7 @@ const files = fs.readdirSync("./languages");
console.log("Files:", files);

for (const file of files) {
if (!file.endsWith(".js")) {
if (! file.endsWith(".js")) {
console.log("Skipping " + file);
continue;
}
Expand Down Expand Up @@ -82,5 +83,5 @@ for (const file of files) {
fs.writeFileSync(`../../src/languages/${file}`, code);
}

fs.rmdirSync("./languages", { recursive: true });
rmSync("./languages", { recursive: true });
console.log("Done. Fixing formatting by ESLint...");
2 changes: 1 addition & 1 deletion extra/update-version.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const pkg = require("../package.json");
const fs = require("fs");
const rmSync = require("./fs-rmSync.js");
const child_process = require("child_process");
const util = require("../src/util");

Expand Down Expand Up @@ -58,4 +59,3 @@ function tagExists(version) {

return res.stdout.toString().trim() === version;
}

3 changes: 2 additions & 1 deletion test/prepare-jest.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
const fs = require("fs");
const rmSync = require("../extra/fs-rmSync.js");

const path = "./data/test-chrome-profile";

if (fs.existsSync(path)) {
fs.rmdirSync(path, {
rmSync(path, {
recursive: true,
});
}
3 changes: 2 additions & 1 deletion test/prepare-test-server.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
const fs = require("fs");
const rmSync = require("../extra/fs-rmSync.js");

const path = "./data/test";

if (fs.existsSync(path)) {
fs.rmdirSync(path, {
rmSync(path, {
recursive: true,
});
}