feat: add .codebaseignore support to exclude file contents from export

Author: alpha912

RELEASE-NOTES-1.0.2.md

@@ -0,0 +1,47 @@
+# CodebaseMD v1.0.2 Release Notes
+
+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! 

docs/changelog.md

@@ -1,18 +1,31 @@
 # Changelog
 
-All notable changes to the CodebaseMD extension will be documented in this file.
+All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.0.2] - 2025-03-16
+
+### Added
+- `.codebaseignore` file support - Allows excluding file contents from export while keeping files in the directory structure
+
+## [1.0.1] - 2024-09-26
+
+### Added
+- New logo: A clean and minimalist logo added to the extension
+- Updated package.json to reference the logo in the marketplace
+
 ## [1.0.0] - 2024-09-26
 
 ### Added
-- Initial release of CodebaseMD
-- Feature to export entire codebase as Markdown
-- Feature to export selected files and folders as Markdown
-- Automatic exclusion of files and folders based on .gitignore and common patterns
-- Support for multiple file types
+- Initial release
+- Export entire codebase as Markdown
+- Export selected files or folders as Markdown
+- Automatically exclude files based on .gitignore and default patterns
+- File content syntax highlighting in exported Markdown
 - Folder structure visualization in the generated Markdown
 - Project statistics in the generated Markdown
 
@@ -31,9 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - N/A (Initial release)
 
-## [Unreleased]
-
-### Planned Features
+## Planned Features
 - User-configurable ignore patterns
 - Option to include or exclude specific file types
 - Customizable Markdown output format

docs/configuration.md

@@ -2,6 +2,31 @@
 
 Currently, CodebaseMD does not have user-configurable settings through the Visual Studio Code settings interface. However, you can customize some behaviors by modifying the source code directly.
 
