Clean up data in a Google Sheets spreadsheet

// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/add-ons/clean-sheet
/*
Copyright 2022 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Application Constants
constAPP_TITLE='Clean sheet';
/**
 * Identifies and deletes empty rows in selected range of active sheet.
 * 
 * Cells that contain space characters are treated as non-empty.
 * The entire row, including the cells outside of the selected range,
 * must be empty to be deleted.
 * 
 * Called from menu option.
 */
functiondeleteEmptyRows(){
constsheet=SpreadsheetApp.getActiveSheet();
// Gets active selection and dimensions.
letactiveRange=sheet.getActiveRange();
constrowCount=activeRange.getHeight();
constfirstActiveRow=activeRange.getRow();
constcolumnCount=sheet.getMaxColumns();
// Tests that the selection is a valid range.
if(rowCount < 1){
showMessage('Select a valid range.');
return;
}
// Tests active range isn't too large to process. Enforces limit set to 10k.
if(rowCount > 10000){
showMessage("Selected range too large. Select up to 10,000 rows at one time.");
return;
}
// Utilizes an array of values for efficient processing to determine blank rows.
constactiveRangeValues=sheet.getRange(firstActiveRow,1,rowCount,columnCount).getValues();
// Checks if array is all empty values.
constvalueFilter=value=>value!=='';
constisRowEmpty=(row)=>{
returnrow.filter(valueFilter).length===0;
}
// Maps the range values as an object with value (to test) and corresponding row index (with offset from selection).
constrowsToDelete=activeRangeValues.map((row,index)=>({row,offset:index+activeRange.getRowIndex()}))
.filter(item=>isRowEmpty(item.row))// Test to filter out non-empty rows.
.map(item=>item.offset);//Remap to include just the row indexes that will be removed.
// Combines a sorted, ascending list of indexes into a set of ranges capturing consecutive values as start/end ranges.
// Combines sequential empty rows for faster processing.
constrangesToDelete=rowsToDelete.reduce((ranges,index)=>{
constcurrentRange=ranges[ranges.length-1];
if(currentRange && index===currentRange[1]+1){
currentRange[1]=index;
returnranges;
}
ranges.push([index,index]);
returnranges;
},[]);
// Sends a list of row indexes to be deleted to the console.
console.log(rangesToDelete);
// Deletes the rows using REVERSE order to ensure proper indexing is used.
rangesToDelete.reverse().forEach(([start,end])=>sheet.deleteRows(start,end-start+1));
SpreadsheetApp.flush();
}
/**
 * Removes blank columns in a selected range.
 * 
 * Cells containing Space characters are treated as non-empty.
 * The entire column, including cells outside of the selected range,
 * must be empty to be deleted.
 * 
 * Called from menu option.
 */
functiondeleteEmptyColumns(){
constsheet=SpreadsheetApp.getActiveSheet();
// Gets active selection and dimensions.
letactiveRange=sheet.getActiveRange();
constrowCountMax=sheet.getMaxRows();
constcolumnWidth=activeRange.getWidth();
constfirstActiveColumn=activeRange.getColumn();
// Tests that the selection is a valid range.
if(columnWidth < 1){
showMessage('Select a valid range.');
return;
}
// Tests active range is not too large to process. Enforces limit set to 1k.
if(columnWidth > 1000){
showMessage("Selected range too large. Select up to 10,000 rows at one time.");
return;
}
// Utilizes an array of values for efficient processing to determine blank columns.
constactiveRangeValues=sheet.getRange(1,firstActiveColumn,rowCountMax,columnWidth).getValues();
// Transposes the array of range values so it can be processed in order of columns.
constactiveRangeValuesTransposed=activeRangeValues[0].map((_,colIndex)=>activeRangeValues.map(row=>row[colIndex]));
// Checks if array is all empty values.
constvalueFilter=value=>value!=='';
constisColumnEmpty=(column)=>{
returncolumn.filter(valueFilter).length===0;
}
// Maps the range values as an object with value (to test) and corresponding column index (with offset from selection).
constcolumnsToDelete=activeRangeValuesTransposed.map((column,index)=>({column,offset:index+firstActiveColumn}))
.filter(item=>isColumnEmpty(item.column))// Test to filter out non-empty rows.
.map(item=>item.offset);//Remap to include just the column indexes that will be removed.
// Combines a sorted, ascending list of indexes into a set of ranges capturing consecutive values as start/end ranges.
// Combines sequential empty columns for faster processing.
constrangesToDelete=columnsToDelete.reduce((ranges,index)=>{
constcurrentRange=ranges[ranges.length-1];
if(currentRange && index===currentRange[1]+1){
currentRange[1]=index;
returnranges;
}
ranges.push([index,index]);
returnranges;
},[]);
// Sends a list of column indexes to be deleted to the console.
console.log(rangesToDelete);
// Deletes the columns using REVERSE order to ensure proper indexing is used.
rangesToDelete.reverse().forEach(([start,end])=>sheet.deleteColumns(start,end-start+1));
SpreadsheetApp.flush();
}
/**
 * Trims all of the unused rows and columns outside of selected data range.
 * 
 * Called from menu option.
 */
