CodebaseMD 2.0.3

Release Notes - CodebaseMD 2.0.3

Overview

This release focuses on brand refreshment with updated logo and banner images throughout the extension and documentation.

Brand Updates

• New Logo: Updated extension icon for a fresh, modern look
• New Banner: Added new banner image to the README and documentation
• Consistent Branding: Applied the new logo and branding consistently across the extension documentation

Changes

• Updated main logo in VS Code extension
• Added banner image to GitHub README
• Updated logo in documentation files
• Improved visual consistency across all materials

Bug Fixes

• Fixed formatting issues in documentation

Full Changelog

For the full list of changes, please see the commit history.

v2.0.2

CodebaseMD 2.0.2 Release Notes

New Features

• Added comprehensive test suite to ensure code quality and reliability
• Improved handling of different file types and languages
• Enhanced markdown generation for better clarity and organization
• Added advanced code structure analysis in micro export format
• Enhanced detection of programming patterns and code flows
• Improved component representation with visibility indicators
• Added automatic detection of class properties and methods

Bug Fixes

• Fixed issues with file type detection and language mapping
• Resolved various edge cases in folder structure generation
• Enhanced error handling throughout the codebase
• Improved extraction of file metadata
• Fixed pattern detection for different programming paradigms

Development Improvements

• Added test framework with Mocha
• Implemented mock file system for reliable testing
• Added unit tests for core functionality
• Improved TypeScript configuration
• Enhanced code organization and documentation

Next Steps

• Explore adding support for more programming languages
• Consider enhancing the micro export format with additional metadata
• Add support for custom templates in future releases

CodebaseMD v2.0.1

We're excited to announce the release of CodebaseMD v2.0.1, with important improvements to the Micro Codebase Export feature!

Improvements

Enhanced Micro Codebase Export Functionality

This release includes significant improvements to the Micro Codebase Export feature:

• Improved Method Detection: Fixed issues with method detection to eliminate false positives
• Accurate Class Hierarchy: Now correctly detects and displays class inheritance (extends) relationships
• Better Type Information: Improved detection of parameter types and return types
• Variable & Property Accuracy: Fixed property detection to avoid capturing method calls as properties
• Flow Pattern Detection: Added detection of code flow patterns like error handling, async operations, and conditionals
• Static Member Recognition: Properly identifies and marks static methods and properties

Example of Improved Output

C+ TaskManager extends EventEmitter {
  // Class TaskManager
  V- tasks:Map<string, Task> {
  // Property tasks
  }
  V- logger:Logger {
  // Property logger
  }
  V- instance:TaskManager {
  // Static property instance
  }
  F+ createTask(name:string, priority:TaskPriority = TaskPriority.NORMAL):Promise<Task> {
  // Method createTask
  [FLOW: async-await]
  }
  F+ executeTask(taskId:string, fn:() => Promise<any>):Promise<any> {
  // Method executeTask
  [FLOW: error-handling→async-await]
  }
}

Installation

Download the .vsix file from this release and install it in VS Code:

1. Open VS Code
2. Press Ctrl+Shift+X to open the Extensions view
3. Click on the three dots (⋯) in the top right corner
4. Select "Install from VSIX..." and choose the downloaded file

Thank you for using CodebaseMD!

CodebaseMD v2.0.0

We're excited to announce the release of CodebaseMD v2.0.0, featuring a major new capability: Micro Codebase Export!

New Features

Micro Codebase Export

This release introduces a powerful new feature that enables you to create highly condensed, yet informative representations of your code files. The Micro Codebase export reduces code size by approximately 95% while preserving essential structural and functional information.

Key Benefits

• Size Reduction: Condenses large files (2000+ lines) down to approximately 100 lines
• Structural Preservation: Maintains class hierarchies, function relationships, and module dependencies
• Information Density: Uses a specialized notation system to maximize information content
• Pattern Recognition: Automatically identifies and highlights common design patterns in your code

How It Works

The Micro Codebase export applies a sophisticated code condensation algorithm that:

1. Analyzes your code's structure, including classes, functions, dependencies, and patterns
2. Prioritizes information based on visibility, usage, and importance
3. Creates a condensed representation using specialized notation
4. Generates a markdown file with the micro representation of your codebase

How to Use Micro Codebase Export

For the entire codebase:

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS)
2. Type "CodebaseMD: Export Micro Codebase" and select it
3. Choose a location to save the exported Markdown file

For selected files:

