Refactor PowerShell Localization Extension

- Restructured the extension to improve modularity and maintainability.
- Introduced an ExtensionManager class to handle initialization and resource management.
- Added a Logger class for consistent logging throughout the extension.
- Implemented a PowerShellExecutor class for executing PowerShell scripts and parsing localization data.
- Created a LocalizationInlineValuesProvider for providing inline values in PowerShell files.
- Developed a PowerShellModuleScanner to scan and analyze PowerShell modules for localization.
- Enhanced configuration management with a ConfigurationManager class.
- Added utility functions and constants in a new Utils module.
- Updated tests to reflect changes in file paths and configurations.
- Included new images for the extension's assets.
- Improved error handling and logging across various components.

Author: HeyItsGilbert

.vscode/launch.json

@@ -4,12 +4,19 @@
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
 	"version": "0.2.0",
+	"inputs": [
+		{
+			"id": "modulePath",
+			"type": "promptString",
+			"description": "Enter the path to the module (e.g., Example.psm1)"
+		}
+	],
 	"configurations": [
 		{
 			"name": "PowerShell Test LocalizationParser",
 			"type": "PowerShell",
 			"request": "launch",
-			"script": "${workspaceFolder}/src/LocalizationParser.ps1",
+			"script": "${workspaceFolder}/resources/LocalizationParser.ps1",
 			"args": [
 				"${workspaceFolder}/tests/fixtures/Example/Example.psm1",
 				"-Verbose",
@@ -19,14 +26,12 @@
 			"createTemporaryIntegratedConsole": true
 		},
 		{
-			"name": "PowerShell Test LocalizationParser (fr-FR)",
+			"name": "PowerShell Test LocalizationParser (Prompt)",
 			"type": "PowerShell",
 			"request": "launch",
-			"script": "${workspaceFolder}/src/LocalizationParser.ps1",
+			"script": "${workspaceFolder}/resources/LocalizationParser.ps1",
 			"args": [
-				"${workspaceFolder}/tests/fixtures/Example/Example.psm1",
-				"-UICulture",
-				"fr-FR",
+				"${input:modulePath}",
 				"-Verbose",
 				"-Debug"
 			],

ARCHITECTURE.md

@@ -0,0 +1,192 @@
+# PowerShell Localization Extension - Architecture
+
+This document describes the restructured architecture of the PowerShell Localization VS Code extension.
+
+## Architecture Overview
+
+The extension has been restructured following best practices with a modular, maintainable design. The main components are:
+
+### Core Components
+
+#### 1. ExtensionManager (`extensionManager.ts`)
+
+- **Purpose**: Main orchestrator that coordinates all extension components
+- **Responsibilities**:
+  - Extension initialization and cleanup
+  - Component lifecycle management
+  - Configuration change handling
+  - File system watching setup
+
+#### 2. Logger (`logger.ts`)
+
+- **Purpose**: Centralized logging utility
+- **Features**:
+  - Singleton pattern for consistent logging
+  - Multiple log levels (info, error, warn, debug)
+  - Timestamped messages
+  - VS Code output channel integration
+
+#### 3. ConfigurationManager (`configuration.ts`)
+
+- **Purpose**: Manages extension configuration
+- **Features**:
+  - Configuration reading and validation
+  - Change event handling
+  - Type-safe configuration access
+
+#### 4. PowerShellModuleScanner (`moduleScanner.ts`)
+
+- **Purpose**: Scans and analyzes PowerShell module files
+- **Responsibilities**:
+  - Workspace scanning for .psm1 files
+  - Import-LocalizedData detection
+  - Module information caching
+
+#### 5. PowerShellExecutor (`powershellExecutor.ts`)
+
+- **Purpose**: Executes PowerShell scripts and processes
+- **Features**:
+  - PowerShell process management
+  - Error handling and logging
+  - JSON parsing of script output
+  - PowerShell availability checking
+
+#### 6. LocalizationInlineValuesProvider (`inlineValuesProvider.ts`)
+
+- **Purpose**: Provides inline values for localization variables
+- **Features**:
+  - Variable and property detection
+  - Localization data caching
+  - Inline value generation
+  - Performance optimization
+
+### Supporting Files
+
+#### 7. Types (`types.ts`)
+
+- **Purpose**: TypeScript type definitions
+- **Contents**:
+  - Interface definitions
+  - Type aliases
+  - Data structure contracts
+
+#### 8. Utils (`utils.ts`)
+
+- **Purpose**: Constants and utility functions
+- **Contents**:
+  - Extension constants
+  - File type checking utilities
+  - Common helper functions
+  - Regex patterns
+
+#### 9. Extension Entry Point (`extension.ts`)
+
+- **Purpose**: VS Code extension entry point
+- **Responsibilities**:
+  - Extension activation/deactivation
+  - Error handling
+  - ExtensionManager initialization
+
+## Design Principles
+
+### 1. Single Responsibility Principle
+
+Each class has a single, well-defined responsibility:
+
+- Logger handles only logging
+- ConfigurationManager handles only configuration
+- PowerShellExecutor handles only PowerShell execution
+
+### 2. Dependency Injection
+
+Components receive their dependencies through constructors or method parameters, making testing easier and reducing coupling.
+
+### 3. Error Handling
+
+Comprehensive error handling at each layer:
+
+- Try-catch blocks with proper logging
+- Graceful degradation when components fail
+- User-friendly error messages
+
+### 4. Caching Strategy
+
+- Localization data is cached to improve performance
+- Cache invalidation on file changes
+- Memory-efficient cache management
+
+### 5. Configuration-Driven
+
+- All behaviors can be controlled through VS Code settings
+- Runtime configuration changes are supported
+- Type-safe configuration access
+
+## File Structure
+
+```
+src/
+├── extension.ts              # Entry point
+├── extensionManager.ts       # Main coordinator
+├── types.ts                  # Type definitions
+├── utils.ts                  # Constants and utilities
+├── logger.ts                 # Logging utility
+├── configuration.ts          # Configuration management
+├── moduleScanner.ts          # PowerShell module scanning
+├── powershellExecutor.ts     # PowerShell execution
+├── inlineValuesProvider.ts   # Inline values provider
+└── LocalizationParser.ps1   # PowerShell script
+```
+
+## Benefits of This Architecture
+
+### 1. Maintainability
+
+- Clear separation of concerns
+- Easy to understand and modify
+- Consistent code patterns
+
+### 2. Testability
+
+- Each component can be unit tested independently
+- Dependency injection enables mocking
+- Clear interfaces for testing
+
+### 3. Extensibility
+
+- Easy to add new features
+- Minimal impact when changing existing functionality
+- Well-defined extension points
+
+### 4. Performance
+
+- Efficient caching strategies
+- Lazy loading where appropriate
+- Resource cleanup and disposal
+
+### 5. Robustness
+
+- Comprehensive error handling
+- Graceful degradation
+- Resource management
+
+## Usage Patterns
+
+### Adding New Features
+
+1. Define types in `types.ts`
+2. Add constants to `utils.ts`
+3. Create new service classes following existing patterns
+4. Register with `ExtensionManager`
+5. Add configuration options if needed
+
+### Debugging
+
+- Use the Logger singleton for consistent logging
+- Check the "PowerShell Localization" output channel
+- Enable debug logging for detailed information
+
+### Configuration
+
+- All settings are in the `powershelllocalization` section
+- Changes are automatically detected and applied
+- Type-safe access through `ConfigurationManager`

CHANGELOG.md

@@ -1,9 +1,22 @@
 # Change Log
 
-All notable changes to the "powershelllocalization" extension will be documented in this file.
+All notable changes to the "powershelllocalization" extension will be documented
+in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
+to structure this file.
 
-## [Unreleased]
+## [0.1.0] Initial Release
 
-- Initial release
+- Foundational script `LocalizationParser` looks for `psm1` that container
+  `Import-LocalizedData` and using the AST attempt to execute a similar command.
+- Initial configuration options configured:
+  - `enableInlineValues`: False by default. This renders localization variables
+    during debugging.
+  - `enableDecorations`: Shows inline decorators while you write code so you can
+    see the localized text while you work.
+  - `searchExclude`: A list of globs of folders to ignore. This is useful if
+    your module builds output and you don't want to parse it.
+- The extension turns on when it detects PowerShell files.
+- The localized data is cached for efficiency and is reloaded when the psm1 or
+  psd1 files are modified.

PACKAGING.md

@@ -1,6 +1,7 @@
 # Extension Packaging and Installation
 
-This document explains how to package and install the PowerShell Localization extension for development and testing purposes.
+This document explains how to package and install the PowerShell Localization
+extension for development and testing purposes.
 
 ## Quick Start
 

README.md

@@ -1,17 +1,31 @@
 # PowerShell Localization
 
-A Visual Studio Code extension that displays PowerShell localization variable values inline in your editor, making it easier to develop and debug internationalized PowerShell modules.
+A Visual Studio Code extension that displays PowerShell localization variable
+values as decorations in your editor, making it easier to develop and debug
+internationalized PowerShell modules.
+
+![Example showing the inline decorator](static/image.png)
 
 ## Features
 
-- **Inline Value Display**: View localization variable values directly in your PowerShell files
-- **Real-time Updates**: Values update automatically when localization files change  
-- **Multi-language Support**: Works with all localization files (en-US, fr-FR, etc.)
-- **PowerShell Integration**: Seamlessly integrates with PowerShell module development workflow
+- **Live Decoration Display**: View localization variable values as decorations
+  directly in your PowerShell files during code writing (Error Lens style)
+- **Real-time Updates**: Values update automatically when localization files  
+  change
+- **Multi-language Support**: Works with all localization files (en-US, fr-FR,
+  etc.)
+- **PowerShell Integration**: Seamlessly integrates with PowerShell module
+  development workflow
+- **Debug Support**: Optional inline values during debugging sessions
 
 ## How It Works
 
-The extension automatically scans for PowerShell modules (`.psm1` files) and their associated localization data files (`.psd1` files in language-specific folders like `en-US/`, `fr-FR/`, etc.). When you reference localization variables in your PowerShell code using `$LocalizedData.VariableName`, the extension will display the actual localized value inline.
+The extension automatically scans for PowerShell modules (`.psm1` files) and
+their associated localization data files (`.psd1` files in language-specific
+folders like `en-US/`, `fr-FR/`, etc.). When you reference localization
+variables in your PowerShell code using `$LocalizedData.VariableName`, the
+extension will display the actual localized value as a decoration next to your
+code.
 
 ## Requirements
 
@@ -22,7 +36,12 @@ The extension automatically scans for PowerShell modules (`.psm1` files) and the
 
 This extension contributes the following settings:
 
-- `powershelllocalization.enableInlineValues`: Enable/disable inline display of localization variable values
+- `powershellLocalization.enableDecorations`: Enable/disable decoration display
+  of localization variable values during code writing (default: true)
+- `powershellLocalization.enableInlineValues`: Enable/disable inline display of
+  localization variable values during debugging (default: false)
+- `powershellLocalization.searchExclude`: Configure glob patterns for excluding
+  directories and files from PowerShell module scanning
 
 ## Installation
 
@@ -38,7 +57,7 @@ To build and install this extension:
 # Using PowerShell script
 .\package-and-install.ps1
 
-# Using npm scripts  
+# Using npm scripts
 yarn package-install
 
 # Package only
@@ -48,7 +67,8 @@ yarn package-only
 ## Usage
 
 1. Open a PowerShell module (`.psm1` file) that uses localization
-2. Ensure you have localization data files in language folders (e.g., `en-US/ModuleName.psd1`)
+2. Ensure you have localization data files in language folders (e.g.,
+   `en-US/ModuleName.psd1`)
 3. Reference localization variables in your code: `$LocalizedData.MessageText`
 4. The extension will display the actual localized values inline
 
@@ -59,5 +79,3 @@ Contributions are welcome! Please feel free to submit issues and pull requests.
 ## License
 
 MIT
-
-**Enjoy!**