@awesomeness-js/utils 1.0.25 → 1.1.3

package/src/utils/generateFile.js

@@ -5,11 +5,23 @@ import generateFlatExportLines from './generateFlatExportLines.js';
 import generateNamespaceExportLines from './generateNamespaceExportLines.js';
 import generateNamedExports from './generateNamedExports.js';
 
-export default function generateFile(src, exportRoots, ignore, includeComments, dts, useTabs = true) {
+export default function generateFile({
+	src, 
+	exportRoots, 
+	ignore, 
+	includeComments, 
+	dts, 
+	useTabs = true
+}) {
 
-	const fileDataList = buildFileDataList(src, ignore, includeComments);
+	const fileDataList = buildFileDataList({
+		src,
+		ignore,
+		includeComments
+	});
 	const {
-		flatExports, nestedExports 
+		flatExports, 
+		nestedExports 
 	} = buildExportsTree(fileDataList);
 	const headerComment = `/**
  * This file is auto-generated by the build script.
@@ -17,16 +29,38 @@ export default function generateFile(src, exportRoots, ignore, includeComments,
  * Do not edit manually.
  */
 `;
-	const importStatements = generateImportStatements(fileDataList, dts, src);
-	const flatExportLines = generateFlatExportLines(flatExports, exportRoots, includeComments, dts, useTabs);
-	const namespaceExportLines = generateNamespaceExportLines(nestedExports, includeComments, dts, useTabs);
+	const importStatements = generateImportStatements({
+		fileDataList,
+		dts,
+		src
+	});
+
+	const flatExportLines = generateFlatExportLines({
+		flatExports,
+		exportRoots,
+		includeComments,
+		dts,
+		useTabs
+	});
+
+	const namespaceExportLines = generateNamespaceExportLines({
+		nestedExports,
+		includeComments,
+		dts,
+		useTabs
+	});
 	
 	const defaultExportCode = dts
 		? `declare const _default: {\n${flatExportLines}${namespaceExportLines}};\n\nexport default _default;\n`
 		: `export default {\n${flatExportLines}${namespaceExportLines}};`;
 
-	const namedExports = generateNamedExports(flatExports, exportRoots, dts);
-
+	const namedExports = generateNamedExports({
+		nestedExports,
+		flatExports,
+		exportRoots,
+		dts,
+		useTabs
+	});
     
 	return headerComment +
            importStatements + '\n' +

package/src/utils/generateFlatExportLines.js

@@ -1,4 +1,10 @@
-export default function generateFlatExportLines(flatExports, exportRoots, includeComments, dts, useTabs = true) {
+export default function generateFlatExportLines({
+	flatExports, 
+	exportRoots, 
+	includeComments, 
+	dts, 
+	useTabs = true
+}) {
 
 	let indentStyle = useTabs ? '\t' : '    ';
 

package/src/utils/generateImportStatements.js

@@ -1,4 +1,8 @@
-export default function generateImportStatements(fileDataList, dts, src) {
+export default function generateImportStatements({
+	fileDataList, 
+	dts, 
+	src
+}) {
 
 	let statements = '';
 

package/src/utils/generateNamedExports.js

@@ -1,19 +1,53 @@
-export default function generateNamedExports(flatExports, exportRoots, dts) {
+export default function generateNamedExports({
+	flatExports,
+	exportRoots,
+	nestedExports,
+	dts,
+	useTabs = true
+}) {
 
+	const indentStyle = useTabs ? '\t' : '    ';
 	let lines = '';
 
+	if (!exportRoots) return lines;
 
-	if (exportRoots) {
+	// existing flat exports
+	flatExports.forEach(({
+		functionName, importVarName 
+	}) => {
 
-		flatExports.forEach(({
-			functionName, importVarName 
-		}) => {
+		lines += dts
+			? `export declare const ${functionName}: typeof ${importVarName};\n`
+			: `export { ${importVarName} as ${functionName} };\n`;
+	
+	});
+
+	// grouped namespaces as named exports
+	if (nestedExports) {
+
+		lines += '\n';
+
+		for (const [ groupName, members ] of Object.entries(nestedExports)) {
+
+			if (dts) {
+
+				const fields = Object.entries(members)
+					.map(([ k, v ]) => `${indentStyle}${k}: typeof ${v.importVarName};`)
+					.join('\n');
+
+				lines += `export declare const ${groupName}: {\n${fields}\n};\n\n`;
+			
+			} else {
+
+				const fields = Object.entries(members)
+					.map(([ k, v ]) => `${indentStyle}${k}: ${v.importVarName}`)
+					.join(',\n');
 
-			lines += dts
-				? `export declare const ${functionName}: typeof ${importVarName};\n`
-				: `export { ${importVarName} as ${functionName} };\n`;
+				lines += `export const ${groupName} = {\n${fields}\n};\n\n`;
+			
+			}
 		
-		});
+		}
 	
 	}
 

package/src/utils/generateNamespaceCode.js

@@ -1,4 +1,10 @@
-export default function generateNamespaceCode(nsObj, indentLevel, includeComments, dts, useTabs = true) {
+export default function generateNamespaceCode({
+	nsObj, 
+	indentLevel, 
+	includeComments, 
+	dts, 
+	useTabs = true
+}) {
 
 	let indentStyle = useTabs ? '\t' : '    ';
 
@@ -31,7 +37,12 @@ export default function generateNamespaceCode(nsObj, indentLevel, includeComment
 		
 		} else {
 
-			const nestedCode = generateNamespaceCode(value, indentLevel + 1, includeComments, dts);
+			const nestedCode = generateNamespaceCode({
+				nsObj: value,
+				indentLevel: indentLevel + 1,
+				includeComments,
+				dts
+			});
 
 			lines.push(`${indent}${indentStyle}${key}: ${nestedCode},`);
 		

package/src/utils/generateNamespaceExportLines.js

@@ -1,6 +1,11 @@
 import generateNamespaceCode from './generateNamespaceCode.js';
 
-export default function generateNamespaceExportLines(nestedExports, includeComments, dts, useTabs = true) {
+export default function generateNamespaceExportLines({
+	nestedExports, 
+	includeComments, 
+	dts, 
+	useTabs = true
+}) {
 
 	const indentStyle = useTabs ? '\t' : '    ';
 
@@ -8,7 +13,13 @@ export default function generateNamespaceExportLines(nestedExports, includeComme
 
 	for (const ns in nestedExports) {
 
-		const nsCode = generateNamespaceCode(nestedExports[ns], 1, includeComments, dts, useTabs);
+		const nsCode = generateNamespaceCode({
+			nsObj: nestedExports[ns],
+			indentLevel: 1,
+			includeComments,
+			dts,
+			useTabs
+		});
 
 		lines += `${indentStyle}${ns}: ${nsCode},\n`;
 

package/src/utils/writeHotWrapper.js

@@ -0,0 +1,42 @@
+import { writeFileSync } from 'node:fs';
+
+export default function writeHotWrapper({
+	dest, 
+	hotSource 
+}) {
+
+	const wrapper = `// auto-generated wrapper
+import chokidar from 'chokidar';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+
+let _default;
+
+export { _default as default };
+
+const target = path.resolve(${JSON.stringify(hotSource)});
+
+async function reload() {
+
+	const mod = await import(\`\${pathToFileURL(target)}?t=\${Date.now()}\`);
+
+	_default = mod.default;
+	console.log('[hot] reloaded', target);
+
+}
+
+await reload();
+
+let t;
+
+chokidar.watch(target, { ignoreInitial: true }).on('all', () => {
+
+	clearTimeout(t);
+	t = setTimeout(() => reload().catch(err => console.error('[hot] failed:', err)), 50);
+
+});
+`;
+
+	writeFileSync(dest, wrapper);
+
+}

package/tests/ignore.test.js

@@ -0,0 +1,55 @@
+// example.test.js
+import {
+	expect, test, describe 
+} from 'vitest';
+import utils from '../index.js';
+
+
+describe('shouldIgnore', () => {
+
+	test('exact file match (case-insensitive)', () => {
+
+		expect(utils.shouldIgnore('/src/ignoreMe.js', [ 'ignoreMe.js' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/IGNOREME.JS', [ 'ignoreMe.js' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/notIgnoreMe.js', [ 'ignoreMe.js' ])).toBe(false);
+
+	});
+
+	test('ignore all in folder/* immediate children only', () => {
+
+		expect(utils.shouldIgnore('/src/ignoreFolder/file.js', [ 'ignoreFolder/*' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/ignoreFolder/nested/file.js', [ 'ignoreFolder/*' ])).toBe(false);
+
+	});
+
+	test('ignore all with extension (*.js)', () => {
+
+		expect(utils.shouldIgnore('/src/file.js', [ '*.js' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/deep/file.js', [ '*.js' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/file.ts', [ '*.js' ])).toBe(false);
+
+	});
+
+	test('ignore only specific extension in folder (folder/*.js)', () => {
+
+		expect(utils.shouldIgnore('/src/css/style.js', [ 'css/*.js' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/css/nested/style.js', [ 'css/*.js' ])).toBe(false);
+		expect(utils.shouldIgnore('/src/css/style.css', [ 'css/*.js' ])).toBe(false);
+
+	});
+
+	test('ignore whole directory (folder)', () => {
+
+		expect(utils.shouldIgnore('/src/namespaceExample/file.js', [ 'namespaceExample' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/namespaceExample/nested/file.js', [ 'namespaceExample' ])).toBe(true);
+		expect(utils.shouldIgnore('/src/namespaceExampleFile.js', [ 'namespaceExample' ])).toBe(false);
+
+	});
+
+	test('mixed case patterns still match paths', () => {
+
+		expect(utils.shouldIgnore('/src/SomeFolder/File.JS', [ 'somefolder/*' ])).toBe(true);
+	
+	});
+
+});

package/tests/namedExports.test.js

@@ -0,0 +1,13 @@
+// example.test.js
+import {
+	expect, test 
+} from 'vitest';
+
+import { password } from '../index.js';
+
+test('test named export', () => {
+
+	expect(password.check).toBeDefined();
+	expect(password.hash).toBeDefined();
+
+});

package/types/build.d.ts

@@ -1,9 +1,13 @@
 export default build;
-declare function build({ src, dest, exportRoots, ignore, includeComments, dts }?: {
+declare function build({ src, dest, exportRoots, ignore, includeComments, dts, useTabs, hotModuleReload, hotCallback, hotSource }?: {
     src?: string;
     dest?: string;
     exportRoots?: boolean;
     ignore?: any[];
     includeComments?: boolean;
     dts?: boolean;
+    useTabs?: boolean;
+    hotModuleReload?: boolean;
+    hotCallback?: any;
+    hotSource?: string;
 }): Promise<boolean>;

package/types/index.d.ts

@@ -20,13 +20,12 @@ import type _each from './each';
 import type _eachAsync from './eachAsync';
 import type _encrypt from './encrypt';
 import type _getAllFiles from './getAllFiles';
-import type _ignoreFolder_ignoreMe from './ignoreFolder/ignoreMe';
-import type _ignoreMe from './ignoreMe';
 import type _isUUID from './isUUID';
 import type _md5 from './md5';
 import type _password_check from './password/check';
 import type _password_hash from './password/hash';
 import type _setLocalEnvs from './setLocalEnvs';
+import type _shouldIgnore from './shouldIgnore';
 import type _thingType from './thingType';
 import type _toPennies from './toPennies';
 import type _utils_buildExportsTree from './utils/buildExportsTree';
@@ -39,7 +38,7 @@ import type _utils_generateImportStatements from './utils/generateImportStatemen
 import type _utils_generateNamedExports from './utils/generateNamedExports';
 import type _utils_generateNamespaceCode from './utils/generateNamespaceCode';
 import type _utils_generateNamespaceExportLines from './utils/generateNamespaceExportLines';
-import type _utils_shouldIgnore from './utils/shouldIgnore';
+import type _utils_writeHotWrapper from './utils/writeHotWrapper';
 import type _uuid from './uuid';
 import type _validateSchema from './validateSchema';
 
@@ -52,91 +51,119 @@ export declare const each: typeof _each;
 export declare const eachAsync: typeof _eachAsync;
 export declare const encrypt: typeof _encrypt;
 export declare const getAllFiles: typeof _getAllFiles;
-export declare const ignoreMe: typeof _ignoreMe;
 export declare const isUUID: typeof _isUUID;
 export declare const md5: typeof _md5;
 export declare const setLocalEnvs: typeof _setLocalEnvs;
+export declare const shouldIgnore: typeof _shouldIgnore;
 export declare const thingType: typeof _thingType;
 export declare const toPennies: typeof _toPennies;
 export declare const uuid: typeof _uuid;
 export declare const validateSchema: typeof _validateSchema;
 
+export declare const clean: {
+	array: typeof _clean_array;
+	boolean: typeof _clean_boolean;
+	integer: typeof _clean_integer;
+	number: typeof _clean_number;
+	object: typeof _clean_object;
+	string: typeof _clean_string;
+	timestamp: typeof _clean_timestamp;
+	uuid: typeof _clean_uuid;
+};
+
+export declare const password: {
+	check: typeof _password_check;
+	hash: typeof _password_hash;
+};
+
+export declare const utils: {
+	buildExportsTree: typeof _utils_buildExportsTree;
+	buildFileDataList: typeof _utils_buildFileDataList;
+	clean: typeof _utils_clean;
+	extractJSDocComment: typeof _utils_extractJSDocComment;
+	generateFile: typeof _utils_generateFile;
+	generateFlatExportLines: typeof _utils_generateFlatExportLines;
+	generateImportStatements: typeof _utils_generateImportStatements;
+	generateNamedExports: typeof _utils_generateNamedExports;
+	generateNamespaceCode: typeof _utils_generateNamespaceCode;
+	generateNamespaceExportLines: typeof _utils_generateNamespaceExportLines;
+	writeHotWrapper: typeof _utils_writeHotWrapper;
+};
+
+
 declare const _default: {
-    /**
-     * Builds a file from the specified source directory and writes it to the destination file.
-     *
-     * @param {Object} options - The options for the build process.
-     * @param {string} [options.src='./src'] - The source directory to build from.
-     * @param {string} [options.dest='./index.js'] - The destination file to write the built content to.
-     * @param {boolean} [options.exportRoots=true] - Whether to export root files.
-     * @param {string[]} [options.ignore=[]] - An array of file patterns to ignore.
-     * @param {boolean} [options.includeComments=true] - Whether to include comments in the generated file.
-     * @param {boolean} [options.dts=false] - Whether to generate TypeScript declaration files.
-     * @returns {Promise<boolean>} A promise that resolves to true when the build is complete.
-     */
-    build: typeof _build;
-    collectImports: typeof _collectImports;
-    combineFiles: typeof _combineFiles;
-    /**
-     * Converts a given number of bytes into a more readable string format with appropriate units.
-     *
-     * @param {number} bytes - The number of bytes to convert.
-     * @param {number} [precision=2] - The number of decimal places to include in the result.
-     * @returns {string} The converted bytes in a string format with appropriate units.
-     */
-    convertBytes: typeof _convertBytes;
-    decrypt: typeof _decrypt;
-    /**
-     * Iterates over elements of an array or properties of an object, invoking a callback for each element/property.
-     * The iteration stops if the callback returns `false`.
-     *
-     * @example each({ a: 1, b: 2 }, (value, key) => { console.log(value, key); });
-     * @param {Object|Array} objectOrArray - The object or array to iterate over.
-     * @param {Function} callback - The function to invoke per iteration. It is invoked with two arguments: (value, key/index).
-     * @returns {void}
-     */
-    each: typeof _each;
-    eachAsync: typeof _eachAsync;
-    encrypt: typeof _encrypt;
-    getAllFiles: typeof _getAllFiles;
-    ignoreMe: typeof _ignoreMe;
-    isUUID: typeof _isUUID;
-    md5: typeof _md5;
-    setLocalEnvs: typeof _setLocalEnvs;
-    thingType: typeof _thingType;
-    toPennies: typeof _toPennies;
-    uuid: typeof _uuid;
-    validateSchema: typeof _validateSchema;
-    clean: {
-        array: typeof _clean_array,
-        boolean: typeof _clean_boolean,
-        integer: typeof _clean_integer,
-        number: typeof _clean_number,
-        object: typeof _clean_object,
-        string: typeof _clean_string,
-        timestamp: typeof _clean_timestamp,
-        uuid: typeof _clean_uuid,
-    },
-    ignoreFolder: {
-        ignoreMe: typeof _ignoreFolder_ignoreMe,
-    },
-    password: {
-        check: typeof _password_check,
-        hash: typeof _password_hash,
-    },
-    utils: {
-        buildExportsTree: typeof _utils_buildExportsTree,
-        buildFileDataList: typeof _utils_buildFileDataList,
-        clean: typeof _utils_clean,
-        extractJSDocComment: typeof _utils_extractJSDocComment,
-        generateFile: typeof _utils_generateFile,
-        generateFlatExportLines: typeof _utils_generateFlatExportLines,
-        generateImportStatements: typeof _utils_generateImportStatements,
-        generateNamedExports: typeof _utils_generateNamedExports,
-        generateNamespaceCode: typeof _utils_generateNamespaceCode,
-        generateNamespaceExportLines: typeof _utils_generateNamespaceExportLines,
-        shouldIgnore: typeof _utils_shouldIgnore,
-    },
+	/**
+	 * Builds a file from the specified source directory and writes it to the destination file.
+	 *
+	 * @param {Object} options - The options for the build process.
+	 * @param {string} [options.src='./src'] - The source directory to build from.
+	 * @param {string} [options.dest='./index.js'] - The destination file to write the built content to.
+	 * @param {boolean} [options.exportRoots=true] - Whether to export root files.
+	 * @param {string[]} [options.ignore=[]] - An array of file patterns to ignore.
+	 * @param {boolean} [options.includeComments=true] - Whether to include comments in the generated file.
+	 * @param {boolean} [options.dts=false] - Whether to generate TypeScript declaration files.
+	 * @returns {Promise<boolean>} A promise that resolves to true when the build is complete.
+	 */
+	build: typeof _build;
+	collectImports: typeof _collectImports;
+	combineFiles: typeof _combineFiles;
+	/**
+	 * Converts a given number of bytes into a more readable string format with appropriate units.
+	 *
+	 * @param {number} bytes - The number of bytes to convert.
+	 * @param {number} [precision=2] - The number of decimal places to include in the result.
+	 * @returns {string} The converted bytes in a string format with appropriate units.
+	 */
+	convertBytes: typeof _convertBytes;
+	decrypt: typeof _decrypt;
+	/**
+	 * Iterates over elements of an array or properties of an object, invoking a callback for each element/property.
+	 * The iteration stops if the callback returns `false`.
+	 *
+	 * @example each({ a: 1, b: 2 }, (value, key) => { console.log(value, key); });
+	 * @param {Object|Array} objectOrArray - The object or array to iterate over.
+	 * @param {Function} callback - The function to invoke per iteration. It is invoked with two arguments: (value, key/index).
+	 * @returns {void}
+	 */
+	each: typeof _each;
+	eachAsync: typeof _eachAsync;
+	encrypt: typeof _encrypt;
+	getAllFiles: typeof _getAllFiles;
+	isUUID: typeof _isUUID;
+	md5: typeof _md5;
+	setLocalEnvs: typeof _setLocalEnvs;
+	shouldIgnore: typeof _shouldIgnore;
+	thingType: typeof _thingType;
+	toPennies: typeof _toPennies;
+	uuid: typeof _uuid;
+	validateSchema: typeof _validateSchema;
+	clean: {
+		array: typeof _clean_array,
+		boolean: typeof _clean_boolean,
+		integer: typeof _clean_integer,
+		number: typeof _clean_number,
+		object: typeof _clean_object,
+		string: typeof _clean_string,
+		timestamp: typeof _clean_timestamp,
+		uuid: typeof _clean_uuid,
+	},
+	password: {
+		check: typeof _password_check,
+		hash: typeof _password_hash,
+	},
+	utils: {
+		buildExportsTree: typeof _utils_buildExportsTree,
+		buildFileDataList: typeof _utils_buildFileDataList,
+		clean: typeof _utils_clean,
+		extractJSDocComment: typeof _utils_extractJSDocComment,
+		generateFile: typeof _utils_generateFile,
+		generateFlatExportLines: typeof _utils_generateFlatExportLines,
+		generateImportStatements: typeof _utils_generateImportStatements,
+		generateNamedExports: typeof _utils_generateNamedExports,
+		generateNamespaceCode: typeof _utils_generateNamespaceCode,
+		generateNamespaceExportLines: typeof _utils_generateNamespaceExportLines,
+		writeHotWrapper: typeof _utils_writeHotWrapper,
+	},
 };
 
 export default _default;

package/types/shouldIgnore.d.ts

@@ -0,0 +1 @@
+export default function shouldIgnore(filePath: any, ignorePatterns: any): any;

package/types/utils/buildFileDataList.d.ts

@@ -1,4 +1,8 @@
-export default function buildFileDataList(src: any, ignore: any, includeComments: any): {
+export default function buildFileDataList({ src, ignore, includeComments }: {
+    src: any;
+    ignore: any;
+    includeComments: any;
+}): {
     normalizedFile: any;
     parts: any;
     functionName: any;

package/types/utils/generateFile.d.ts

@@ -1 +1,8 @@
-export default function generateFile(src: any, exportRoots: any, ignore: any, includeComments: any, dts: any): string;
+export default function generateFile({ src, exportRoots, ignore, includeComments, dts, useTabs }: {
+    src: any;
+    exportRoots: any;
+    ignore: any;
+    includeComments: any;
+    dts: any;
+    useTabs?: boolean;
+}): string;

package/types/utils/generateFlatExportLines.d.ts

@@ -1 +1,7 @@
-export default function generateFlatExportLines(flatExports: any, exportRoots: any, includeComments: any, dts: any): string;
+export default function generateFlatExportLines({ flatExports, exportRoots, includeComments, dts, useTabs }: {
+    flatExports: any;
+    exportRoots: any;
+    includeComments: any;
+    dts: any;
+    useTabs?: boolean;
+}): string;

package/types/utils/generateImportStatements.d.ts

@@ -1 +1,5 @@
-export default function generateImportStatements(fileDataList: any, dts: any, src: any): string;
+export default function generateImportStatements({ fileDataList, dts, src }: {
+    fileDataList: any;
+    dts: any;
+    src: any;
+}): string;

package/types/utils/generateNamedExports.d.ts

@@ -1 +1,7 @@
-export default function generateNamedExports(flatExports: any, exportRoots: any, dts: any): string;
+export default function generateNamedExports({ flatExports, exportRoots, nestedExports, dts, useTabs }: {
+    flatExports: any;
+    exportRoots: any;
+    nestedExports: any;
+    dts: any;
+    useTabs?: boolean;
+}): string;

package/types/utils/generateNamespaceCode.d.ts

@@ -1 +1,7 @@
-export default function generateNamespaceCode(nsObj: any, indentLevel: any, includeComments: any, dts: any): string;
+export default function generateNamespaceCode({ nsObj, indentLevel, includeComments, dts, useTabs }: {
+    nsObj: any;
+    indentLevel: any;
+    includeComments: any;
+    dts: any;
+    useTabs?: boolean;
+}): string;

package/types/utils/generateNamespaceExportLines.d.ts

@@ -1 +1,6 @@
-export default function generateNamespaceExportLines(nestedExports: any, includeComments: any, dts: any): string;
+export default function generateNamespaceExportLines({ nestedExports, includeComments, dts, useTabs }: {
+    nestedExports: any;
+    includeComments: any;
+    dts: any;
+    useTabs?: boolean;
+}): string;

package/types/utils/writeHotWrapper.d.ts

@@ -0,0 +1,4 @@
+export default function writeHotWrapper({ dest, hotSource }: {
+    dest: any;
+    hotSource: any;
+}): void;