@awesomeness-js/utils 1.0.24 → 1.0.25

package/build/build.js

@@ -1,18 +1,18 @@
 import build from '../src/build.js';
 
 build({
-    src: './src',
-    dest: './index.js',
-    dts: false,
-    ignore: [
-        'ignoreMe.js',
-        'ignoreFolder/*',
-        //'namespaceExample/*',
-    ],
+	src: './src',
+	dest: './index.js',
+	dts: false,
+	ignore: [
+		'ignoreMe.js',
+		'ignoreFolder/*',
+		//'namespaceExample/*',
+	],
 });
 
 build({
-    src: './schemas',
-    dest: './schemas.js',
-    dts: false
+	src: './schemas',
+	dest: './schemas.js',
+	dts: false
 });

package/build/postBuild.js

@@ -1,11 +1,11 @@
 import build from '../src/build.js';
 build({ 
-    src: './src', 
-    dest: './types/index.d.ts', 
-    dts: true,
-    ignore: [
-        'ignoreMe.js',
-        'ignoreFolder/*',
-        //'namespaceExample/*',
-    ],
+	src: './src', 
+	dest: './types/index.d.ts', 
+	dts: true,
+	ignore: [
+		'ignoreMe.js',
+		'ignoreFolder/*',
+		//'namespaceExample/*',
+	],
 });

package/eslint.config.js

@@ -0,0 +1,90 @@
+export default [
+	// Here is where we fix "padding-line-between-statements"
+	{
+		rules: {
+			'padding-line-between-statements': [
+				'error',
+				// Insert a blank line **before** any block-like statement
+				{
+					blankLine: 'always',
+					prev: '*',
+					next: 'block-like' 
+				},
+				// Insert a blank line **after** any block-like statement
+				{
+					blankLine: 'always',
+					prev: 'block-like',
+					next: '*' 
+				},
+				// Keep the rest of your rules here as needed...
+				{
+					blankLine: 'always',
+					prev: '*',
+					next: 'function' 
+				},
+				{
+					blankLine: 'always',
+					prev: 'function',
+					next: '*' 
+				},
+				{
+					blankLine: 'always',
+					prev: '*',
+					next: 'throw' 
+				}
+			],
+			'padded-blocks': [
+				'error',
+				{
+					blocks: 'always',
+					classes: 'always',
+					switches: 'always'
+				}
+			],
+
+			"object-curly-newline": [
+				"error",
+				{
+					ObjectExpression: {
+						minProperties: 2,     // If object has 2+ props, break into multiple lines
+						multiline: true,
+						consistent: true
+					},
+					// You can also configure ImportDeclaration, ExportDeclaration, etc.
+					ObjectPattern: {
+						multiline: true,
+						minProperties: 2,
+						consistent: true
+					},
+					ImportDeclaration: {
+						multiline: true,
+						minProperties: 2
+					},
+					ExportDeclaration: {
+						multiline: true,
+						minProperties: 2
+					}
+				}
+			],
+
+			// 2) If the object is multiline, put each property on its own line
+			"object-property-newline": [
+				"error",
+				{
+					allowAllPropertiesOnSameLine: false
+				}
+			],
+
+			indent: [ "error", "tab", { "SwitchCase": 1 } ],
+			semi: [ "error", "always" ],
+			"arrow-parens": [ "error", "always" ],
+			"object-curly-spacing": [ "error", "always" ],
+			"array-bracket-spacing": [ "error", "always" ],
+			'lines-between-class-members': [ 'error', 'always' ],
+			'newline-after-var': [ 'error', 'always' ],
+			'newline-before-return': 'error',
+			'brace-style': [ 'error', '1tbs', { allowSingleLine: false } ],
+			"no-unreachable": "off"
+		}
+	}
+];

package/index.js

@@ -12,6 +12,7 @@ import _clean_object from './src/clean/object.js';
 import _clean_string from './src/clean/string.js';
 import _clean_timestamp from './src/clean/timestamp.js';
 import _clean_uuid from './src/clean/uuid.js';
+import _collectImports from './src/collectImports.js';
 import _combineFiles from './src/combineFiles.js';
 import _convertBytes from './src/convertBytes.js';
 import _decrypt from './src/decrypt.js';
@@ -43,6 +44,7 @@ import _uuid from './src/uuid.js';
 import _validateSchema from './src/validateSchema.js';
 
 export { _build as build };
+export { _collectImports as collectImports };
 export { _combineFiles as combineFiles };
 export { _convertBytes as convertBytes };
 export { _decrypt as decrypt };
@@ -60,78 +62,79 @@ export { _uuid as uuid };
 export { _validateSchema as validateSchema };
 
 export 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: _build,
