@awesomeness-js/utils 1.0.0

package/README.md

@@ -0,0 +1,16 @@
+# Nothing Special
+
+Just some utils...
+
+example usage:
+```javascript   
+import { build } from '@awesomeness-js/utils';
+
+const built = build({
+    src: './src',
+    dest: ['./', 'index.js']
+});
+
+console.log({ built });
+
+```

package/build.js

@@ -0,0 +1,6 @@
+import build from './src/build.js';
+
+build({
+    src: './src',
+    dest: ['./', 'index.js']
+});

package/index.js

@@ -0,0 +1,18 @@
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+import _build from './build.js';
+
+export default {
+    /**
+     * Generates a output file that consolidates all src functions.
+     *
+     * @param {Object} [options] - The options for generating the output file.
+     * @param {string} [options.src='./src'] - The source directory.
+     * @param {array} [options.dest=['./', 'index.js']] - The destination file.
+     * @returns {bool} - Returns true if the output file is generated successfully.
+     */
+    build: _build
+};

package/license

@@ -0,0 +1,7 @@
+Copyright 2024 Scott Forte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "@awesomeness-js/utils",
+    "version": "1.0.0",
+    "description": "Awesomeness - Utils",
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/awesomeness-js/utils.git"
+    },
+    "type": "module",
+    "main": "index.js",
+    "author": "Scott Forte",
+    "license": "MIT",
+    "publishConfig": {
+      "access": "public"
+    }
+  }
+  

package/src/build.js

@@ -0,0 +1,128 @@
+import { readdirSync, statSync, writeFileSync, readFileSync } from 'fs';
+import { join, sep } from 'path';
+
+/**
+ * Generates a output file that consolidates all src functions.
+ *
+ * @param {Object} [options] - The options for generating the output file.
+ * @param {string} [options.src='./src'] - The source directory.
+ * @param {array} [options.dest=['./', 'index.js']] - The destination file.
+ * @returns {bool} - Returns true if the output file is generated successfully.
+ */
+
+function getAllFiles(base, dir, files = []) {
+    const directory = join(base, dir);
+	let sortedFiles = readdirSync(directory).sort();
+    sortedFiles.forEach(file => {
+        const fullPath = join(directory, file);
+
+        if (
+            statSync(fullPath).isDirectory() &&
+            file !== '_template'
+        ) {
+            files = getAllFiles(base, join(dir, file), files);
+        } else if (file.endsWith('.js') && !file.match(/\..*\./)) { // Exclude files with two or more dots
+            files.push(join(dir, file));
+        }
+    });
+    return files;
+}
+
+
+function objectToString(obj, allComments, indent = 4, level = 1) {
+    const spaces = ' '.repeat(indent * level);
+    const entries = Object.entries(obj).map(([key, value]) => {
+
+        if (typeof value === 'object') {
+            return `${spaces}${key}: ${objectToString(value, allComments, indent, level + 1)}`;
+        }
+
+		if(key.startsWith('___')){
+			let realKey = key.replace('___', '');
+
+			// split comment based on lines and insert spaces
+			let comment = allComments[value];
+			comment = comment.split('\n').map((line) => `${spaces.replace(' ', '')} ${line}`).join('\n');
+
+			return `${comment}\n${spaces}${realKey}: ${value}`;
+		} else {
+			return `${spaces}${key}: ${value}`;
+		}
+		
+    });
+
+	return `{\n${entries.join(',\n')}\n${' '.repeat(indent * (level - 1))}}`;
+
+}
+
+
+function extractJSDocComment(filePath) {
+    const fileContent = readFileSync(filePath, 'utf8');
+    const match = fileContent.match(/\/\*\*([\s\S]*?)\*\//);
+    return match ? `/**${match[1]}*/` : '';
+}
+
+
+function generateExports(src) {
+    const allFiles = [];
+    const fnFiles = getAllFiles(src, '.');
+    allFiles.push(...fnFiles);
+
+    let imports = '';
+    let apiObject = {};
+
+	let allComments = {};
+
+
+    for (const file of allFiles) {
+        const parts = file.split(sep).filter(p => p !== '.');
+        const functionName = parts.pop().replace('.js', '');
+        const namespace = parts.join('_');
+        const importPath = './' + file.replace(/\.js$/, '').replace(/\\/g, '/');
+        const filePath = join(src, file);
+
+        // Extract JSDoc comment, if present
+		let hasComment = '';
+        const jsDocComment = extractJSDocComment(filePath);
+		if(jsDocComment){
+			allComments[`${namespace}_${functionName}`] = jsDocComment
+			hasComment = '___'
+		}
+
+
+        // Generate import statement with JSDoc comment if available
+        imports += `import ${namespace}_${functionName} from '${importPath}.js';\n`;
+
+        // Populate the API object structure
+        let current = apiObject;
+        for (const part of parts) {
+            current[part] = current[part] || {};
+            current = current[part];
+        }
+        current[`${hasComment}${functionName}`] = `${namespace}_${functionName}`;
+    }
+
+    const apiContent = 'export default ' + objectToString(apiObject, allComments) + ';';
+
+    // Add a header comment
+    const headerComment = `/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+`;
+
+    return headerComment + imports + '\n' + apiContent;
+}
+
+
+async function build({
+    src = './src',
+    dest = ['./', 'index.js']
+} = {}) {
+    const indexContent = generateExports(src);
+    writeFileSync(join(...dest), indexContent);
+    return true;
+}
+
+export default build;