codesummary 1.0.0 → 1.0.2

package/README.md

@@ -31,11 +31,13 @@ npm install -g codesummary
 ## 🎯 Quick Start
 
 1. **First-time setup** (interactive wizard):
+
    ```bash
    codesummary
    ```
 
 2. **Generate PDF for current project**:
+
    ```bash
    cd /path/to/your/project
    codesummary
@@ -140,39 +142,76 @@ CodeSummary stores global configuration in:
 
 ```json
 {
-  \"output\": {
-    \"mode\": \"fixed\",
-    \"fixedPath\": \"~/Desktop/CodeSummaries\"
+  "output": {
+    "mode": "fixed",
+    "fixedPath": "~/Desktop/CodeSummaries"
   },
-  \"allowedExtensions\": [
-    \".json\", \".ts\", \".js\", \".jsx\", \".tsx\", \".xml\", \".html\",
-    \".css\", \".scss\", \".md\", \".txt\", \".py\", \".java\", \".cs\",
-    \".cpp\", \".c\", \".h\", \".yaml\", \".yml\", \".sh\", \".bat\",
-    \".ps1\", \".php\", \".rb\", \".go\", \".rs\", \".swift\", \".kt\",
-    \".scala\", \".vue\", \".svelte\", \".dockerfile\", \".sql\", \".graphql\"
+  "allowedExtensions": [
+    ".json",
+    ".ts",
+    ".js",
+    ".jsx",
+    ".tsx",
+    ".xml",
+    ".html",
+    ".css",
+    ".scss",
+    ".md",
+    ".txt",
+    ".py",
+    ".java",
+    ".cs",
+    ".cpp",
+    ".c",
+    ".h",
+    ".yaml",
+    ".yml",
+    ".sh",
+    ".bat",
+    ".ps1",
+    ".php",
+    ".rb",
+    ".go",
+    ".rs",
+    ".swift",
+    ".kt",
+    ".scala",
+    ".vue",
+    ".svelte",
+    ".dockerfile",
+    ".sql",
+    ".graphql"
   ],
-  \"excludeDirs\": [
-    \"node_modules\", \".git\", \".vscode\", \"dist\", \"build\",
-    \"coverage\", \"out\", \"__pycache__\", \".next\", \".nuxt\"
+  "excludeDirs": [
+    "node_modules",
+    ".git",
+    ".vscode",
+    "dist",
+    "build",
+    "coverage",
+    "out",
+    "__pycache__",
+    ".next",
+    ".nuxt"
   ],
-  \"styles\": {
-    \"colors\": {
-      \"title\": \"#333353\",
-      \"section\": \"#00FFB9\",
-      \"text\": \"#333333\",
-      \"error\": \"#FF4D4D\",
-      \"footer\": \"#666666\"
+  "styles": {
+    "colors": {
+      "title": "#333353",
+      "section": "#00FFB9",
+      "text": "#333333",
+      "error": "#FF4D4D",
+      "footer": "#666666"
     },
-    \"layout\": {
-      \"marginLeft\": 40,
-      \"marginTop\": 40,
-      \"marginRight\": 40,
-      \"footerHeight\": 20
+    "layout": {
+      "marginLeft": 40,
+      "marginTop": 40,
+      "marginRight": 40,
+      "footerHeight": 20
     }
   },
-  \"settings\": {
-    \"documentTitle\": \"Project Code Summary\",
-    \"maxFilesBeforePrompt\": 500
+  "settings": {
+    "documentTitle": "Project Code Summary",
+    "maxFilesBeforePrompt": 500
   }
 }
 ```
@@ -182,16 +221,19 @@ CodeSummary stores global configuration in:
 Generated PDFs use **A4 format** with optimized margins and contain three main sections:
 
 ### 1. Project Overview
+
 - Document title and project name
 - Generation timestamp
 - List of included file types with descriptions
 
 ### 2. File Structure
+
 - Complete hierarchical listing of all included files
 - Organized by relative paths from project root
 - Sorted alphabetically for easy navigation
 
 ### 3. File Content
+
 - **Complete source code** for each file (no truncation)
 - Proper formatting with monospace fonts for code
 - Intelligent text wrapping without overlap
@@ -229,24 +271,24 @@ MYPROJECT_code_20250729_141602.pdf
 
 CodeSummary supports an extensive range of text-based file formats:
 
-| Extension | Language/Type  | Extension    | Language/Type     |
-| --------- | -------------- | ------------ | ----------------- |
-| `.js`     | JavaScript     | `.py`        | Python            |
-| `.ts`     | TypeScript     | `.java`      | Java              |
-| `.jsx`    | React JSX      | `.cs`        | C#                |
-| `.tsx`    | TypeScript JSX | `.cpp`       | C++               |
-| `.json`   | JSON           | `.c`         | C                 |
-| `.xml`    | XML            | `.h`         | Header            |
-| `.html`   | HTML           | `.yaml/.yml` | YAML              |
-| `.css`    | CSS            | `.sh`        | Shell Script      |
-| `.scss`   | SCSS           | `.bat`       | Batch File        |
-| `.md`     | Markdown       | `.ps1`       | PowerShell        |
-| `.txt`    | Plain Text     | `.php`       | PHP               |
-| `.go`     | Go             | `.rb`        | Ruby              |
-| `.rs`     | Rust           | `.swift`     | Swift             |
-| `.kt`     | Kotlin         | `.scala`     | Scala             |
-| `.vue`    | Vue.js         | `.svelte`    | Svelte            |
-| `.sql`    | SQL            | `.graphql`   | GraphQL           |
+| Extension | Language/Type  | Extension    | Language/Type |
+| --------- | -------------- | ------------ | ------------- |
+| `.js`     | JavaScript     | `.py`        | Python        |
+| `.ts`     | TypeScript     | `.java`      | Java          |
+| `.jsx`    | React JSX      | `.cs`        | C#            |
+| `.tsx`    | TypeScript JSX | `.cpp`       | C++           |
+| `.json`   | JSON           | `.c`         | C             |
+| `.xml`    | XML            | `.h`         | Header        |
+| `.html`   | HTML           | `.yaml/.yml` | YAML          |
+| `.css`    | CSS            | `.sh`        | Shell Script  |
+| `.scss`   | SCSS           | `.bat`       | Batch File    |
+| `.md`     | Markdown       | `.ps1`       | PowerShell    |
+| `.txt`    | Plain Text     | `.php`       | PHP           |
+| `.go`     | Go             | `.rb`        | Ruby          |
+| `.rs`     | Rust           | `.swift`     | Swift         |
+| `.kt`     | Kotlin         | `.scala`     | Scala         |
+| `.vue`    | Vue.js         | `.svelte`    | Svelte        |
+| `.sql`    | SQL            | `.graphql`   | GraphQL       |
 
 ## 🛠️ Development
 
@@ -289,20 +331,24 @@ node bin/codesummary.js
 ### Common Issues
 
 **Configuration not found**
+
 - Run `codesummary` to trigger first-time setup
 - Check file permissions in config directory
 
 **PDF generation fails**
+
 - Verify output directory permissions
 - Ensure Node.js version ≥18.0.0
 - Close any open PDF viewers on the target file
 
 **Files not showing up**
+
 - Check that file extensions are in `allowedExtensions`
 - Verify directories aren't in `excludeDirs` list
 - Ensure files are text-based (not binary)
 
 **Large project performance**
+
 - Adjust `maxFilesBeforePrompt` in configuration
 - Use extension filtering to reduce file count
 - CodeSummary handles large files efficiently with streaming
@@ -367,4 +413,4 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
 
 ---
 
-**Made with ❤️ for developers worldwide**
+**Made with ❤️ for developers worldwide**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codesummary",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Cross-platform CLI tool that automatically generates comprehensive PDF documentation from project source code with complete content processing and smart conflict handling",
   "main": "src/index.js",
   "type": "module",
@@ -81,4 +81,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}