reformat

Author: tom22k

scripts/tables/add-rows-to-table.ts

@@ -12,10 +12,11 @@ function main(
 ) {
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   const columnNames = table.getColumns().map(col => col.getName().trim());
+
   let inputData: Record<string, string>[];
   try {
     inputData = JSON.parse(inputJson);
@@ -31,13 +32,17 @@ function main(
   const inputKeys = Object.keys(inputData[0]).map(k => k.trim());
   for (const key of inputKeys) {
     if (!columnNames.includes(key)) {
-      throw new Error(`Input key "${key}" does not match any column in the table "${tableName}".`);
+      throw new Error(`Input key '${key}' does not match any column in the table '${tableName}'.`);
     }
   }
 
   // build 2D array matching table column order
-  const rows = inputData.map(obj => columnNames.map(colName => obj[colName] ?? undefined));
+  const rows = inputData.map(obj =>
+    columnNames.map(colName => obj[colName] ?? undefined)
+  );
   console.log(rows);
+
   table.addRows(-1, rows);
+
   return "Rows added successfully.";
 }

scripts/tables/auto-fit-column-widths.ts

@@ -9,7 +9,7 @@ function main(
 ) {
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   table.getRange().getFormat().autofitColumns();

scripts/tables/clear-cell-contents.ts

@@ -13,18 +13,20 @@ function main(
 ) {
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   // Get all headers and find the column index
   const headers = table.getHeaderRowRange().getValues()[0];
   const columnIndex = headers.indexOf(columnName);
+
   if (columnIndex === -1) {
-    throw new Error(`Column "${columnName}" not found.`);
+    throw new Error(`Column '${columnName}' not found.`);
   }
 
-  // Get the row (excluding the header row);
+  // Get the row (excluding the header row)
   const rowRange = table.getRangeBetweenHeaderAndTotal();
   const targetCell = rowRange.getCell(rowIndex, columnIndex);
+
   targetCell.clear(ExcelScript.ClearApplyTo.contents);
 }

scripts/tables/convert-name-cases.ts

@@ -19,7 +19,7 @@ function main(
   columnsToFix.forEach(columnName => {
     const column = table.getColumnByName(columnName);
     if (!column) {
-      throw new Error(`Input key "${columnName}" does not match any column in the table "${tableName}".`);
+      throw new Error(`Input key '${columnName}' does not match any column in the table '${tableName}'.`);
     }
 
     let values = column.getRange().getValues();
@@ -35,12 +35,12 @@ function main(
       if (cellValue === cellValue.toUpperCase() || cellValue === cellValue.toLowerCase()) {
         // Convert to Proper Case while handling accents
         const properCaseValue = cellValue.toLowerCase().replace(
-          /(^|\\s)([a-záéíóúüñâàäêëîïôöûüç])/g,
+          /(^|\s)([a-záéíóúüñâàäêëîïôöûüç])/g,
           (_, boundary, letter) => boundary + letter.toUpperCase()
         );
 
         // Update the value in the array
-        values[i][0] = properCaseValue
+        values[i][0] = properCaseValue;
       }
     }
 

scripts/tables/convert-table-column-from-formula-to-values.ts

@@ -14,31 +14,30 @@ function main(
   fullColumn: boolean = false,
   numberOfRowsFromEnd?: number
 ) {
-  if (!fullColumn && !numberOfRowsFromEnd) {
-    throw new Error(`Parameter "numberOfRowsFromEnd" is required when fullColumn is set to false.`);
-  }
-
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   const column = table.getColumnByName(columnName);
   if (!column) {
-    throw new Error(`Column "${columnName}" not found.`);
+    throw new Error(`Column '${columnName}' not found.`);
   }
 
   // clear filters so following actions are not impacted
   table.getAutoFilter().clearCriteria();
 
   const totalColRange = column.getRangeBetweenHeaderAndTotal();
+
   let range: ExcelScript.Range;
   if (fullColumn) {
     range = totalColRange;
+
   } else if (numberOfRowsFromEnd) {
     range = totalColRange.getLastCell().getOffsetRange(1 - numberOfRowsFromEnd, 0).getAbsoluteResizedRange(numberOfRowsFromEnd, 1);
+
   } else {
-    throw new Error(`numberOfRowsFromEnd required when fullColumn is false.`);
+    throw new Error(`Parameter 'numberOfRowsFromEnd' is required when fullColumn is set to false.`);
   }
 
   range.copyFrom(

scripts/tables/create-pivot-table.ts

@@ -1,14 +1,14 @@
 /**
-  * Creates a pivot table from an existing table with specified row and value aggregations.
-  *
-  * @param tableName Name of the source table for the pivot table.
-  * @param location Where to place the pivot table: "New sheet" creates a new worksheet, "Existing sheet" places it below the source table unless a sheet name is specified.
-  * @param rowsColumn Column name to use for pivot table rows.
-  * @param valuesColumns Array of column names to aggregate in the pivot table values area.
-  * @param valuesOperation Aggregation function to apply to the values columns.
-  * @param sheetName The name of the sheet the pivot table should be placed on when location is Existing sheet (defaults to same sheet as table). If location is New sheet, this is the name the new sheet should have.
-  * @param pivotTableName Optional name for the pivot table (auto-generates if blank or already exists);
-  */
+ * Creates a pivot table from an existing table with specified row and value aggregations.
+ * 
+ * @param tableName Name of the source table for the pivot table.
+ * @param location Where to place the pivot table: "New sheet" creates a new worksheet, "Existing sheet" places it below the source table unless a sheet name is specified.
+ * @param rowsColumn Column name to use for pivot table rows.
+ * @param valuesColumns Array of column names to aggregate in the pivot table values area.
+ * @param valuesOperation Aggregation function to apply to the values columns.
+ * @param sheetName The name of the sheet the pivot table should be placed on when location is Existing sheet (defaults to same sheet as table). If location is New sheet, this is the name the new sheet should have.
+ * @param pivotTableName Optional name for the pivot table (auto-generates if blank or already exists)
+ */
 function main(
   workbook: ExcelScript.Workbook,
   tableName: string,
@@ -22,22 +22,22 @@ function main(
 ) {
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   if (table.getRowCount() === 0) {
-    throw new Error(`Table "${tableName}" has no data.`);
+    throw new Error(`Table '${tableName}' has no data.`);
   }
 
   // make sure specified columns exist
   const tableCols = table.getColumns().map((col) => col.getName());
-  let missingColumn: string;
   if (!tableCols.includes(rowsColumn)) {
-    throw new Error(`There is no column "${rowsColumn}" in table "${tableName}".`);
-  } else {
+    throw new Error(`There is no column '${rowsColumn}' in table '${tableName}'.`);
+  }
+  else {
     valuesColumns.forEach((colName) => {
       if (!tableCols.includes(colName)) {
-        throw new Error(`There is no column "${colName}" in table "${tableName}".`);
+        throw new Error(`There is no column '${colName}' in table '${tableName}'.`);
       }
     });
   }
@@ -89,7 +89,6 @@ function main(
     pivotTableName = defaultName + i;
   }
 
-  // create pivot table
   const pivotTable = workbook.addPivotTable(pivotTableName, table, locationRange);
 
   // add rows field to pivot table

scripts/tables/create-table-from-json.ts

@@ -1,22 +1,22 @@
 /**
-  * Creates a table from JSON data on a specified worksheet.
-  * 
-  * @param sheetName Name of the worksheet where the table will be created
-  * @param startCell Top-left cell address for the table (e.g., "A1")
-  * @param inputJson JSON string containing array of objects with consistent keys
-  * @param tableName Optional name for the created table
-  */
+ * Creates a table from JSON data on a specified worksheet.
+ * 
+ * @param sheetName Name of the worksheet where the table will be created
+ * @param startCell Top-left cell address for the table (e.g., "A1")
+ * @param inputJson JSON string containing array of objects with consistent keys
+ * @param tableName Optional name for the created table
+ */
 function main(
   workbook: ExcelScript.Workbook,
   sheetName: string,
   startCell: string,
   inputJson: string,
   tableName?: string
 ) {
-  let returnMsg: string
+  let returnMsg: string;
 
   const sheet = workbook.getWorksheet(sheetName);
-  if (!sheet) throw new Error(`Worksheet "${sheetName}" not found.`);
+  if (!sheet) throw new Error(`Worksheet '${sheetName}' not found.`);
 
   let inputData: Record<string, string | number | boolean>[];
   try {
@@ -36,17 +36,18 @@ function main(
   // convert startCell to a full range
   const startRange = sheet.getRange(startCell);
   const endRange = startRange.getOffsetRange(0, numCols - 1);
-  const tableRange = `${startCell}:${endRange.getAddress().split('!')[1]}`
+  const tableRange = `${startCell}:${endRange.getAddress().split('!')[1]}`;
 
   // create table with headers only
   const table = sheet.addTable(tableRange, true);
+
   if (tableName) {
     try {
       table.setName(tableName);
     } catch (e) {
       const allTables = workbook.getTables().map(tbl => tbl.getName());
       if (allTables.includes(tableName)) {
-        returnMsg = `A table already exists with the name "${tableName}".`
+        returnMsg = `A table already exists with the name '${tableName}'.`;
       } else {
         throw new Error(e);
       }
@@ -63,7 +64,9 @@ function main(
   // add data rows
   const rowsData = inputData.map(obj => inputKeys.map(key => obj[key]));
   table.addRows(-1, rowsData);
+
   return {
-    "message": "Successfully created table." + ((returnMsg) ? "\ " + returnMsg : ""), "createdTableName": table.getName()
-  };
+    "message": "Successfully created table." + ((returnMsg) ? "\n" + returnMsg : ""),
+    "createdTableName": table.getName()
+  }
 }

scripts/tables/highlight-specific-table-columns.ts

@@ -21,18 +21,18 @@ function main(
   switch (matchType) {
     case "List of column names": {
       if (!columnNamesArray) {
-        throw new Error(`Parameter columnNamesArray is required when matchType is "List of column names".`);
+        throw new Error("Parameter columnNamesArray is required when matchType is 'List of column names'.");
       }
       break;
     }
     case "RegEx": {
       if (!regexPattern) {
-        throw new Error(`Parameter regexPattern is required when matchType is "RegEx".`);
+        throw new Error("Parameter regexPattern is required when matchType is 'RegEx'.");
       }
       break;
     }
     default: {
-      throw new Error(`Parameter matchType has an unrecognised value. Valid values are "List of column names" and "RegEx".`);
+      throw new Error("Parameter matchType has an unrecognised value. Valid values are 'List of column names' and 'RegEx'.");
     }
   }
 
@@ -48,7 +48,7 @@ function main(
 
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   const tableCols = table.getColumns();
@@ -78,14 +78,16 @@ function main(
   if (matchType === "List of column names") {
     const highlightedColNames = colsToHighlight.map((col) => col.getName());
     const missingCols = columnNamesArray.filter((name) => {
-      return !highlightedColNames.includes(name);
+      return !highlightedColNames.includes(name)
     });
 
     return {
-      "message": "Successfully highlighted matched columns.", "notFoundColumns": missingCols || []
-    };
+      "message": "Successfully highlighted matched columns.",
+      "notFoundColumns": missingCols || []
+    }
   }
+
   return {
     "message": "Successfully highlighted matched columns."
-  };
+  }
 }

scripts/tables/set-table-rows-height.ts

@@ -1,17 +1,17 @@
 /**
-  * Sets the row height for all rows in a table.
-  * 
-  * @param tableName Name of the table to modify
-  * @param rowHeight Height in points to apply to all table rows (defaults to 14.25)
-  */
+ * Sets the row height for all rows in a table.
+ * 
+ * @param tableName Name of the table to modify
+ * @param rowHeight Height in points to apply to all table rows (defaults to 14.25)
+ */
 function main(
   workbook: ExcelScript.Workbook,
   tableName: string,
   rowHeight?: number
 ) {
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   // use default row height unless provided

scripts/tables/sort-table-by-column-name.ts

@@ -11,14 +11,15 @@ function main(
 ) {
   const table = workbook.getTable(tableName);
   if (!table) {
-    throw new Error(`Table "${tableName}" not found.`);
+    throw new Error(`Table '${tableName}' not found.`);
   }
 
   // Get the column index based on the column name
   const columnIndex = table.getHeaderRowRange().getValues()[0].indexOf(columnName);
-  if (columnIndex !== -1) {
-    table.getSort().apply([{ key: columnIndex, ascending: true }]);
-  } else {
-    throw new Error(`Column "${columnName}" not found.`);
+
+  if (columnIndex === -1) {
+    throw new Error(`Column '${columnName}' not found.`);
   }
+
+  table.getSort().apply([{ key: columnIndex, ascending: true }]);
 }