importy 0.0.11 → 0.1.2

package/README.md

@@ -1,10 +1,28 @@
 # Importy
+<img align="right" src="public/importy.png" alt="Importy CLI Tool" height="120" />
 
 A powerful CLI tool for analyzing JavaScript/TypeScript imports from libraries.
 
 [![npm version](https://img.shields.io/npm/v/importy.svg)](https://www.npmjs.com/package/importy)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+> **Version 0.1.1** - First stable release! 🎉 See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 📖 Documentation
+
+**[📚 Complete Documentation →](https://tvshevchuk.github.io/Importy/)**
+
+- [🚀 Getting Started Guide](https://tvshevchuk.github.io/Importy/guide/getting-started)
+- [📋 API Reference](https://tvshevchuk.github.io/Importy/api/cli)
+- [💡 Examples & Use Cases](https://tvshevchuk.github.io/Importy/examples/basic-usage)
+- [🤝 Contributing Guide](https://tvshevchuk.github.io/Importy/contributing)
+
+## 🎬 Live Demo
+
+![Importy Demo](public/improved-demo-small.gif)
+
+*See Importy in action analyzing a React project! [View full demo →](DEMO.md)*
+
 ## Overview
 
 Importy scans your codebase to identify and analyze imports from specific libraries. It helps you:
@@ -25,6 +43,9 @@ yarn global add importy
 
 # Using pnpm
 pnpm add -g importy
+
+# Verify installation
+importy --version  # Should output: 0.1.0
 ```
 
 ## Usage
@@ -111,7 +132,7 @@ Importy uses parallel processing with promises, making it efficient even for lar
 
 ### Prerequisites
 
-- Node.js 16+
+- Node.js 18+
 - npm, yarn, or pnpm
 
 ### Setup
@@ -158,13 +179,49 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
+### Development Workflow
+
+```bash
+# Setup
+git clone https://github.com/tvshevchuk/Importy.git
+cd importy
+pnpm install
+
+# Development
+npm run dev          # Development mode
+npm run check        # Code quality checks
+npm test            # Run tests
+npm run build       # Build project
+
+# Release (maintainers only)
+npm run release:check    # Check if ready for release
+npm run release:patch    # Create patch release
+npm run release:minor    # Create minor release
+npm run release:major    # Create major release
+```
+
+### Automated Releases
+
+This project uses automated releases via GitHub Actions. When a pull request with a version bump is merged to main, it automatically:
+
+- Runs tests and quality checks
+- Updates the changelog
+- Creates a GitHub release
+- Publishes to npm
+
+See [Release Process](.github/RELEASE_PROCESS.md) for detailed information.
+
 ## Troubleshooting
 
 ### Common Issues
 
-- **ES Module Compatibility**: If you encounter issues with ES modules, ensure your Node.js version is compatible (16+) and you're using the correct import syntax.
+- **ES Module Compatibility**: If you encounter issues with ES modules, ensure your Node.js version is compatible (18+) and you're using the correct import syntax.
 - **Parsing Errors**: Complex TypeScript/JSX syntax may occasionally cause parsing errors. These files are skipped with a warning.
 
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes and releases.
+
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

package/dist/index.js

@@ -3,16 +3,16 @@
 // src/index.ts
 import fs2 from "fs";
 import path2 from "path";
-import { program } from "commander";
-import { fileURLToPath } from "url";
 import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { program } from "commander";
 
 // src/cli.ts
 import fs from "fs";
+import os from "os";
 import path from "path";
 import * as parser from "@babel/parser";
 import _traverse from "@babel/traverse";
-import os from "os";
 var traverse = _traverse.default;
 function isJavaScriptFile(file) {
   return /\.(js|ts|jsx|tsx)$/.test(file);
@@ -40,11 +40,17 @@ function getAllFiles(dirPath, arrayOfFiles = [], includePattern, excludePattern,
           }
         }
       } catch (error) {
-        if (verbose) console.warn(`Error accessing file ${fullPath}: ${error instanceof Error ? error.message : String(error)}`);
+        if (verbose)
+          console.warn(
+            `Error accessing file ${fullPath}: ${error instanceof Error ? error.message : String(error)}`
+          );
       }
     }
   } catch (error) {
-    if (verbose) console.error(`Error reading directory ${dirPath}: ${error instanceof Error ? error.message : String(error)}`);
+    if (verbose)
+      console.error(
+        `Error reading directory ${dirPath}: ${error instanceof Error ? error.message : String(error)}`
+      );
   }
   return arrayOfFiles;
 }
@@ -54,7 +60,7 @@ function minimatch(filePath, pattern) {
     const regex = new RegExp(`^${regExpPattern}$`, "i");
     const result = regex.test(filePath);
     return result;
-  } catch (error) {
+  } catch (_error) {
     console.warn(`Invalid pattern: ${pattern}`);
     return false;
   }
@@ -82,7 +88,9 @@ async function processFilesInBatches(items, batchSize, processor, onProgress) {
           }
           return result;
         } catch (error) {
-          console.warn(`Error processing item: ${error instanceof Error ? error.message : String(error)}`);
+          console.warn(
+            `Error processing item: ${error instanceof Error ? error.message : String(error)}`
+          );
           completed++;
           if (onProgress) {
             onProgress(completed, total);
@@ -105,7 +113,7 @@ function extractImportsFromFile(filePath, targetLib) {
         plugins: ["typescript", "jsx"],
         errorRecovery: true
       });
-    } catch (err) {
+    } catch (_err) {
       try {
         ast = parser.parse(code, {
           sourceType: "module",
@@ -118,7 +126,6 @@ function extractImportsFromFile(filePath, targetLib) {
       }
     }
     const matches = [];
-    const lines = code.split("\n");
     traverse(ast, {
       ImportDeclaration(path3) {
         const node = path3.node;
@@ -149,7 +156,9 @@ function extractImportsFromFile(filePath, targetLib) {
     });
     return matches;
   } catch (error) {
-    console.warn(`Error reading file ${filePath}: ${error instanceof Error ? error.message : String(error)}`);
+    console.warn(
+      `Error reading file ${filePath}: ${error instanceof Error ? error.message : String(error)}`
+    );
     return [];
   }
 }
@@ -176,7 +185,8 @@ async function analyzeImports(options2) {
     };
   }
   const batchSize = Math.max(1, Math.ceil(allFiles.length / concurrency));
-  if (verbose) console.log(`Processing ${allFiles.length} files with ${concurrency} concurrent processes`);
+  if (verbose)
+    console.log(`Processing ${allFiles.length} files with ${concurrency} concurrent processes`);
   let processedCount = 0;
   const results = await processFilesInBatches(
     allFiles,
@@ -211,7 +221,9 @@ async function analyzeImports(options2) {
   const totalImports = Object.values(output).reduce((sum, files) => sum + files.length, 0);
   const totalComponents = Object.keys(output).length;
   if (verbose) {
-    console.log(`Analysis complete - Found ${totalComponents} components with ${totalImports} total imports across ${allFiles.length} files`);
+    console.log(
+      `Analysis complete - Found ${totalComponents} components with ${totalImports} total imports across ${allFiles.length} files`
+    );
   }
   return {
     summary: {
@@ -225,6 +237,15 @@ async function analyzeImports(options2) {
 }
 
 // src/index.ts
+var REQUIRED_NODE_VERSION = 18;
+var currentNodeVersion = Number.parseInt(process.version.slice(1).split(".")[0], 10);
+if (currentNodeVersion < REQUIRED_NODE_VERSION) {
+  console.error(
+    `\u274C Error: Node.js ${REQUIRED_NODE_VERSION}+ is required. You are running Node.js ${process.version}`
+  );
+  console.error("Please upgrade your Node.js version: https://nodejs.org/");
+  process.exit(1);
+}
 var __filename = fileURLToPath(import.meta.url);
 var __dirname = dirname(__filename);
 var packageJson;
@@ -232,20 +253,11 @@ try {
   const packagePath = path2.resolve(__dirname, "../package.json");
   const packageData = fs2.readFileSync(packagePath, "utf8");
   packageJson = JSON.parse(packageData);
-} catch (error) {
+} catch (_error) {
   packageJson = { version: "0.0.0", name: "importy" };
   console.warn("Could not load package.json, using default version");
 }
-program.version(packageJson.version).description("Analyze JavaScript/TypeScript imports from a specific library").requiredOption("-d, --dir <directory>", "Directory to scan").requiredOption("-l, --lib <library>", "Library name to match").option(
-  "-o, --output <file>",
-  "Output results to a JSON file instead of stdout"
-).option("-v, --verbose", "Enable verbose logging").option(
-  "-i, --include <pattern>",
-  "Only include files matching pattern (glob)"
-).option("-e, --exclude <pattern>", "Exclude files matching pattern (glob)").option(
-  "-c, --concurrency <number>",
-  "Number of worker threads (defaults to CPU count - 1)"
-).parse(process.argv);
+program.version(packageJson.version).description("Analyze JavaScript/TypeScript imports from a specific library").requiredOption("-d, --dir <directory>", "Directory to scan").requiredOption("-l, --lib <library>", "Library name to match").option("-o, --output <file>", "Output results to a JSON file instead of stdout").option("-v, --verbose", "Enable verbose logging").option("-i, --include <pattern>", "Only include files matching pattern (glob)").option("-e, --exclude <pattern>", "Exclude files matching pattern (glob)").option("-c, --concurrency <number>", "Number of worker threads (defaults to CPU count - 1)").parse(process.argv);
 var options = program.opts();
 async function main() {
   try {
@@ -255,7 +267,7 @@ async function main() {
       include: options.include,
       exclude: options.exclude,
       verbose: options.verbose || false,
-      concurrency: options.concurrency ? parseInt(options.concurrency, 10) : void 0
+      concurrency: options.concurrency ? Number.parseInt(options.concurrency, 10) : void 0
     });
     if (options.output) {
       try {
@@ -271,9 +283,7 @@ async function main() {
       console.log(JSON.stringify(result, null, 2));
     }
     if (Object.keys(result.components).length === 0) {
-      console.warn(
-        `No imports from '${options.lib}' were found in the specified directory.`
-      );
+      console.warn(`No imports from '${options.lib}' were found in the specified directory.`);
       process.exit(0);
     }
     return result;
@@ -285,8 +295,6 @@ async function main() {
   }
 }
 main().catch((error) => {
-  console.error(
-    `Unhandled error: ${error instanceof Error ? error.message : String(error)}`
-  );
+  console.error(`Unhandled error: ${error instanceof Error ? error.message : String(error)}`);
   process.exit(1);
 });

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "importy",
-  "version": "0.0.11",
+  "version": "0.1.2",
   "description": "A CLI tool for analyzing JavaScript/TypeScript imports from libraries",
+  "homepage": "https://tvshevchuk.github.io/Importy/",
+  "bugs": {
+    "url": "https://github.com/tvshevchuk/Importy/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/tvshevchuk/Importy"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "bin": {
@@ -21,12 +28,14 @@
   ],
   "devDependencies": {
     "@babel/types": "7.27.3",
+    "@biomejs/biome": "1.9.4",
     "@types/babel__traverse": "7.20.7",
     "@types/node": "22.15.29",
     "ts-node": "10.9.2",
     "tsup": "8.5.0",
     "typescript": "5.8.3",
-    "vitest": "1.4.0"
+    "vitepress": "^1.6.3",
+    "vitest": "1.6.1"
   },
   "dependencies": {
     "@babel/parser": "7.27.5",
@@ -81,6 +90,25 @@
     "start": "node dist/index.js",
     "dev": "ts-node src/index.ts",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "lint": "biome lint src/",
+    "lint:fix": "biome lint --write src/",
+    "format": "biome format src/",
+    "format:fix": "biome format --write src/",
+    "check": "biome check src/",
+    "check:fix": "biome check --write src/",
+    "prebuild": "npm run check",
+    "version": "npm run check:fix && git add -A src",
+    "postversion": "git push && git push --tags",
+    "release": "./scripts/release.sh",
+    "release:patch": "./scripts/release.sh patch",
+    "release:minor": "./scripts/release.sh minor",
+    "release:major": "./scripts/release.sh major",
+    "release:check": "./scripts/release.sh --check",
+    "release:manual": "./scripts/release.sh --manual",
+    "prerelease": "npm run test && npm run check",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   }
 }