@awesomeness-js/utils 1.0.24 → 1.1.2

package/tests/env.test.js

@@ -1,5 +1,7 @@
 // example.test.js
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 import utils from '../index.js';
 
 await utils.setLocalEnvs('./secrets/local.env');
@@ -7,11 +9,15 @@ await utils.setLocalEnvs('./secrets/local.env');
 const env1 = process.env.JUST_A_TEST;
 
 test('localEnv - should be testValue', () => {
-    expect(env1).toBe('Local just a test');
+
+	expect(env1).toBe('Local just a test');
+
 });
 
 await utils.setLocalEnvs('./secrets/dev.env');
 
 test('localEnv - should be testValue', () => {
-    expect(process.env.JUST_A_TEST).toBe('Dev just a test');
+
+	expect(process.env.JUST_A_TEST).toBe('Dev just a test');
+
 });

package/tests/example.test.js

@@ -1,6 +1,10 @@
 // example.test.js
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 
 test('adds 2 + 3 to equal 5', () => {
-  expect(2 + 3).toBe(5)
-})
+
+	expect(2 + 3).toBe(5);
+
+});

package/tests/fileList.test.js

@@ -1,21 +1,25 @@
 // example.test.js
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 import utils from '../index.js';
 
 
 let fileList2 = utils.getAllFiles('./test', {
-   // fileTypes: ['.css'],
-   // fileTypes: ['.js'],
-   ignore: [
-        "/ignoreFolder", 
-        "/ignoreFolder2/", 
-        "*.env",
-        "*.test.js",
-        "/css/*.js",
-        "/js/*.css"
-    ]
+	// fileTypes: ['.css'],
+	// fileTypes: ['.js'],
+	ignore: [
+		"/ignoreFolder", 
+		"/ignoreFolder2/", 
+		"*.env",
+		"*.test.js",
+		"/css/*.js",
+		"/js/*.css"
+	]
 });
 
 test('file list of 3', () => {
-    expect(fileList2.length).toBe(3); // Adjust this number based on your test folder contents
+
+	expect(fileList2.length).toBe(4); // Adjust this number based on your test folder contents
+
 });

package/tests/hash-and-encrypt.test.js

@@ -1,5 +1,7 @@
 // example.test.js
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 import utils from '../index.js';
 
 // set AWESOMENESS_ENCRYPTION_KEY
@@ -8,11 +10,15 @@ await utils.setLocalEnvs('./secrets/dev.env');
 const storedHash = utils.password.hash('mySecret123');
 
 test('correct password check', () => {
-    expect(utils.password.check('mySecret123', storedHash)).toBe(true)
+
+	expect(utils.password.check('mySecret123', storedHash)).toBe(true);
+
 });
 
 test('incorrect password check', () => {
-    expect(utils.password.check('wrongPassword', storedHash)).toBe(false)
+
+	expect(utils.password.check('wrongPassword', storedHash)).toBe(false);
+
 });
 
 // Example 256-bit key for AES-256
@@ -21,6 +27,9 @@ test('incorrect password check', () => {
 const secretMessage = 'This is top secret!';
 const encrypted = utils.encrypt(secretMessage);
 const decrypted = utils.decrypt(encrypted);
+
 test('encryption and decryption', () => {
-    expect(decrypted).toBe(secretMessage)
+
+	expect(decrypted).toBe(secretMessage);
+
 });

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/md5.test.js

@@ -1,7 +1,12 @@
 // example.test.js
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 import utils from '../index.js';
 let md5Test = utils.md5('test');
+
 test('md5 test', () => {
-    expect(md5Test).toBe('098f6bcd4621d373cade4e832627b4f6');
+
+	expect(md5Test).toBe('098f6bcd4621d373cade4e832627b4f6');
+
 });

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/tests/uuid.test.js

@@ -1,15 +1,21 @@
 // example.test.js
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 import utils from '../index.js';
 
 let uuid = utils.uuid();
 let isValid = utils.isUUID(uuid);
 
 test('uuid create', () => {
-    expect(uuid).toBeDefined();
-    expect(uuid.length).toBe(36);
+
+	expect(uuid).toBeDefined();
+	expect(uuid.length).toBe(36);
+
 });
 
 test('uuid isValid', () => {
-    expect(isValid).toBe(true);
+
+	expect(isValid).toBe(true);
+
 });

package/tests/validateSchema.test.js

@@ -1,4 +1,6 @@
-import { expect, test } from 'vitest'
+import {
+	expect, test 
+} from 'vitest';
 import utils from '../index.js';
 import schemas from '../schemas.js';
 
@@ -7,24 +9,34 @@ let schema2 = utils.validateSchema(schemas.schema2);
 
 
 test('schema1 is valid', () => {
-    expect(schema1).toBe(true);
+
+	expect(schema1).toBe(true);
+
 });
 
 test('schema2 is valid', () => {
-    expect(schema2).toBe(true);
+
+	expect(schema2).toBe(true);
+
 });
 
 let expectedError;
 
 try {
-    utils.validateSchema({
-        notReal: true
-    });
-    expectedError = false; // should not reach here
+
+	utils.validateSchema({
+		notReal: true
+	});
+	expectedError = false; // should not reach here
+
 } catch(e){
-    expectedError = true;
+
+	expectedError = true;
+
 }
 
 test('invalid schema throws error', () => {
-    expect(expectedError).toBe(true);
+
+	expect(expectedError).toBe(true);
+
 });

package/tsconfig.json

@@ -1,17 +1,21 @@
 {
-  "compilerOptions": {
-    "declaration": true,        // Generates .d.ts files
-    "emitDeclarationOnly": true, // Only output .d.ts files
-    "allowJs": true,            // Allows JS files
-    "outDir": "types",          // Output directory for type files
-    "moduleResolution": "node",
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "types": ["vitest/globals"]
-  },
-  "include": ["src/**/*"],
-  "exclude": [
-    "./src/ignoreFolder/**/*", 
-    "./src/ignoreMe.js"
-  ]
-}
+	"compilerOptions": {
+		"declaration": true, // Generates .d.ts files
+		"emitDeclarationOnly": true, // Only output .d.ts files
+		"allowJs": true, // Allows JS files
+		"outDir": "types", // Output directory for type files
+		"moduleResolution": "node",
+		"skipLibCheck": true,
+		"esModuleInterop": true,
+		"types": [
+			"vitest/globals"
+		]
+	},
+	"include": [
+		"src/**/*"
+	],
+	"exclude": [
+		"./src/ignoreFolder/**/*",
+		"./src/ignoreMe.js"
+	]
+}

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/collectImports.d.ts

@@ -0,0 +1,6 @@
+export default run;
+declare function run(filePath: any, { returnCode, jsMaps, cssMaps }?: {
+    returnCode?: boolean;
+    jsMaps?: {};
+    cssMaps?: {};
+}): any[];

package/types/index.d.ts

@@ -12,6 +12,7 @@ import type _clean_object from './clean/object';
 import type _clean_string from './clean/string';
 import type _clean_timestamp from './clean/timestamp';
 import type _clean_uuid from './clean/uuid';
+import type _collectImports from './collectImports';
 import type _combineFiles from './combineFiles';
 import type _convertBytes from './convertBytes';
 import type _decrypt from './decrypt';
@@ -19,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';
@@ -38,11 +38,12 @@ 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';
 
 export declare const build: typeof _build;
+export declare const collectImports: typeof _collectImports;
 export declare const combineFiles: typeof _combineFiles;
 export declare const convertBytes: typeof _convertBytes;
 export declare const decrypt: typeof _decrypt;
@@ -50,90 +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;
-    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;