mod-build 4.0.80-beta.6 → 4.0.80

package/CHANGELOG.md

@@ -2,8 +2,9 @@
 
 ## 4.0.80
 
-- Added `grab-global-fonts` task to grab Roboto + Montserrat font files from mod-site
-- Added `add-files-to-gitignore` helper task so we can call it whenever needed
+- Add `grab-jsdoc` task to serve process
+- Add `add-jsdocs-to-gitignore` task to automatically add JSDoc generated files (`jsdoc-types/` and `modform.jsdoc.js`) to `.gitignore`
+- Update `clean` task to remove JSDoc generated files (`./jsdoc-types` and `./modform.jsdoc.js`)
 
 ## 4.0.79
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mod-build",
-	"version": "4.0.80-beta.6",
+	"version": "4.0.80",
 	"description": "Share components for S3 sites.",
 	"type": "module",
 	"scripts": {

package/tasks/{add-files-to-gitignore.js → add-jsdocs-to-gitignore.js}

@@ -1,16 +1,16 @@
 import fs from 'node:fs';
 import path from 'node:path';
 
-/**
- * Adds entries to .gitignore file (always appends to bottom)
- * @param {string[]} entries - Array of entries to add to .gitignore
- * @param {string} comment - Optional comment to add before the entries
- * @returns {Promise<void>}
- */
-export default async function addFilesToGitignore(entries, comment) {
-	const gitignorePath = path.join(process.cwd(), '.gitignore');
+const entriesToAdd = [
+	'jsdoc-types/',
+	'modform.jsdoc.js'
+];
 
+export default async function addJsdocsToGitignore() {
+	const gitignorePath = path.join(process.cwd(), '.gitignore');
+	
 	let content = '';
+
 	try {
 		content = await fs.promises.readFile(gitignorePath, 'utf8');
 	} catch (err) {
@@ -20,10 +20,10 @@ export default async function addFilesToGitignore(entries, comment) {
 	}
 
 	const existingEntries = new Set(content.split('\n').map(line => line.trim()));
-	const entriesToAppend = entries.filter(entry => !existingEntries.has(entry));
+	const entriesToAppend = entriesToAdd.filter(entry => !existingEntries.has(entry));
 
 	if (entriesToAppend.length === 0) {
-		console.log('.gitignore already contains all entries');
+		console.log('.gitignore already contains jsdoc entries');
 		return;
 	}
 
@@ -32,12 +32,9 @@ export default async function addFilesToGitignore(entries, comment) {
 		? (content.endsWith('\n') ? '\n' : '\n\n')
 		: '';
 
-	if (comment) {
-		contentToAppend += `# ${comment}\n`;
-	}
+	contentToAppend += '# JSDoc generated files\n';
 	contentToAppend += entriesToAppend.join('\n') + '\n';
 
 	await fs.promises.appendFile(gitignorePath, contentToAppend, 'utf8');
 	console.log(`Added to .gitignore: ${entriesToAppend.join(', ')}`);
 }
-

package/tasks/clean.js

@@ -1,6 +1,8 @@
 import fs from 'fs';
 
-const foldersToDelete = ['./src/resources', './src/accessible-components', './src/shared-components', './src/.tmp', './src/temp', './public/resources', './public/fonts/montserrat', './public/fonts/roboto'];
+const foldersToDelete = ['./src/resources', './src/accessible-components', './src/shared-components', './src/.tmp', './src/temp', './public/resources', './jsdoc-types'];
+
+const filesToDelete = ['./modform.jsdoc.js'];
 
 foldersToDelete.forEach(async (folder) => {
 	try {
@@ -10,3 +12,12 @@ foldersToDelete.forEach(async (folder) => {
 		// fail silently
 	}
 });
+
+filesToDelete.forEach(async (file) => {
+	try {
+		await fs.promises.rm(file);
+		console.log(`File ${file} deleted successfully`);
+	} catch (err) {
+		// fail silently
+	}
+});

package/tasks/grab-jsdoc.js

@@ -0,0 +1,111 @@
+import { defaultSettings } from '../src/data/config.js';
+import axios from 'axios';
+import fs, { createWriteStream } from 'node:fs';
+import * as stream from 'node:stream';
+import { promisify } from 'node:util';
+import path from 'node:path';
+import { responseInterceptor } from '../src/scripts/retry-axios.js';
+import addJSDocsToGitignore from './add-jsdocs-to-gitignore.js';
+
+const resourcePath = 'quote/resources/mod-form/form';
+const axiosInstance = axios.create();
+const jsdocAxiosInstance = axios.create();
+responseInterceptor(axiosInstance);
+responseInterceptor(jsdocAxiosInstance);
+
+// Helper to stream a JSDoc file to the destination directory
+const streamToDestination = async (filePath) => {
+	if (!filePath) {
+		return false;
+	}
+
+	const finished = promisify(stream.finished);
+	// Add cachebuster to avoid server/browser caching issues
+	const cachebuster = Math.round(Date.now() / 1000);
+	const url = `https://${defaultSettings.nodeEnv}/${resourcePath}/${filePath}?cb=${cachebuster}`;
+	const fileName = path.basename(filePath);
+	const dirPath = path.dirname(filePath);
+
+	// Create directory if it doesn't exist
+	if (dirPath !== '.' && !fs.existsSync(dirPath)) {
+		fs.mkdirSync(dirPath, { recursive: true });
+	}
+
+	const fileFullPath = path.join(dirPath, fileName);
+
+	// if file exists, do not create it again
+	if (fs.existsSync(fileFullPath)) {
+		return;
+	}
+
+	const writer = createWriteStream(fileFullPath);
+	const options = {
+		url,
+		method: 'get',
+		responseType: 'stream'
+	};
+
+	try {
+		const resp = await axiosInstance(options);
+
+		if (resp.status !== 200) {
+			throw new Error(`${resp.status}: Error while fetching ${url}`);
+		}
+
+		resp.data.pipe(writer);
+		console.log(`${fileFullPath} created...`);
+		await finished(writer);
+	} catch (error) {
+		console.error(error);
+		process.exit(1);
+	} finally {
+		axiosInstance.interceptors.response.eject(responseInterceptor);
+	}
+}
+
+async function getJSDocFiles() {
+	// Add cachebuster to avoid server/browser caching issues
+	const cachebuster = Math.round(Date.now() / 1000);
+	const options = {
+		url: `https://${defaultSettings.nodeEnv}/${resourcePath}/jsdoc.json?cb=${cachebuster}`,
+		method: 'get'
+	}
+
+	try {
+		const resp = await jsdocAxiosInstance(options);
+
+		if (resp.status !== 200) {
+			throw new Error(`${resp.status}: Error while fetching ${options.url}`);
+		}
+
+		// axios may parse JSON automatically, so check if it's already an object
+		if (typeof resp.data === 'string') {
+			return JSON.parse(resp.data);
+		}
+
+		return resp.data;
+	} catch (error) {
+		console.error(error);
+		throw error;
+	} finally {
+		jsdocAxiosInstance.interceptors.response.eject(responseInterceptor);
+	}
+}
+
+export default async function grabJSDoc() {
+	const { nodeEnv, isLocal } = defaultSettings;
+
+	if (!isLocal) {
+		return;
+	}
+
+	if (!nodeEnv) {
+		throw new Error('Missing environment variables. Did you start with gulp instead of npm run...?');
+	}
+
+	const files = await getJSDocFiles();
+	const filesPromiseMap = files.map(filePath => streamToDestination(filePath));
+	await Promise.all(filesPromiseMap);
+	await addJSDocsToGitignore();
+}
+

package/tasks/serve.js

@@ -1,24 +1,24 @@
 import addEditorConfig from './add-editorconfig.js';
-import grabGlobalFonts from './grab-global-fonts.js';
 import grabSharedComponents from './grab-shared-components.js';
 import grabSharedScripts from './grab-shared-scripts.js';
 import grabCdn from './grab-cdn.js';
 import grabB2BData from './grab-b2b-data.js';
 import getDefaultTradeQuestions from './get-default-trade-questions.js';
 import grabFormHelpers from './grab-form-helpers.js';
+import grabJSDoc from './grab-jsdoc.js';
 import templates from './templates.js';
 import { createStylelintFile, updateConfig } from '../src/scripts/plugins.js';
 
 export async function startModBuild(config) {
 	addEditorConfig();
 	createStylelintFile();
-	grabGlobalFonts();
 	await grabB2BData(config);
 	await grabCdn(config);
 	await getDefaultTradeQuestions(config);
 	await Promise.all([
 		grabSharedComponents(config),
 		grabFormHelpers(config),
+		grabJSDoc(),
 		templates(config)
 	]).then(async () => {
 		await grabSharedScripts(config);

package/tasks/grab-global-fonts.js

@@ -1,97 +0,0 @@
-import { defaultSettings } from '../src/data/config.js';
-import axios from 'axios';
-import { createWriteStream } from 'node:fs';
-import * as stream from 'node:stream';
-import { promisify } from 'node:util';
-import fs from 'node:fs';
-import { responseInterceptor } from '../src/scripts/retry-axios.js';
-import addFilesToGitignore from './add-files-to-gitignore.js';
-
-const resourcePath = 'quote/resources/mod-site/fonts';
-
-// Global font names
-const fontNames = [
-	'roboto',
-	'montserrat'
-];
-
-// Font variants and extensions to download for each font
-const fontVariants = ['regular', 'bold'];
-const fontExtensions = ['ttf', 'woff2'];
-
-// Generate array of all font files needed for download
-const fontFiles = fontNames.flatMap(fontName => {
-	return fontVariants.flatMap(variant => {
-		return fontExtensions.map(ext => {
-			return `${fontName}/${fontName}-${variant}.${ext}`;
-		});
-	});
-});
-
-const axiosInstance = axios.create();
-responseInterceptor(axiosInstance);
-
-const streamFontToDestination = (defaultSettings, fontPath) => {
-	const finished = promisify(stream.finished);
-
-	return new Promise(resolve => {
-		const filePath = `${defaultSettings.publicFolder}/${defaultSettings.fontsSubfolder}/${fontPath}`;
-		const folderPath = filePath.split('/').slice(0, -1).join('/');
-
-		// Create directory if it doesn't exist
-		if (!fs.existsSync(folderPath)) {
-			fs.mkdirSync(folderPath, { recursive: true });
-		}
-
-		// if file exists, do not create it again
-		if (fs.existsSync(filePath)) {
-			resolve();
-		} else {
-			const writer = createWriteStream(filePath);
-			const options = {
-				url: `https://${defaultSettings.nodeEnv}/${resourcePath}/${fontPath}`,
-				method: 'get',
-				responseType: 'stream'
-			};
-
-			axios(options).then(resp => {
-				if (resp.status !== 200) {
-					throw new Error(`${resp.status}: Error while fetching ${options.url}`);
-				}
-				console.log(`${filePath} copied...`);
-				resp.data.pipe(writer);
-				return finished(writer);
-			}).then(() => {
-				resolve();
-			}).catch(error => {
-				console.error(error);
-				throw new Error(`${error?.response?.statusText} [${error?.status}]: Error while fetching ${options.url}`);
-			});
-		}
-	});
-};
-
-const updateGitignore = async () => {
-	const fontEntries = fontNames.map(fontName => 
-		`${defaultSettings.publicFolder}/${defaultSettings.fontsSubfolder}/${fontName}/`
-	);
-	
-	await addFilesToGitignore(fontEntries, 'Global fonts');
-};
-
-export default function() {
-	const fontsPath = `${defaultSettings.publicFolder}/${defaultSettings.fontsSubfolder}`;
-	if (!fs.existsSync(fontsPath)) {
-		fs.mkdirSync(fontsPath, { recursive: true });
-	}
-
-	// Download all font files
-	const fontPromises = fontFiles.map(fontPath => {
-		return streamFontToDestination(defaultSettings, fontPath);
-	});
-
-	return Promise.all(fontPromises).then(async () => {
-		// Update .gitignore after fonts are downloaded
-		await updateGitignore();
-	});
-}