Remove unused functions in fileUtils, move things around, use fs/promises more, and other refactors

Author: Gold856

vscode-wpilib/src/shared/fileUtils.ts

@@ -1,41 +1,8 @@
 'use strict';
 
-import * as fs from 'fs';
-import { rename } from 'fs/promises';
+import { readFile, writeFile } from 'fs/promises';
 import * as path from 'path';
 import { logger } from '../logger';
-import { ncpAsync } from '../utilities';
-import { updateFileContents } from './pathUtils';
-
-/**
- * A copy files wrapper function that also returns all copied files. Can throw exceptions.
- */
-export async function copyAndReturnFiles(
-  sourceFolder: string,
-  destinationFolder: string,
-  filter?: (sourcePath: string) => boolean
-): Promise<string[]> {
-  const copiedFiles: string[] = [];
-  await ncpAsync(sourceFolder, destinationFolder, {
-    filter: (filePath: string): boolean => {
-      // Apply custom filter if provided
-      if (filter) {
-        // Track copied files if requested
-        if (filter(filePath) && fs.lstatSync(filePath).isFile()) {
-          copiedFiles.push(path.relative(sourceFolder, filePath));
-        }
-        return filter(filePath);
-      }
-      if (fs.lstatSync(filePath).isFile()) {
-        copiedFiles.push(path.relative(sourceFolder, filePath));
-      }
-
-      return true;
-    },
-  });
-
-  return copiedFiles;
-}
 
 export async function processFile(
   file: string,
@@ -52,54 +19,22 @@ export async function processFile(
 }
 
 /**
- * Rename files based on pattern replacement
+ * Safely updates file contents by reading and writing atomically
  */
-export async function renameFiles(
-  files: string[],
-  basePath: string,
-  pattern: string | RegExp,
-  replacement: string
-): Promise<string[]> {
-  const renamePromises: Promise<string>[] = [];
-  const regex = typeof pattern === 'string' ? new RegExp(pattern, 'g') : pattern;
-
-  for (const filePath of files) {
-    const fullPath = path.join(basePath, filePath);
-    const filename = path.basename(fullPath);
-
-    // Only rename files matching the pattern
-    if (filename.match(regex)) {
-      const directory = path.dirname(fullPath);
-      const newName = filename.replace(regex, replacement);
-      const newPath = path.join(directory, newName);
-
-      renamePromises.push(
-        (async () => {
-          await rename(fullPath, newPath);
-          return newPath;
-        })()
-      );
-    }
-  }
-
+export async function updateFileContents(
+  filePath: string,
+  replacer: (content: string) => string
+): Promise<boolean> {
   try {
-    return await Promise.all(renamePromises);
-  } catch (error) {
-    logger.error('Error renaming files:', error);
-    throw error;
-  }
-}
-
-/**
- * Create a filter function that takes in a path to a file and checks if the file names matches a list of file names
- */
-export function createFileNameFilter(fileNames: string[]) {
-  return (sourcePath: string): boolean => {
-    if (!fs.lstatSync(sourcePath).isFile()) {
-      return true; // Always include directories
+    const fileContent = await readFile(filePath, 'utf8');
+    const updatedContent = replacer(fileContent);
+    if (fileContent !== updatedContent) {
+      await writeFile(filePath, updatedContent, 'utf8');
+      return true;
     }
-
-    const basename = path.basename(sourcePath);
-    return fileNames.includes(basename);
-  };
+    return false;
+  } catch (err) {
+    logger.error('Failed to update file contents', err);
+    return false;
+  }
 }

vscode-wpilib/src/shared/generator.ts

@@ -2,10 +2,10 @@
 
 import * as path from 'path';
 import { logger } from '../logger';
+import { ncpAsync } from '../utilities';
+import * as fileUtils from './fileUtils';
 import * as pathUtils from './pathUtils';
 import * as genUtils from './projectGeneratorUtils';
-import { ncpAsync } from '../utilities';
-import { processFile } from './fileUtils';
 
 export async function generateCopyCpp(
   resourcesFolder: string,
@@ -105,19 +105,23 @@ export async function generateCopyJava(
     }
 
     // Process template files
-    await Promise.all(files.map((testFile) => processFile(testFile, codePath, replacements)));
+    await Promise.all(
+      files.map((testFile) => fileUtils.processFile(testFile, codePath, replacements))
+    );
 
     // Process test files if they exist
     if (fromTemplateTestFolder !== undefined) {
       const testFiles = await genUtils.findMatchingFiles(testPath);
-      await Promise.all(testFiles.map((testFile) => processFile(testFile, testPath, replacements)));
+      await Promise.all(
+        testFiles.map((testFile) => fileUtils.processFile(testFile, testPath, replacements))
+      );
     }
 
     // Setup project structure
     await genUtils.setupProjectStructure(fromGradleFolder, toFolder, grRoot);
 
     // Update gradle file with correct version and robot class
-    await pathUtils.updateFileContents(path.join(toFolder, 'build.gradle'), (content) =>
+    await fileUtils.updateFileContents(path.join(toFolder, 'build.gradle'), (content) =>
       content
         .replace(new RegExp(genUtils.ReplacementPatterns.ROBOT_CLASS_MARKER, 'g'), robotClassTo)
         .replace(new RegExp(genUtils.ReplacementPatterns.GRADLE_RIO_MARKER, 'g'), gradleRioVersion)
@@ -137,7 +141,7 @@ export async function generateCopyJava(
 }
 
 export async function setDesktopEnabled(buildgradle: string, setting: boolean): Promise<void> {
-  await pathUtils.updateFileContents(buildgradle, (content) =>
+  await fileUtils.updateFileContents(buildgradle, (content) =>
     content.replace(
       /def\s+includeDesktopSupport\s*=\s*(true|false)/gm,
       `def includeDesktopSupport = ${setting ? 'true' : 'false'}`

vscode-wpilib/src/shared/importupdater.ts

@@ -4,7 +4,7 @@ import * as jsonc from 'jsonc-parser';
 import path from 'path';
 import { logger } from '../logger';
 import { readFileAsync } from '../utilities';
-import { updateFileContents } from './pathUtils';
+import { updateFileContents } from './fileUtils';
 import glob = require('glob');
 
 interface IReplaceGroup {

vscode-wpilib/src/shared/pathUtils.ts

@@ -1,9 +1,8 @@
 'use strict';
 
-import { readdir } from 'fs/promises';
+import { cp, readdir } from 'fs/promises';
 import * as path from 'path';
 import { logger } from '../logger';
-import { copyFileAsync, readFileAsync, writeFileAsync } from '../utilities';
 
 /**
  * Creates source and test paths based on project type and import mode
@@ -37,27 +36,6 @@ export function getProjectPaths(
   return { codePath, testPath };
 }
 
-/**
- * Safely updates file contents by reading and writing atomically
- */
-export async function updateFileContents(
-  filePath: string,
-  replacer: (content: string) => string
-): Promise<boolean> {
-  try {
-    const fileContent = await readFileAsync(filePath, 'utf8');
-    const updatedContent = replacer(fileContent);
-    if (fileContent !== updatedContent) {
-      await writeFileAsync(filePath, updatedContent, 'utf8');
-      return true;
-    }
-    return false;
-  } catch (err) {
-    logger.error('Failed to update file contents', err);
-    return false;
-  }
-}
-
 /**
  * Copies a vendordep file to the project
  */
@@ -69,7 +47,7 @@ export async function copyVendorDep(
   try {
     const sourcePath = path.join(path.dirname(resourcesFolder), 'vendordeps', vendorDepName);
     const targetPath = path.join(targetDir, vendorDepName);
-    await copyFileAsync(sourcePath, targetPath);
+    await cp(sourcePath, targetPath);
     return true;
   } catch (err) {
     logger.error(`Failed to copy vendor dependency: ${vendorDepName}`, err);

vscode-wpilib/src/shared/projectGeneratorUtils.ts

@@ -1,12 +1,13 @@
 'use strict';
 
+import { cp, mkdir, readFile, writeFile } from 'fs/promises';
 import * as path from 'path';
-import glob = require('glob');
 import { localize as i18n } from '../locale';
 import { logger } from '../logger';
-import { mkdirpAsync, ncpAsync, readFileAsync, writeFileAsync } from '../utilities';
-import { setExecutePermissions } from './permissions';
+import * as fileUtils from './fileUtils';
 import * as pathUtils from './pathUtils';
+import { setExecutePermissions } from './permissions';
+import glob = require('glob');
 
 /**
  * Common patterns used in text replacements
@@ -29,7 +30,7 @@ export const VendorDepFiles = {
 /**
  * Filter function for excluding files from gradle copy operations
  */
-export function gradleCopyFilter(sourcePath: string, fromGradleFolder: string): boolean {
+function gradleCopyFilter(sourcePath: string, fromGradleFolder: string): boolean {
   const rooted = path.relative(fromGradleFolder, sourcePath);
   if (rooted.startsWith('bin') || rooted.indexOf('.project') >= 0) {
     return false;
@@ -73,13 +74,15 @@ export async function setupProjectStructure(
 ): Promise<boolean> {
   try {
     // Copy gradle files
-    await ncpAsync(fromGradleFolder, toFolder, {
+    await cp(fromGradleFolder, toFolder, {
       filter: (cf) => gradleCopyFilter(cf, fromGradleFolder),
+      recursive: true,
     });
 
     // Copy shared gradle files
-    await ncpAsync(path.join(grRoot, 'shared'), toFolder, {
+    await cp(path.join(grRoot, 'shared'), toFolder, {
       filter: (cf) => gradleCopyFilter(cf, fromGradleFolder),
+      recursive: true,
     });
 
     // Set execute permissions on gradlew
@@ -100,7 +103,7 @@ export async function updateGradleRioVersion(
   gradleRioVersion: string
 ): Promise<boolean> {
   try {
-    return await pathUtils.updateFileContents(buildGradlePath, (content) =>
+    return await fileUtils.updateFileContents(buildGradlePath, (content) =>
       content.replace(new RegExp(ReplacementPatterns.GRADLE_RIO_MARKER, 'g'), gradleRioVersion)
     );
   } catch (error) {
@@ -123,7 +126,7 @@ export async function setupDeployDirectory(
     }
 
     const deployDir = path.join(toFolder, 'src', 'main', 'deploy');
-    await mkdirpAsync(deployDir);
+    await mkdir(deployDir, { recursive: true });
 
     const hintKey = isJava ? 'generateJavaDeployHint' : 'generateCppDeployHint';
     const hintText = isJava
@@ -135,10 +138,7 @@ to get a proper path relative to the deploy directory.`
 function from the 'frc/Filesystem.h' header to get a proper path relative to the deploy
 directory.`;
 
-    await writeFileAsync(
-      path.join(deployDir, 'example.txt'),
-      i18n('generator', [hintKey, hintText])
-    );
+    await writeFile(path.join(deployDir, 'example.txt'), i18n('generator', [hintKey, hintText]));
 
     return true;
   } catch (error) {
@@ -157,7 +157,7 @@ export async function setupVendorDeps(
 ): Promise<boolean> {
   try {
     const vendorDir = path.join(toFolder, 'vendordeps');
-    await mkdirpAsync(vendorDir);
+    await mkdir(vendorDir, { recursive: true });
 
     // Add WPILib New Commands
     await pathUtils.copyVendorDep(resourcesFolder, VendorDepFiles.COMMANDS, vendorDir);
@@ -183,5 +183,5 @@ export async function setupVendorDeps(
  */
 export async function getGradleRioVersion(grRoot: string): Promise<string> {
   const grVersionFile = path.join(grRoot, 'version.txt');
-  return (await readFileAsync(grVersionFile, 'utf8')).trim();
+  return (await readFile(grVersionFile, 'utf8')).trim();
 }