builder.js

/* eslint-disable @typescript-eslint/no-require-imports */
/**
 * This is the builder.js file.
 * It is the entry point of the application.
 * Builds all necessary data for the web page to function.
 * Creates the text file to showcase all icons and zip all SVG icons.
 * * NB: This file must be run with Node.js after adding or removing icons.
 * @author Bolarinwa Olakunle
 */

const fs = require("fs");
const Zip = require("adm-zip");
const zipFile = new Zip();

// -------------- Runtime and processing -------------------

// Set defaults
const // main svg source
	source = "./public/svg/";
// data file
const // main svg source
	data = "./content/data.json";
// store category name, icons and total
const allData = [];
const // svg zip file
	refined = `${source}refinedicons-all.zip`;
const // folder-structure
	structure = `${source}folder-structure.txt`;

// A function to delete a file
async function deleteFiles(files) {
	for (const file of files) {
		fs.rmSync(file, { recursive: true, force: true });
	}
}

// Delete files and create a new generated zip file
deleteFiles([refined, structure])
	.then(() => {
		// read svg folder, store category and icons in an array
		fs.readdirSync(source).forEach((cat) => {
			const tmp = {};
			tmp.category = cat;
			tmp.icons = fs
				.readdirSync(source + cat)
				.map((file) => file.split(".").slice(0, -1).join("."));
			tmp.total = tmp.icons.length;
			allData.push(tmp);
		});
	})
	.then(() => {
		// save the data captured above in a JSON file with a success and error callback
		fs.writeFile(data, JSON.stringify(allData), "utf8", (err) => {
			if (err) {
				console.log(err);
			} else {
				console.log(`Saved data to ${data}`);
			}
		});
	})
	.then(() => {
		// Print and output svg folder structure to a text-file
		function printFolderStructure(path, prefix = "", isLast = true) {
			const files = fs.readdirSync(path);
			const arrows = isLast ? "└── " : "├── ";
			const output = [];
			const dirName = path.split("/").pop().toUpperCase();
			output.push(prefix + arrows + dirName);
			const newPrefix = isLast ? `${prefix}    ` : `${prefix}│   `;
			files.forEach((file, index) => {
				const filePath = `${path}/${file}`;
				const stats = fs.statSync(filePath);
				const isDirectory = stats.isDirectory();
				const newLast = index === files.length - 1;
				if (isDirectory) {
					output.push(printFolderStructure(filePath, newPrefix, newLast));
				} else {
					output.push(newPrefix + arrows + file);
				}
			});
			return output.join("\n");
		}

		const folderStructure = printFolderStructure(source);
		fs.writeFileSync(structure, folderStructure);
		console.log("Folder structure saved!");
	})
	.then(() => {
		// zip the svg folder
		zipFile.addLocalFolder(source);
		zipFile.writeZip(refined);
		console.log(`Zipped folder saved to ${refined}`);
	})
	.catch((error) => {
		console.error("Error:", error);
	});

// --------------- Debugging and test ----------------------

// console.log(JSON.stringify(allData));