-    combineFiles: _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: _convertBytes,
-    decrypt: _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: _each,
-    eachAsync: _eachAsync,
-    encrypt: _encrypt,
-    getAllFiles: _getAllFiles,
-    ignoreMe: _ignoreMe,
-    isUUID: _isUUID,
-    md5: _md5,
-    setLocalEnvs: _setLocalEnvs,
-    thingType: _thingType,
-    toPennies: _toPennies,
-    uuid: _uuid,
-    validateSchema: _validateSchema,
-    clean: {
-        array: _clean_array,
-        boolean: _clean_boolean,
-        integer: _clean_integer,
-        number: _clean_number,
-        object: _clean_object,
-        string: _clean_string,
-        timestamp: _clean_timestamp,
-        uuid: _clean_uuid,
-    },
-    ignoreFolder: {
-        ignoreMe: _ignoreFolder_ignoreMe,
-    },
-    password: {
-        check: _password_check,
-        hash: _password_hash,
-    },
-    utils: {
-        buildExportsTree: _utils_buildExportsTree,
-        buildFileDataList: _utils_buildFileDataList,
-        clean: _utils_clean,
-        extractJSDocComment: _utils_extractJSDocComment,
-        generateFile: _utils_generateFile,
-        generateFlatExportLines: _utils_generateFlatExportLines,
-        generateImportStatements: _utils_generateImportStatements,
-        generateNamedExports: _utils_generateNamedExports,
-        generateNamespaceCode: _utils_generateNamespaceCode,
-        generateNamespaceExportLines: _utils_generateNamespaceExportLines,
-        shouldIgnore: _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: _build,
+	collectImports: _collectImports,
+	combineFiles: _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: _convertBytes,
+	decrypt: _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: _each,
+	eachAsync: _eachAsync,
+	encrypt: _encrypt,
+	getAllFiles: _getAllFiles,
+	ignoreMe: _ignoreMe,
+	isUUID: _isUUID,
+	md5: _md5,
+	setLocalEnvs: _setLocalEnvs,
+	thingType: _thingType,
+	toPennies: _toPennies,
+	uuid: _uuid,
+	validateSchema: _validateSchema,
+	clean: {
+		array: _clean_array,
+		boolean: _clean_boolean,
+		integer: _clean_integer,
+		number: _clean_number,
+		object: _clean_object,
+		string: _clean_string,
+		timestamp: _clean_timestamp,
+		uuid: _clean_uuid,
+	},
+	ignoreFolder: {
+		ignoreMe: _ignoreFolder_ignoreMe,
+	},
+	password: {
+		check: _password_check,
+		hash: _password_hash,
+	},
+	utils: {
+		buildExportsTree: _utils_buildExportsTree,
+		buildFileDataList: _utils_buildFileDataList,
+		clean: _utils_clean,
+		extractJSDocComment: _utils_extractJSDocComment,
+		generateFile: _utils_generateFile,
+		generateFlatExportLines: _utils_generateFlatExportLines,
+		generateImportStatements: _utils_generateImportStatements,
+		generateNamedExports: _utils_generateNamedExports,
+		generateNamespaceCode: _utils_generateNamespaceCode,
+		generateNamespaceExportLines: _utils_generateNamespaceExportLines,
+		shouldIgnore: _utils_shouldIgnore,
+	},
 };

package/package.json

@@ -1,26 +1,26 @@
 {
-    "name": "@awesomeness-js/utils",
-    "version": "1.0.24",
-    "description": "Awesomeness - Utils",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/awesomeness-js/utils.git"
-    },
-    "scripts": {
-        "prebuild": "node ./build/build.js",
-        "build": "tsc && npm run postBuild",
-        "postBuild": "node ./build/postBuild.js",
-        "test": "vitest"
-    },
-    "type": "module",
-    "types": "./types/index.d.ts",
-    "main": "index.js",
-    "author": "Scott Forte",
-    "license": "MIT",
-    "publishConfig": {
-        "access": "public"
-    },
-    "devDependencies": {
-        "vitest": "^3.0.9"
-    }
-}
+	"name": "@awesomeness-js/utils",
+	"version": "1.0.25",
+	"description": "Awesomeness - Utils",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/awesomeness-js/utils.git"
+	},
+	"scripts": {
+		"prebuild": "node ./build/build.js",
+		"build": "tsc && npm run postBuild",
+		"postBuild": "node ./build/postBuild.js",
+		"test": "vitest"
+	},
+	"type": "module",
+	"types": "./types/index.d.ts",
+	"main": "index.js",
+	"author": "Scott Forte",
+	"license": "MIT",
+	"publishConfig": {
+		"access": "public"
+	},
+	"devDependencies": {
+		"vitest": "^3.0.9"
+	}
+}

package/schemas/schema1.js

