project-to-text 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 IrbadAbdeldjelil
+
+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/README.md

@@ -0,0 +1,115 @@
+# project-to-text
+
+[![npm version](https://img.shields.io/npm/v/project-to-text.svg)](https://www.npmjs.com/package/project-to-text)
+[![license](https://img.shields.io/npm/l/project-to-text.svg)](https://github.com/your-username/project-to-text/blob/main/LICENSE)
+[![downloads](https://img.shields.io/npm/dt/project-to-text.svg)](https://www.npmjs.com/package/project-to-text)
+
+A powerful tool that converts your entire project into a single text file, making it easy to share with AI assistants for code review, analysis, and feedback.
+
+
+## Installation
+
+```bash
+npm install -g project-to-text
+```
+
+## Quick Start
+
+```bash
+cd your-project
+project-to-text
+```
+
+Creates `thisProject.txt` with your project content.
+
+## Usage
+
+### Command Line
+```bash
+# Basic usage
+project-to-text
+
+# Ignore specific files
+project-to-text --ignore "dist/**,*.log"
+
+# Using npx
+npx project-to-text
+```
+
+### Programmatic Usage
+```javascript
+const exporter = require('project-to-text');
+
+// Basic usage
+await exporter();
+
+// With custom ignore patterns
+await exporter('current-file.js', ['dist/**', '*.log']);
+```
+## API
+
+### `exporter(thisFile?, customIgnore?)`
+
+- `thisFile` - Current file name to exclude (optional)
+- `customIgnore` - Array of ignore patterns (optional)
+
+## Features
+
+- Scans entire project structure
+- Smart ignoring of node_modules, build files, etc.
+- Custom ignore patterns
+- Clean formatted output
+- Fast and lightweight
+
+## Default Ignored Files
+
+- `node_modules/**`
+- `.git/**` 
+- `dist/`, `build/`, `coverage/`
+- `*.log`
+- `package-lock.json`
+
+## Output Format
+
+```
+FILE : src/index.js
+CONTENT : // Your code here...
+
+FILE : package.json
+CONTENT : {
+  "name": "my-project"
+}
+```
+
+## Use Cases
+
+- Share code with AI assistants (ChatGPT, Claude, etc.)
+- Code reviews and analysis
+- Project documentation
+- Backup and sharing
+
+
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👨‍💻 Author
+
+**Irbad Abdeldjelil**
+- Email: irbadabdeldjelil@gmail.com
+- GitHub: [@your-username](https://github.com/IrbadAbdeldjelil)
+
+## 🙏 Acknowledgments
+
+- Built with [fast-glob](https://github.com/mrmlnc/fast-glob) for fast file scanning
+- Inspired by the need for better AI code analysis workflows
+
+---
+
+<div align="center">
+
+**If you find this tool helpful, please consider giving it a ⭐ on GitHub!**
+
+</div>
+```

package/bin/exporter.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+const scanner = require('../src/scanner.js');
+const reader = require('../src/reader');
+const fs = require('fs/promises');
+const path = require('path');
+
+// الدالة الرئيسية للتصدير
+async function exporter(thisFile = path.basename(__filename), customIgnore = []) {
+   try {
+     console.log('🔧 Running with ignore patterns:', customIgnore);
+     
+     const projectStruc = await scanner(customIgnore);
+     
+     if(projectStruc.includes('thisProject.txt')) {
+         await fs.rm('thisProject.txt');
+         console.log('🗑️ Deleted old file');
+     }
+     
+     const results = await reader(thisFile, customIgnore);
+     await fs.writeFile('thisProject.txt', results, 'utf8');
+     console.log('✅ Project exported successfully to thisProject.txt');
+     console.log('📊 Total files processed:', projectStruc.length);
+   } catch(error) {
+     console.log('❌ Failed to export:', error.message);
+   }
+}
+
+// معالجة وسيطات CLI بشكل صحيح
+function parseArgs() {
+    const args = process.argv.slice(2);
+    let customIgnore = [];
+    
+    console.log('📨 Raw arguments:', args);
+    
+    for (let i = 0; i < args.length; i++) {
+        if (args[i] === '--ignore' && args[i + 1]) {
+            customIgnore = args[i + 1].split(',');
+            console.log('🎯 Parsed ignore patterns:', customIgnore);
+            break;
+        }
+    }
+    
+    return customIgnore;
+}
+
+// تصدير الدالة للاستخدام كـ module
+module.exports = exporter;
+
+// إذا تم تشغيل الملف مباشرة كـ CLI
+if (require.main === module) {
+    const customIgnore = parseArgs();
+    const thisFile = path.basename(__filename);
+    exporter(thisFile, customIgnore).catch(console.error);
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "project-to-text",
+  "version": "1.0.0",
+  "description": "Convert your project to a single text file for AI analysis and code sharing",
+  "keywords": [
+    "project",
+    "text",
+    "export", 
+    "ai",
+    "analysis",
+    "documentation",
+    "code-sharing"
+  ],
+  "license": "MIT",
+  "author": "Irbad Abdeldjelil <irbadabdeldjelil@gmail.com>",
+  "type": "commonjs",
+  "main": "bin/exporter.js",
+  "bin": {
+    "project-to-text": "bin/exporter.js"
+  },
+  "scripts": {
+    "start": "node bin/exporter.js",
+    "export": "node bin/exporter.js",
+    "test": "echo \"No tests specified\" && exit 0"
+  },
+  "dependencies": {
+    "fast-glob": "^3.3.3"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/irbad/project-to-text"
+  },
+  "homepage": "https://github.com/irbad/project-to-text#readme",
+  "bugs": {
+    "url": "https://github.com/irbad/project-to-text/issues"
+  }
+}

package/src/reader.js

@@ -0,0 +1,17 @@
+const scanner = require('./scanner');
+const fs = require('fs/promises');
+
+module.exports = async function (thisFile, customIgnore = []) {
+    const files = await scanner(customIgnore);
+    let results = '';
+    for (const file of files) {
+         if (file.includes(thisFile)) continue;           
+        // get file content
+        let content = await fs.readFile(file, 'utf8');        
+        // if not empty
+         if (content) {            
+            results += `FILE :  ${file} \nCONTENT : ${content.trim()}\n`;
+         }
+     }
+    return results;
+}

package/src/scanner.js

@@ -0,0 +1,24 @@
+const fg = require('fast-glob');
+
+module.exports = async (customIgnore = []) => {
+    const defaultIgnore = [
+        'node_modules/**',
+        'README.md',
+        'package-lock.json', 
+        'package.json',
+        '.git/**',
+        '.DS_Store',
+        '*.log',
+        'coverage/**',
+        'dist/**',
+        'build/**'
+    ];
+    
+    const ignoreList = [...defaultIgnore, ...customIgnore];
+    
+    const results = await fg('**/**', {
+        ignore: ignoreList,
+        dot: true
+    });
+    return results;
+}