assets-tracker 1.0.0 → 1.0.1

package/README.md

@@ -3,20 +3,21 @@
 [![npm version](https://img.shields.io/npm/v/assets-tracker.svg)](https://www.npmjs.com/package/assets-tracker)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**Clean up your codebase and shrink your bundle size with the ultimate unused assets detector.**
+**The ultimate unused assets detector for React, React Native, Web, and Mobile apps.**
 
-`assets-tracker` is a modern, high-performance CLI tool designed to identify and remove unreferenced assets from your project. Whether it's a forgotten hero image, an unused font file, or a legacy video asset, this tool helps you keep your repository lean and efficient.
+`assets-tracker` is a modern, high-performance CLI tool designed to identify and remove unreferenced assets from your project. Whether you're building a **React Web App**, a **React Native Mobile App (iOS/Android)**, or an **Expo** project, this tool helps you keep your repository lean and efficient.
 
 ---
 
 ## ✨ Features
 
+- ⚛️ **React & React Native Optimized**: Built-in support for common patterns in modern frontend and mobile frameworks.
+- 📱 **Cross-Platform**: perfect for Web, Mobile (iOS/Android), and Desktop applications.
 - 🔍 **Deep Scan**: Identifies unused images, videos, fonts, and more across your entire project.
-- 🛠️ **Smart Analysis**: Scans your source files (JS, TS, HTML, CSS, etc.) to detect asset references.
+- 🛠️ **Smart Analysis**: Scans your source files (JS, TS, JSX, TSX, HTML, CSS, etc.) to detect asset references.
 - 🏢 **Modern CLI**: Beautiful, interactive terminal interface with progress indicators and formatted reports.
 - 🧹 **Interactive Cleanup**: Choose to delete all unused assets at once or select specific files to remove safely.
-- 📦 **Dev-Friendly**: Zero configuration needed. Works out of the box with standard project structures.
-- 📉 **Size Reports**: View exactly how much space you can save.
+- ⚙️ **Fully Configurable**: Customize extensions and ignore patterns via `.assettracker.json`.
 
 ---
 
@@ -52,6 +53,33 @@ npx assets-tracker clean
 
 ---
 
+## ⚙️ Configuration
+
+Create a `.assettracker.json` in your project root to customize the behavior:
+
+```json
+{
+  "assetExtensions": ["png", "jpg", "svg", "webp", "gif"],
+  "sourceExtensions": ["js", "jsx", "ts", "tsx", "html", "css"],
+  "ignorePatterns": [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/.expo/**",
+    "**/ios/build/**",
+    "**/android/app/build/**"
+  ]
+}
+```
+
+### Options
+| Option | Description | Default |
+| :--- | :--- | :--- |
+| `assetExtensions` | Array of file extensions to treat as assets. | `["png", "jpg", ...]` |
+| `sourceExtensions` | Array of file extensions to scan for references. | `["js", "ts", "jsx", "tsx", ...]` |
+| `ignorePatterns` | Glob patterns of directories/files to ignore. | `["node_modules", "dist", ...]` |
+
+---
+
 ## 📂 Supported Asset Types
 
 - **Images**: `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`, `.webp`, `.ico`
@@ -62,21 +90,10 @@ npx assets-tracker clean
 
 ## 🧠 How It Works
 
-1. **Discovery**: The tool builds a list of all asset files in your project (excluding `node_modules`, `dist`, `.git`, etc.).
-2. **Analysis**: It then parses your source code files to search for any mention of the asset's filename or relative path.
+1. **Discovery**: The tool builds a list of all asset files in your project (excluding ignored paths).
+2. **Analysis**: It parses your source code files (including JSX/TSX) to search for any mention of the asset's filename or relative path.
 3. **Reporting**: Assets that aren't mentioned anywhere are marked as "unused".
-4. **Action**: You get a detailed report and the option to delete them securely.
-
----
-
-## 🛠️ Configuration (Coming Soon)
-
-We are working on adding a `.assettracker.json` config file to allow:
-- Custom asset extensions.
-- Custom source directories.
-- Exclusion patterns.
-
----
+4. **Action**: You get a detailed report and the interactive option to delete them safely.
 
 ---
 

package/dist/config.d.ts

@@ -0,0 +1,7 @@
+export interface Config {
+    assetExtensions?: string[];
+    sourceExtensions?: string[];
+    ignorePatterns?: string[];
+}
+export declare const DEFAULT_CONFIG: Config;
+export declare function loadConfig(cwd: string): Promise<Config>;

package/dist/config.js

@@ -0,0 +1,26 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { DEFAULT_ASSET_EXTENSIONS, DEFAULT_SOURCE_EXTENSIONS, DEFAULT_IGNORE } from './scanner.js';
+export const DEFAULT_CONFIG = {
+    assetExtensions: DEFAULT_ASSET_EXTENSIONS,
+    sourceExtensions: DEFAULT_SOURCE_EXTENSIONS,
+    ignorePatterns: DEFAULT_IGNORE
+};
+export async function loadConfig(cwd) {
+    const configPath = path.join(cwd, '.assettracker.json');
+    if (!(await fs.pathExists(configPath))) {
+        return DEFAULT_CONFIG;
+    }
+    try {
+        const userConfig = await fs.readJson(configPath);
+        return {
+            assetExtensions: userConfig.assetExtensions || DEFAULT_ASSET_EXTENSIONS,
+            sourceExtensions: userConfig.sourceExtensions || DEFAULT_SOURCE_EXTENSIONS,
+            ignorePatterns: userConfig.ignorePatterns || DEFAULT_IGNORE
+        };
+    }
+    catch (error) {
+        console.warn(`\x1b[33m⚠ Warning: Failed to parse .assettracker.json: ${error.message}. Using defaults.\x1b[0m`);
+        return DEFAULT_CONFIG;
+    }
+}