+## Using .codebaseignore File
+
+CodebaseMD supports a special `.codebaseignore` file that works similarly to `.gitignore` but specifically for controlling what file contents are exported:
+
+1. Create a `.codebaseignore` file in the root of your workspace
+2. Add file patterns following the same syntax as `.gitignore`
+3. Files matching these patterns will still be listed in the folder structure but their contents will be excluded from the export
+
+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
+```
+
 ## Customizing Ignored Files and Directories
 
 To change which files and directories are ignored during export:

docs/usage.md

@@ -1,22 +1,36 @@
 # Usage
 
-CodebaseMD provides two main functionalities: exporting your entire codebase and exporting selected files or folders.
+CodebaseMD provides two main commands to export your codebase to a Markdown file:
+
+1. **Export All**: Export the entire codebase to a Markdown file
+2. **Export Selected**: Export only the selected files or folders to a Markdown file
 
 ## Exporting the Entire Codebase
 
-1. Open your project in Visual Studio Code
-2. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
-3. Search for and select "Export Codebase as Markdown"
+1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS)
+2. Type "CodebaseMD: Export All" and select it
+3. Choose a location to save the exported Markdown file
+4. The extension will process all files in your workspace, excluding files specified in `.gitignore` or default ignore patterns
+5. Once complete, you will see a notification that the file was saved successfully
+
+## Exporting Selected Files
+
+1. Select one or more files or folders in the Explorer view
+2. Right-click and select "CodebaseMD: Export Selected" from the context menu
+3. Alternatively, open the Command Palette and type "CodebaseMD: Export Selected" (you need to have selected files first)
 4. Choose a location to save the exported Markdown file
-5. The extension will generate a Markdown file containing your project's structure and file contents
+5. The extension will process only the selected files, still respecting ignore patterns
+6. Once complete, you will see a notification that the file was saved successfully
+
+## Excluding Files from Content Export
+
+You can exclude files from having their contents exported while still keeping them in the folder structure by using a `.codebaseignore` file:
 
-## Exporting Selected Files or Folders
+1. Create a `.codebaseignore` file in the root of your workspace
+2. Add patterns using the same syntax as `.gitignore`
+3. When exporting, files matching these patterns will be included in the folder structure but will show a message indicating their contents were excluded
 
-1. In the Explorer view, select one or more files or folders you want to export
-2. Right-click on the selection
-3. Choose "Export Selected as Markdown" from the context menu
-4. Select a location to save the exported Markdown file
-5. The extension will generate a Markdown file containing the structure and contents of your selected files and folders
+This is useful for files that you want to acknowledge exist in your project structure but don't need to include their full contents in the export.
 
 ## Understanding the Output
 

package-lock.json

@@ -2,7 +2,7 @@
   "name": "codebase-md",
   "displayName": "CodebaseMD",
   "description": "Export your entire codebase or selected files as a Markdown file.",
-  "version": "1.0.1", 
+  "version": "1.0.2", 
   "publisher": "alpha912",
   "engines": {
     "vscode": "^1.70.0"
@@ -36,7 +36,7 @@
       "explorer/context": [
         {
           "command": "codebaseMD.exportSelected",
-          "when": "explorerResourceIsFo­lder || resourceFilename",
+          "when": "explorerResourceIsFolder || resourceFilename",
           "group": "navigation"
         }
       ]

package.json

@@ -0,0 +1,47 @@
+# CodebaseMD v1.0.2 Release Notes
+
+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! 

releases/RELEASE-NOTES-1.0.2.md

@@ -43,6 +43,7 @@ async function exportSelectedFiles(uris: vscode.Uri[]) {
 
 async function getAllFiles(dir: string): Promise<string[]> {
   const ig = createIgnoreInstance(dir);
+  const codebaseIgnoreFiles = getCodebaseIgnoreFiles(dir);
   const files: string[] = [];
 
   async function traverse(currentDir: string) {
@@ -75,6 +76,7 @@ async function getFilesFromUris(uris: vscode.Uri[]): Promise<string[]> {
   const files: string[] = [];
   const rootPath = vscode.workspace.workspaceFolders![0].uri.fsPath;
   const ig = createIgnoreInstance(rootPath);
+  const codebaseIgnoreFiles = getCodebaseIgnoreFiles(rootPath);
 
   async function processUri(currentUri: vscode.Uri) {
     const stat = await vscode.workspace.fs.stat(currentUri);
@@ -143,6 +145,16 @@ function createIgnoreInstance(rootDir: string): Ignore {
   return ig;
 }
 
+function getCodebaseIgnoreFiles(rootDir: string): Ignore {
+  const ig = ignore();
+  const codebaseIgnorePath = path.join(rootDir, '.codebaseignore');
+  if (fs.existsSync(codebaseIgnorePath)) {
+    const codebaseIgnoreContent = fs.readFileSync(codebaseIgnorePath, 'utf8');
+    ig.add(codebaseIgnoreContent);
+  }
+  return ig;
+}
+
 function isLargeFile(fileName: string): boolean {
   const largeFiles = ['package-lock.json', 'yarn.lock'];
   return largeFiles.includes(fileName);
@@ -159,8 +171,14 @@ function isSupportedFile(fileName: string): boolean {
   return supportedExtensions.includes(ext);
 }
 
+function shouldIncludeFileContents(filePath: string, rootPath: string, codebaseIgnoreFiles: Ignore): boolean {
+  const relativePath = path.relative(rootPath, filePath);
+  return !codebaseIgnoreFiles.ignores(relativePath) && isSupportedFile(path.basename(filePath));
+}
+
 async function generateMarkdown(files: string[], rootPath: string): Promise<string> {
   let markdown = `# Project Export\n\n`;
+  const codebaseIgnoreFiles = getCodebaseIgnoreFiles(rootPath);
 
   // Project statistics
   markdown += `## Project Statistics\n\n`;
@@ -178,13 +196,15 @@ async function generateMarkdown(files: string[], rootPath: string): Promise<stri
     const fileName = path.basename(file);
     markdown += `\n### ${relativePath}\n\n`;
 
-    if (isSupportedFile(fileName)) {
+    if (shouldIncludeFileContents(file, rootPath, codebaseIgnoreFiles)) {
       const code = fs.readFileSync(file, 'utf8');
       const ext = path.extname(file).substring(1);
       markdown += '```' + ext + '\n';
       markdown += code;
       markdown += '\n```\n';
-    } else {
+    } else if (codebaseIgnoreFiles.ignores(relativePath)) {
+      markdown += `*(File content excluded by .codebaseignore)*\n`;
+    } else if (!isSupportedFile(fileName)) {
       markdown += `*(Unsupported file type)*\n`;
     }
   }