functioncropSheet(){
constdataRange=SpreadsheetApp.getActiveSheet().getDataRange();
constsheet=dataRange.getSheet();
letnumRows=dataRange.getNumRows();
letnumColumns=dataRange.getNumColumns();
constmaxRows=sheet.getMaxRows();
constmaxColumns=sheet.getMaxColumns();
constnumFrozenRows=sheet.getFrozenRows();
constnumFrozenColumns=sheet.getFrozenColumns();
// If last data row is less than maximium row, then deletes rows after the last data row.
if(numRows < maxRows){
numRows=Math.max(numRows,numFrozenRows+1);// Don't crop empty frozen rows.
sheet.deleteRows(numRows+1,maxRows-numRows);
}
// If last data column is less than maximium column, then deletes columns after the last data column.
if(numColumns < maxColumns){
numColumns=Math.max(numColumns,numFrozenColumns+1);// Don't crop empty frozen columns.
sheet.deleteColumns(numColumns+1,maxColumns-numColumns);
}
}
/**
 * Copies value of active cell to the blank cells beneath it. 
 * Stops at last row of the sheet's data range if only blank cells are encountered.
 * 
 * Called from menu option.
 */
functionfillDownData(){
constsheet=SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Gets sheet's active cell and confirms it's not empty.
constactiveCell=sheet.getActiveCell();
constactiveCellValue=activeCell.getValue();
if(!activeCellValue){
showMessage("The active cell is empty. Nothing to fill.");
return;
}
// Gets coordinates of active cell.
constcolumn=activeCell.getColumn();
constrow=activeCell.getRow();
// Gets entire data range of the sheet.
constdataRange=sheet.getDataRange();
constdataRangeRows=dataRange.getNumRows();
// Gets trimmed range starting from active cell to the end of sheet data range.
constsearchRange=dataRange.offset(row-1,column-1,dataRangeRows-row+1,1)
constsearchValues=searchRange.getDisplayValues();
// Find the number of empty rows below the active cell.
leti=1;// Start at 1 to skip the ActiveCell.
while(searchValues[i] && searchValues[i][0]==""){i++;}
// If blanks exist, fill the range with values.
if(i > 1){
constfillRange=searchRange.offset(0,0,i,1).setValue(activeCellValue)
//sheet.setActiveRange(fillRange) // Uncomment to test affected range.
}
else{
showMessage("There are no empty cells below the Active Cell to fill.");
}
}
/**
 * A helper function to display messages to user.
 * 
 * @param {string} message - Message to be displayed.
 * @param {string} caller - {Optional} text to append to title.
 */
functionshowMessage(message,caller){
// Sets the title using the APP_TITLE variable; adds optional caller string.
consttitle=APP_TITLE
if(caller!=null){
title+=` : ${caller}`
};
constui=SpreadsheetApp.getUi();
ui.alert(title,message,ui.ButtonSet.OK);
}

/**
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * Creates a menu entry in the Google Sheets Extensions menu when the document is opened.
 *
 * @param {object} e The event parameter for a simple onOpen trigger. 
 */
functiononOpen(e){
// Builds a menu that displays under the Extensions menu in Sheets.
letmenu=SpreadsheetApp.getUi().createAddonMenu()
menu
.addItem('Delete blank rows (from selected rows only)','deleteEmptyRows')
.addItem('Delete blank columns (from selected columns only)','deleteEmptyColumns')
.addItem('Crop sheet to data range','cropSheet')
.addSeparator()
.addItem('Fill in blank rows below','fillDownData')
.addSeparator()
.addItem('About','aboutApp')
.addToUi();
}
/**
 * Runs when the add-on is installed; calls onOpen() to ensure menu creation and
 * any other initializion work is done immediately. This method is only used by 
 * the desktop add-on and is never called by the mobile version.
 *
 * @param {object} e The event parameter for a simple onInstall trigger. 
 */
functiononInstall(e){
onOpen(e);
}
/**
 * About box for context and developer contact information.
 * TODO: Personalize
 */
functionaboutApp(){
constmsg=`
 Name: ${APP_TITLE}
 Version: 1.0
 Contact: <Developer Email Goes Here>`
constui=SpreadsheetApp.getUi();
ui.alert("About this application",msg,ui.ButtonSet.OK);
}