🏗 Add @types/fs-extra and fix related typing issues (#36087)

ampproject · Sep 20, 2021 · 9b97955 · 9b97955
1 parent ffe1481
commit 9b97955
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 31 deletions.
diff --git a/build-system/common/update-packages.js b/build-system/common/update-packages.js
@@ -17,7 +17,10 @@ const {runNpmChecks} = require('./npm-checks');
  * @param {string} file Contents to write
  */
 function writeIfUpdated(patchedName, file) {
-  if (!fs.existsSync(patchedName) || fs.readFileSync(patchedName) != file) {
+  if (
+    !fs.existsSync(patchedName) ||
+    fs.readFileSync(patchedName, 'utf8') != file
+  ) {
     fs.writeFileSync(patchedName, file);
     logLocalDev('Patched', cyan(patchedName));
   }

diff --git a/build-system/common/utils.js b/build-system/common/utils.js
@@ -102,7 +102,7 @@ function getFilesFromFileList() {
   if (!argv.filelist) {
     return [];
   }
-  return fs.readFileSync(argv.filelist, {encoding: 'utf8'}).trim().split(',');
+  return fs.readFileSync(argv.filelist, 'utf8').trim().split(',');
 }
 
 /**

diff --git a/build-system/compile/post-closure-babel.js b/build-system/compile/post-closure-babel.js
@@ -64,7 +64,7 @@ async function postClosureBabel(file) {
   const {compressed, terserMap} = await terserMinify(code);
   await fs.outputFile(file, compressed);
 
-  const closureMap = await fs.readJson(`${file}.map`, 'utf-8');
+  const closureMap = await fs.readJson(`${file}.map`, {encoding: 'utf8'});
   const sourceMap = remapping(
     [terserMap, babelMap, closureMap],
     () => null,

diff --git a/build-system/compile/pre-closure-babel.js b/build-system/compile/pre-closure-babel.js
@@ -81,7 +81,7 @@ async function preClosureBabel(file, outputFilename, options) {
   }
   const transformedFile = path.join(outputDir, file);
   if (!filesToTransform.includes(file)) {
-    if (!(await fs.exists(transformedFile))) {
+    if (!(await fs.pathExists(transformedFile))) {
       await fs.copy(file, transformedFile);
     }
     return transformedFile;
@@ -96,7 +96,7 @@ async function preClosureBabel(file, outputFilename, options) {
     const {contents, hash} = await batchedRead(file, optionsHash);
     const cachedPromise = transformCache.get(hash);
     if (cachedPromise) {
-      if (!(await fs.exists(transformedFile))) {
+      if (!(await fs.pathExists(transformedFile))) {
         await fs.outputFile(transformedFile, await cachedPromise);
       }
     } else {

diff --git a/build-system/pr-check/utils.js b/build-system/pr-check/utils.js
@@ -327,7 +327,7 @@ function generateCircleCiShardTestFileList(globs) {
   )
     .trim()
     .replace(/\s+/g, ',');
-  fs.writeFileSync(TEST_FILES_LIST_FILE_NAME, fileList, {encoding: 'utf8'});
+  fs.writeFileSync(TEST_FILES_LIST_FILE_NAME, fileList, 'utf8');
   logWithoutTimestamp(
     'Stored list of',
     cyan(fileList.split(',').length),

diff --git a/build-system/tasks/check-exact-versions.js b/build-system/tasks/check-exact-versions.js
@@ -12,7 +12,7 @@ const {log, logLocalDev, logWithoutTimestamp} = require('../common/logging');
  * @return {boolean}
  */
 function check(file) {
-  const json = fs.readJsonSync(file, 'utf8');
+  const json = fs.readJsonSync(file, {encoding: 'utf8'});
 
   // We purposfully ignore peerDependencies here, because that's that's for the
   // consumer to decide.

diff --git a/build-system/tasks/dep-check.js b/build-system/tasks/dep-check.js
@@ -208,7 +208,7 @@ async function getModuleGraph(entryPointModule) {
 
 /**
  * @param {string} extensionFolder
- * @return {!Array<!ModuleDef>}
+ * @return {!Array<string>}
  */
 function getEntryPoint(extensionFolder) {
   const extension = path.basename(extensionFolder);

diff --git a/build-system/tasks/make-extension/index.js b/build-system/tasks/make-extension/index.js
@@ -111,31 +111,20 @@ async function writeFromTemplateDir(
     await fs.mkdirp(path.dirname(destination));
 
     // Skip if the destination file already exists
-    let fileHandle;
-    try {
-      fileHandle = await fs.open(destination, 'wx');
-    } catch (e) {
-      if (e.code !== 'EEXIST') {
-        throw e;
-      }
-      if (!argv.overwrite) {
-        logLocalDev(
-          yellow('WARNING:'),
-          'Skipping existing file',
-          cyan(destination)
-        );
-        continue;
-      }
+    if (await fs.pathExists(destination)) {
       logLocalDev(
         yellow('WARNING:'),
-        'Overwriting existing file',
+        argv.overwrite ? 'Overwriting' : 'Skipping',
+        'existing file',
         cyan(destination)
       );
+      if (!argv.overwrite) {
+        continue;
+      }
     }
 
     const template = await fs.readFile(templatePath, 'utf8');
-    await fs.write(fileHandle, replace(template, replacements));
-    await fs.close(fileHandle);
+    await fs.writeFile(destination, replace(template, replacements));
 
     logLocalDev(green('SUCCESS:'), 'Created', cyan(destination));
 
@@ -155,11 +144,7 @@ async function insertExtensionBundlesConfig(
   bundle,
   destination = extensionBundlesJson
 ) {
-  let extensionBundles = [];
-  try {
-    extensionBundles = await fs.readJson(destination, {throws: false});
-  } catch (_) {}
-
+  const extensionBundles = fs.readJsonSync(destination, {throws: false}) ?? [];
   const existingOrNull = extensionBundles.find(
     ({name}) => name === bundle.name
   );

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -62,6 +62,7 @@
     "@types/chai": "4.2.21",
     "@types/eslint": "7.28.0",
     "@types/minimist": "1.2.2",
+    "@types/fs-extra": "9.0.12",
     "@types/mocha": "8.2.3",
     "@types/node": "14.17.12",
     "acorn-globals": "6.0.0",