More refactoring and bug fixes

Author: Gold856

vscode-wpilib/src/cpp/commands.ts

@@ -1,6 +1,6 @@
 'use strict';
 import * as fs from 'fs';
-import { cp } from 'fs/promises';
+import { copyFile } from 'fs/promises';
 import * as jsonc from 'jsonc-parser';
 import * as path from 'path';
 import * as vscode from 'vscode';
@@ -33,14 +33,14 @@ async function performCopy(
     const renamedHeader = path.join(folderHeader.fsPath, `${replaceName}.h`);
     const renamedSource = path.join(folderSrc.fsPath, `${replaceName}.cpp`);
     // The source and header arrays are always one item long
-    await cp(path.join(commandFolder, command.source[0]), renamedHeader);
-    await cp(path.join(commandFolder, command.headers[0]), renamedSource);
+    await copyFile(path.join(commandFolder, command.headers[0]), renamedHeader);
+    await copyFile(path.join(commandFolder, command.source[0]), renamedSource);
 
     // Process header files
     const headerReplacements = new Map<RegExp, string>();
     headerReplacements.set(new RegExp(command.replacename, 'g'), replaceName);
 
-    await fileUtils.processFile(renamedHeader, folderHeader.fsPath, headerReplacements);
+    await fileUtils.processFile(renamedHeader, headerReplacements);
     // Process source files with more complex replacements
     const sourceReplacements = new Map<RegExp, string>();
     const joinedName = path
@@ -53,7 +53,7 @@ async function performCopy(
     );
     sourceReplacements.set(new RegExp(command.replacename, 'g'), replaceName);
 
-    await fileUtils.processFile(renamedSource, folderSrc.fsPath, sourceReplacements);
+    await fileUtils.processFile(renamedSource, sourceReplacements);
     return true;
   } catch (error) {
     logger.error('Error performing copy operation:', error);

vscode-wpilib/src/java/commands.ts

@@ -1,13 +1,13 @@
 'use strict';
-import * as fs from 'fs';
-import { cp } from 'fs/promises';
+import { readFile } from 'fs';
+import { copyFile } from 'fs/promises';
 import * as jsonc from 'jsonc-parser';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { ICommandAPI, ICommandCreator, IPreferencesAPI } from '../api';
 import { logger } from '../logger';
-import { getClassName, getPackageName } from '../utilities';
 import * as fileUtils from '../shared/fileUtils';
+import { getClassName, getPackageName } from '../utilities';
 
 export interface IJavaJsonLayout {
   name: string;
@@ -27,7 +27,7 @@ async function performCopy(
   try {
     // Copy files and track them
     const renamedCommand = path.join(folder.fsPath, `${replaceName}.java`);
-    await cp(
+    await copyFile(
       path.join(commandRoot, command.foldername, `${command.replacename}.java`),
       renamedCommand
     );
@@ -42,7 +42,7 @@ async function performCopy(
     replacements.set(new RegExp(command.replacename, 'g'), replaceName);
 
     // Process files with replacements
-    await fileUtils.processFile(renamedCommand, folder.fsPath, replacements);
+    await fileUtils.processFile(renamedCommand, replacements);
 
     const document = await vscode.workspace.openTextDocument(vscode.Uri.file(renamedCommand));
     await vscode.window.showTextDocument(document);
@@ -59,7 +59,7 @@ export class Commands {
   constructor(resourceRoot: string, core: ICommandAPI, preferences: IPreferencesAPI) {
     const commandFolder = path.join(resourceRoot, 'src', 'commands');
     const resourceFile = path.join(commandFolder, this.commandResourceName);
-    fs.readFile(resourceFile, 'utf8', (err, data) => {
+    readFile(resourceFile, 'utf8', (err, data) => {
       if (err) {
         logger.error('Command file error: ', err);
         return;

vscode-wpilib/src/shared/fileUtils.ts

@@ -1,15 +1,15 @@
 'use strict';
 
 import { readFile, writeFile } from 'fs/promises';
-import * as path from 'path';
 import { logger } from '../logger';
 
-export async function processFile(
-  file: string,
-  basePath: string,
-  replacements: Map<RegExp, string>
-) {
-  return updateFileContents(path.join(basePath, file), (content) => {
+/**
+ * Updates a file using a set of regex replacements.
+ * @param filePath The absolute path to a file.
+ * @param replacements The regexes and what they are to be replaced with.
+ */
+export async function processFile(filePath: string, replacements: Map<RegExp, string>) {
+  return updateFileContents(filePath, (content) => {
     // Apply all replacements
     for (const [pattern, replacement] of replacements) {
       content = content.replace(pattern, replacement);
@@ -19,7 +19,8 @@ export async function processFile(
 }
 
 /**
- * Safely updates file contents by reading and writing atomically
+ * Safely updates file contents by reading and writing atomically.
+ * @param filePath The absolute path to a file.
  */
 export async function updateFileContents(
   filePath: string,

vscode-wpilib/src/shared/generator.ts

@@ -55,6 +55,20 @@ export async function generateCopyCpp(
   }
 }
 
+/**
+ * Generates a Java project.
+ * @param resourcesFolder The folder where the extension resources for a language are.
+ * @param fromTemplateFolder The folder where the template/project source files are.
+ * @param fromTemplateTestFolder The folder where the template/project test source files are.
+ * @param fromGradleFolder The folder where build.gradle is located.
+ * @param toFolder The folder to copy everything to. This is the root of the project.
+ * @param robotClassTo The main robot class.
+ * @param copyRoot The base package in folder form to copy to.
+ * @param directGradleImport Whether or not the file in fromTemplateFolder are in the Gradle project structure already.
+ * @param extraVendordeps List of extra WPILib vendordeps to add to the project.
+ * @param packageReplaceString The base package to replace with frc.robot.
+ * @returns True if the project successfully generated, false otherwise.
+ */
 export async function generateCopyJava(
   resourcesFolder: string,
   fromTemplateFolder: string,
@@ -105,16 +119,12 @@ export async function generateCopyJava(
     }
 
     // Process template files
-    await Promise.all(
-      files.map((testFile) => fileUtils.processFile(testFile, codePath, replacements))
-    );
+    await Promise.all(files.map((file) => fileUtils.processFile(file, replacements)));
 
     // Process test files if they exist
     if (fromTemplateTestFolder !== undefined) {
       const testFiles = await genUtils.findMatchingFiles(testPath);
-      await Promise.all(
-        testFiles.map((testFile) => fileUtils.processFile(testFile, testPath, replacements))
-      );
+      await Promise.all(testFiles.map((testFile) => fileUtils.processFile(testFile, replacements)));
     }
 
     // Setup project structure

vscode-wpilib/src/shared/pathUtils.ts

@@ -1,9 +1,8 @@
 'use strict';
 
-import { readdir } from 'fs/promises';
+import { copyFile, readdir } from 'fs/promises';
 import * as path from 'path';
 import { logger } from '../logger';
-import { copyFileAsync } from '../utilities';
 
 /**
  * Creates source and test paths based on project type and import mode
@@ -48,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 copyFile(sourcePath, targetPath);
     return true;
   } catch (err) {
     logger.error(`Failed to copy vendor dependency: ${vendorDepName}`, err);

vscode-wpilib/src/shared/projectGeneratorUtils.ts

@@ -65,7 +65,10 @@ export async function findMatchingFiles(
 }
 
 /**
- * Setup project structure and copy Gradle files
+ * Setup project structure and copy Gradle files.
+ * @param fromGradleFolder The folder where the files, like build.gradle, for a specific project type are located.
+ * @param toFolder The folder to copy files to.
+ * @param grRoot The folder where the extension's Gradle files are.
  */
 export async function setupProjectStructure(
   fromGradleFolder: string,
@@ -119,6 +122,7 @@ export async function setupDeployDirectory(
   isJava: boolean
 ): Promise<boolean> {
   try {
+    // Already done when files were copied to the code path
     if (directGradleImport) {
       return true;
     }