@@ -5,7 +5,11 @@ const properties = {
 	exampleId: {
 		type: 'uuid',
 		description: 'the id of the vertex',
-		default: () => { return uuid(); },
+		default: () => {
+
+			return uuid(); 
+
+		},
 		example: '00000000-0000-0000-0000-000000000000',
 		immutable: true,
 		required: true

package/schemas/schema2.js

@@ -5,7 +5,11 @@ const properties = {
 	exampleId: {
 		type: 'uuid',
 		description: 'the id of the vertex',
-		default: () => { return uuid(); },
+		default: () => {
+
+			return uuid(); 
+
+		},
 		example: '00000000-0000-0000-0000-000000000000',
 		immutable: true,
 		required: true

package/schemas.js

@@ -10,6 +10,6 @@ export { _schema1 as schema1 };
 export { _schema2 as schema2 };
 
 export default {
-    schema1: _schema1,
-    schema2: _schema2,
+	schema1: _schema1,
+	schema2: _schema2,
 };

package/src/build.js

@@ -14,15 +14,19 @@ import { writeFileSync } from 'fs';
 import generateFile from './utils/generateFile.js';
 
 async function build({
-    src = './src',
-    dest = './index.js',
-    exportRoots = true,
-    ignore = [],
-    includeComments = true,
-    dts = false
+	src = './src',
+	dest = './index.js',
+	exportRoots = true,
+	ignore = [],
+	includeComments = true,
+	dts = false,
+	useTabs = true
 } = {}) {
-    writeFileSync(dest, generateFile(src, exportRoots, ignore, includeComments, dts));
-    return true;
+
+	writeFileSync(dest, generateFile(src, exportRoots, ignore, includeComments, dts, useTabs));
+	
+	return true;
+
 }
 
 export default build;

package/src/clean/boolean.js

@@ -1,22 +1,32 @@
 export default function cleanBoolean(x, {
-    required = false
+	required = false
 } = {}){
 
-    try {
-    
-        if(x !== true && x !== false){
-            throw {
-                message: `Invalid boolean value "${x}"`,
-            }
-        }
-        
-        return x;
-
-    } catch (e) {
-
-        if(required) { throw e; } else { return null; }
-        
-    }
-    
+	try {
+	
+		if(x !== true && x !== false){
+
+			throw {
+				message: `Invalid boolean value "${x}"`,
+			};
+		
+		}
+		
+		return x;
+
+	} catch (e) {
+
+		if(required) {
+
+			throw e; 
+
+		} else {
+
+			return null; 
+
+		}
+		
+	}
+	
 }
 

package/src/clean/integer.js

@@ -1,74 +1,90 @@
 export default function cleanInt(x, {
-    required = false,
-    convertString = true,
-    min = false,
-    max = false,
+	required = false,
+	convertString = true,
+	min = false,
+	max = false,
 } = {}){
 
-    try {
-
-        if (typeof x !== 'number' || !Number.isInteger(x)) {
-
-            // convert string to number if possible
-            // but not a decimal string
-            if (convertString && typeof x === 'string') {
-
-                if(x.includes('.')){
-                    throw {
-                        message: 'string contains decimal',
-                        value: x
-                    };
-                }
-
-                if(!isNaN(parseInt(x))){
-                    x = parseInt(x);
-                } else {
-                    throw {
-                        message: 'string cannot be parsed to integer',
-                        value: x
-                    }
-                }
-                
-
-            } else {
-                throw {
-                    message: 'Input must be an integer',
-                    value: x
-                }
-            }
-    
-        }
-    
-        if (min !== false && x < min) { 
-        
-            throw {
-                message: `Integer must be greater than or equal to ${min}`,
-                value: x,
-                min,
-                max
-            }
-    
-        }
-    
-        if (max !== false && x > max) { 
-    
-            throw {
-                message: `Integer must be less than or equal to ${max}`,
-                value: x,
-                min,
-                max
-            }        
-    
-        }
-    
-        return x;
-
-    } catch (e) {
-
-        if(required) { throw e; } else { return null; }
-        
-    }
-    
-    
+	try {
+
+		if (typeof x !== 'number' || !Number.isInteger(x)) {
+
+			// convert string to number if possible
+			// but not a decimal string
+			if (convertString && typeof x === 'string') {
+
+				if(x.includes('.')){
+
+					throw {
+						message: 'string contains decimal',
+						value: x
+					};
+				
+				}
+
+				if(!isNaN(parseInt(x))){
+
+					x = parseInt(x);
+				
+				} else {
+
+					throw {
+						message: 'string cannot be parsed to integer',
+						value: x
+					};
+				
+				}
+				
+
+			} else {
+
+				throw {
+					message: 'Input must be an integer',
+					value: x
+				};
+			
+			}
+	
+		}
+	
+		if (min !== false && x < min) { 
+		
+			throw {
+				message: `Integer must be greater than or equal to ${min}`,
+				value: x,
+				min,
+				max
+			};
+	
+		}
+	
+		if (max !== false && x > max) { 
+	
+			throw {
+				message: `Integer must be less than or equal to ${max}`,
+				value: x,
+				min,
+				max
+			};        
+	
+		}
+	
+		return x;
+
+	} catch (e) {
+
+		if(required) {
+
+			throw e; 
+
+		} else {
+
+			return null; 
+
+		}
+		
+	}
+	
+	
 }