fileflows 1.0.0 → 1.0.2

package/README.md

@@ -1,8 +1,8 @@
-# File Flows CLI
+# FileFlows CLI
 
 A CLI tool for generating `FILE_FLOWS.md` - analyzes project files and creates comprehensive documentation showing data flow relationships.
 
-[![npm version](https://badge.fury.io/js/file-flows-cli.svg)](https://badge.fury.io/js/file-flows-cli)
+[![npm version](https://badge.fury.io/js/fileflows.svg)](https://badge.fury.io/js/fileflows)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 ## Features
@@ -17,12 +17,12 @@ A CLI tool for generating `FILE_FLOWS.md` - analyzes project files and creates c
 
 ### Global Installation (Recommended)
 ```bash
-npm install -g file-flows-cli
+npm install -g fileflows
 ```
 
 ### Local Installation
 ```bash
-npm install file-flows-cli
+npm install fileflows
 ```
 
 ### Development/Direct Use
@@ -35,28 +35,37 @@ npm install @babel/parser globby
 ### Global Installation
 ```bash
 # Analyze current directory (generates FILE_FLOWS.md)
-file-flows
+fileflows
 
 # Analyze specific directory  
-file-flows --dir ./src
+fileflows --dir ./src
 
 # Custom output file
-file-flows --output my-flows.md
+fileflows --output my-flows.md
 
 # Show help
-file-flows --help
+fileflows --help
 ```
 
 ### Local Installation
 ```bash
 # Using npx
-npx file-flows
+npx fileflows
 
-# Using npm scripts
-npm run file-flows
+# Using npm scripts (if added to package.json)
+npm run generate
 
 # Direct node execution
-node node_modules/file-flows-cli/cli-file-flows.js
+node node_modules/fileflows/cli.js
+```
+
+### Development/Direct Use
+```bash
+# Clone or download the repository, then:
+node cli.js                    # Analyze current directory
+node cli.js --dir ./src        # Analyze src directory  
+node cli.js --output flows.md  # Custom output file
+node cli.js --help            # Show help
 ```
 
 ## How It Works
@@ -102,4 +111,20 @@ The generated `FILE_FLOWS.md` includes:
 ---
 ```
 
+## Command Line Options
+
+```
+Usage: node cli.js [options]
+
+Options:
+  --dir <path>     Directory to analyze (default: current directory)
+  --output <file>  Output file path (default: FILE_FLOWS.md)
+  --help, -h       Show this help message
+
+Examples:
+  node cli.js                    # Analyze current directory
+  node cli.js --dir ./src        # Analyze src directory
+  node cli.js --output flows.md  # Custom output file
+```
+
 This tool preserves all the sophisticated analysis capabilities of the original system while providing a clean, focused CLI interface.

package/cli.js

@@ -3,11 +3,9 @@
  * CLI tool for generating FILE_FLOWS.md
  * Analyzes project files and creates documentation showing data flow relationships
  * Following NPM architecture guidelines with modular structure
+ * Refactored: Global const declarations moved to config/localVars.js
  */
 
-const generateFileFlows = require(`./lib/fileFlowsGenerator`);
-const localVars = require(`./config/localVars`);
-
 /**
  * CLI usage display functionality
  * Shows help information for the CLI tool
@@ -31,6 +29,9 @@ function showUsage() {
  * Parses arguments and executes file flows generation
  */
 async function main() {
+  const localVars = require(`./config/localVars`);
+  const { generateFileFlows } = localVars.getDependencies();
+  
   const args = process.argv.slice(2);
   let rootDir = localVars.DEFAULT_ROOT_DIR;
   let outputFile = null;

package/config/localVars.js

@@ -35,6 +35,42 @@ const MAX_YAML_KEYS = 5;
 const MAX_SHELL_COMMANDS = 5;
 const MAX_HTML_TAGS = 5;
 
+// === CENTRALIZED DEPENDENCIES ===
+// All require statements moved from global scope to centralized configuration
+function getDependencies() {
+  return {
+    // Core library modules (from lib/index.js)
+    generateFileFlows: require(`../lib/fileFlowsGenerator`),
+    groupByDataFlow: require(`../lib/dataFlowGrouper`),
+    classifyFile: require(`../lib/fileClassifier`),
+    parseJSFile: require(`../lib/jsParser`),
+    parseOtherFile: require(`../lib/otherFileParser`),
+    extractDependencies: require(`../lib/dependencyExtractor`),
+    fileIO: require(`../lib/fileIO`),
+    graphUtils: require(`../lib/graphUtils`),
+    
+    // System dependencies (from qtests-runner.js)
+    fs: require(`fs`),
+    path: require(`path`),
+    childProcess: require(`child_process`),
+    os: require(`os`),
+    
+    // Testing dependencies (from qtests.config.js)
+    qtests: require(`qtests`)
+  };
+}
+
+// === ENVIRONMENT VARIABLES ===
+// Centralized environment variable access using qerrors utilities
+const { getEnv } = require(`qerrors`);
+
+function getEnvironmentConfig() {
+  return {
+    NODE_ENV: getEnv(`NODE_ENV`, `development`),
+    DEBUG_TESTS: getEnv(`DEBUG_TESTS`, `false`) === `true`
+  };
+}
+
 module.exports = {
   CODE_EXTENSIONS,
   ALL_EXTENSIONS,
@@ -44,5 +80,7 @@ module.exports = {
   MAX_JSON_KEYS,
   MAX_YAML_KEYS,
   MAX_SHELL_COMMANDS,
-  MAX_HTML_TAGS
+  MAX_HTML_TAGS,
+  getDependencies,
+  getEnvironmentConfig
 };

package/index.js

@@ -1,8 +1,13 @@
 /**
  * Main entry point for the file-flows-cli NPM module
  * Exports public functionality following NPM architecture guidelines
+ * Refactored: Global const declarations moved to config/localVars.js
  */
 
-const { generateFileFlows } = require(`./lib/index`);
+function getMainExport() {
+  const localVars = require(`./config/localVars`);
+  const { generateFileFlows } = localVars.getDependencies();
+  return generateFileFlows;
+}
 
-module.exports = generateFileFlows;
+module.exports = getMainExport();

package/lib/fileFlowsGenerator.js

@@ -71,13 +71,21 @@ async function generateFileFlows(rootDir = `.`, outputFile = null) {
     
     files = findFiles('.');
   } catch (error) {
-    console.error(`⚠️ File flow generation failed:`, error.message);
+    require('qerrors').logError(error, 'File flow generation failed during file discovery', { 
+      context: 'FILE_DISCOVERY_ERROR',
+      rootDir: ROOT,
+      outputFile: FILE_OUTPUT 
+    });
     return { filesAnalyzed: 0, flowGroups: 0, outputFile: null };
   }
 
   // Check if any files were found
   if (files.length === 0) {
-    console.log(`⚠️ No files found in directory: ${ROOT}`);
+    require('qerrors').logWarn(`No files found in directory: ${ROOT}`, 'generateFileFlows', { 
+      context: 'NO_FILES_FOUND',
+      rootDir: ROOT,
+      searchExtensions: localVars.ALL_EXTENSIONS 
+    });
     return { filesAnalyzed: 0, flowGroups: 0, outputFile: null };
   }
 
@@ -119,7 +127,9 @@ async function generateFileFlows(rootDir = `.`, outputFile = null) {
         : parseOtherFile(content, relPath, ext);
         
       for (const [label, value] of Object.entries(metadata)) {
-        if (value.length > 0) section.push(`**${label}:** ${value.join(`, `)}`);
+        // 🚩AI: Ensure value is always an array before calling join
+        const arrayValue = Array.isArray(value) ? value : [value];
+        if (arrayValue.length > 0) section.push(`**${label}:** ${arrayValue.join(`, `)}`);
       }
 
       section.push(`\n---\n`);
@@ -134,7 +144,12 @@ async function generateFileFlows(rootDir = `.`, outputFile = null) {
     outputFile: FILE_OUTPUT
   };
   
-  console.log(`✅ FILE_FLOWS.md written with ${result.filesAnalyzed} files.`);
+  require('qerrors').logInfo(`FILE_FLOWS.md generation completed`, 'generateFileFlows', { 
+    context: 'GENERATION_SUCCESS',
+    filesAnalyzed: result.filesAnalyzed,
+    flowGroups: result.flowGroups,
+    outputFile: result.outputFile
+  });
   return result;
 }
 

package/lib/fileIO.js

@@ -39,7 +39,12 @@ function safeResolvePath(rootDir, filePath) {
     
     // Prevent directory traversal attacks
     if (relative.startsWith(`..`)) {
-      throw new Error(`Path traversal attempt detected: ${filePath}`);
+      const { createTypedError, ErrorTypes } = require('qerrors');
+      throw createTypedError(
+        `Path traversal attempt detected: ${filePath}`,
+        ErrorTypes.VALIDATION,
+        'PATH_TRAVERSAL_DETECTED'
+      );
     }
     
     return { success: true, resolvedPath: resolved };

package/lib/index.js

@@ -1,37 +1,29 @@
 /**
  * Library aggregation module
  * Exports all library functionality following NPM architecture guidelines
+ * Refactored: Global const declarations moved to config/localVars.js
  */
 
-const generateFileFlows = require(`./fileFlowsGenerator`);
-const groupByDataFlow = require(`./dataFlowGrouper`);
-const classifyFile = require(`./fileClassifier`);
-const parseJSFile = require(`./jsParser`);
-const parseOtherFile = require(`./otherFileParser`);
-const extractDependencies = require(`./dependencyExtractor`);
+// 🚩AI: MAIN_LIBRARY_EXPORTS_REGISTRY - Dependencies centralized in config/localVars.js
+function getLibraryModules() {
+  const localVars = require(`../config/localVars`);
+  const deps = localVars.getDependencies();
+  
+  return {
+    generateFileFlows: deps.generateFileFlows,
+    groupByDataFlow: deps.groupByDataFlow,
+    classifyFile: deps.classifyFile,
+    parseJSFile: deps.parseJSFile,
+    parseOtherFile: deps.parseOtherFile,
+    extractDependencies: deps.extractDependencies,
+    safeReadFileSync: deps.fileIO.safeReadFileSync,
+    safeResolvePath: deps.fileIO.safeResolvePath,
+    buildDependencyGraph: deps.graphUtils.buildDependencyGraph,
+    findConnectedComponents: deps.graphUtils.findConnectedComponents,
+    depthFirstSearch: deps.graphUtils.depthFirstSearch,
+    groupBySimilarity: deps.graphUtils.groupBySimilarity,
+    calculateRoleScore: deps.graphUtils.calculateRoleScore
+  };
+}
 
-// 🚩AI: MAIN_LIBRARY_EXPORTS_REGISTRY
-const { safeReadFileSync, safeResolvePath } = require(`./fileIO`);
-const {
-  buildDependencyGraph,
-  findConnectedComponents,
-  depthFirstSearch,
-  groupBySimilarity,
-  calculateRoleScore
-} = require(`./graphUtils`);
-
-module.exports = {
-  generateFileFlows,
-  groupByDataFlow,
-  classifyFile,
-  parseJSFile,
-  parseOtherFile,
-  extractDependencies,
-  safeReadFileSync,
-  safeResolvePath,
-  buildDependencyGraph,
-  findConnectedComponents,
-  depthFirstSearch,
-  groupBySimilarity,
-  calculateRoleScore
-};
+module.exports = getLibraryModules();

package/lib/jsParser.js

@@ -110,7 +110,12 @@ function parseJSFile(content, filePath) {
     
     visitNode(ast);
   } catch (err) {
-    // Suppress parse errors for cleaner console output
+    // Log parse errors for debugging but don't crash
+    require('qerrors').logWarn(`JavaScript parsing failed for ${filePath}`, 'parseJSFile', {
+      context: 'JS_PARSE_ERROR',
+      filePath: filePath,
+      errorMessage: err.message
+    });
   }
 
   return {

package/lib/otherFileParser.js

@@ -21,7 +21,7 @@ function parseOtherFile(content, relPath, ext) {
           Summary: summary
         };
       } catch {
-        return { Keys: [], Summary: 'Malformed JSON' };
+        return { Keys: [], Summary: ['Malformed JSON'] };
       }
     case `md`:
       const headings = lines
@@ -57,7 +57,7 @@ function parseOtherFile(content, relPath, ext) {
         .filter(Boolean);
       return { 
         Types: types,
-        Summary: 'GraphQL Schema'
+        Summary: ['GraphQL Schema']
       };
     case `sh`:
       const commands = lines
@@ -93,10 +93,10 @@ function parseOtherFile(content, relPath, ext) {
       
       return {
         Tags: tags.slice(0, localVars.MAX_HTML_TAGS),
-        Summary: title
+        Summary: [title]
       };
     default:
-      return { Summary: 'Unknown file type' };
+      return { Summary: ['Unknown file type'] };
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fileflows",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI tool for deploying data workflow analysis documentation",
   "main": "cli.js",
   "bin": {
@@ -54,9 +54,7 @@
   "dependencies": {
     "@babel/parser": "^7.28.3",
     "@babel/traverse": "^7.28.3",
-    "commoncontext": "^1.0.0",
     "globby": "^14.1.0",
-    "npmcontext": "^1.0.0",
     "qerrors": "^1.2.6",
     "winston": "^3.17.0",
     "winston-daily-rotate-file": "^5.0.0"
@@ -64,10 +62,12 @@
   "devDependencies": {
     "agentsqripts": "^1.0.8",
     "arqitect": "^1.0.7",
+    "commoncontext": "^1.0.1",
     "loqatevars": "^1.0.6",
     "madge": "^8.0.0",
-    "qtests": "^1.1.4",
-    "quantumagent": "^1.0.4",
+    "npmcontext": "^1.0.1",
+    "qtests": "^1.1.9",
+    "quantumagent": "^1.0.5",
     "repomix": "^1.2.0",
     "unqommented": "^1.1.0"
   }