1. Select one or more files or folders in the Explorer view
2. Right-click and select "CodebaseMD: Export Selected as Micro Codebase" from the context menu
3. Choose a location to save the exported Markdown file

Understanding the Output Format

The micro codebase representation uses a specialized notation:

// PATH: src/services/auth/UserAuthentication.java [JAVA]
// DESC: Handles user authentication and session management
// DEPS: io.jwt.*, org.security.*, java.util.*

EXPORT [C:2, I:1, F:5]

C+ UserAuthentication implements I:AuthProvider {
  // Core authentication controller
  
  F+ authenticate(user:S, pass:S):AuthResult
    [FLOW: validate→verify→createSession]
    [THROWS: AuthFailedException]
  
  F- verifyPassword(hash:S, input:S):Bool
    [ALG: PBKDF2/SHA256]
  
  V+ sessionStore:Map<S,SessionData>
  V- attempts:Counter
  
  C- SessionData {...}
}

PATTERNS:
- Builder pattern for auth options
- Observer for session events

Where:

• C+ = Public Class
• F- = Private Function/Method
• I# = Protected Interface
• V+ = Public Variable
• S = String type
• FLOW: = Execution flow
• ALG: = Algorithm used

Installation

Download the .vsix file from this release and install it in VS Code:

1. Open VS Code
2. Press Ctrl+Shift+X to open the Extensions view
3. Click on the three dots (⋯) in the top right corner
4. Select "Install from VSIX..." and choose the downloaded file

Thank you for using CodebaseMD!

CodebaseMD v1.0.2

We're excited to announce the release of CodebaseMD v1.0.2!

New Features

.codebaseignore Support

This release adds support for a special .codebaseignore file that works similarly to .gitignore but is specifically for controlling what file contents are exported:

• Files matching patterns in .codebaseignore will still be included in the folder structure
• Their contents will be excluded from the export, showing "(File content excluded by .codebaseignore)" instead
• The .codebaseignore file uses the same syntax as .gitignore

How to Use .codebaseignore

1. Create a .codebaseignore file in the root of your workspace
2. Add file patterns following standard gitignore syntax
3. Run the export command - files matching these patterns will be in the structure but their contents won't be included

Example .codebaseignore file:

# Exclude all test files
*.test.js
*.spec.js
__tests__/

# Exclude configuration files
.eslintrc
.prettierrc
tsconfig.json

# Exclude specific files or directories
src/legacy/
temp.js

Installation

Download the .vsix file from this release and install it in VS Code:

1. Open VS Code
2. Press Ctrl+Shift+X to open the Extensions view
3. Click on the three dots (⋯) in the top right corner
4. Select "Install from VSIX..." and choose the downloaded file

Thank you for using CodebaseMD!

CodebaseMD v1.0.1

This release includes:

• New Logo: A clean and minimalist logo added to the extension.
• Updated package.json to reference the logo in the marketplace.

Thank you for using CodebaseMD!

CodebaseMD v1.0.0

CodebaseMD is a Visual Studio Code extension that allows you to export your entire codebase or selected files into a Markdown file.

Key Features:

• 1-Click Export Entire Codebase as Markdown
  • Export your entire project with the folder structure and code files in a single markdown file.
• Exclude Unnecessary Files Automatically
  • Files like node_modules, build, out, and files listed in .gitignore are automatically excluded.
• Export Selected Files
  • Right-click on selected files or folders in the Explorer pane to export them to a Markdown file.
• Markdown-Compatible Output
  • Actively coded files with supported extensions are exported with their contents. Unsupported file types are listed with only their file name and path.

How to Install

1. Download the .vsix file from this release.
2. Open VS Code.
3. Click on the Extensions sidebar icon (Ctrl+Shift+X or Cmd+Shift+X).
4. Click on the three dots in the top-right corner and select Install from VSIX.
5. Choose the downloaded .vsix file.

Example Output

Each exported markdown file includes:

• Project statistics (number of files).
• A tree structure of the project.
• Code blocks for supported file types.
• Unsupported file types listed by name and path.

Supported File Types

• JavaScript/TypeScript: .js, .ts, .jsx, .tsx
• HTML/CSS: .html, .css, .scss
• Python: .py
• C/C++: .c, .cpp, .h
• Java: .java
• Markdown: .md
• And many more...

License

This extension is licensed under the MIT License. For more information, see the LICENSE file.

---

Author

• Alphin Tom
• Email: alphinctom@gmail.com
• GitHub: alpha912