Feature/npm package updates (#9)

* Adding next steps and index fix

* Adds more docs

* Update index.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Burton Podczerwinski <befreestudios@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+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).
+
+## [1.0.0] - 2025-04-28
+
+### Added
+
+- Initial public release
+- Interactive setup wizard for configuring git contexts
+- Multiple context support (personal, work, client projects, etc.)
+- Path-based pattern matching using Git's conditional includes
+- Configuration management with automatic `.gitconfig.d` directory creation
+- Backup functionality for existing git configurations
+- CLI commands: setup, add, remove, list, apply
+
+[1.0.0]: https://github.com/befreestudios-io/git-context-switcher/releases/tag/v1.0.0

README.md

@@ -10,25 +10,41 @@ Switch between git contexts easily for different environments (personal, work, c
 ## Features
 
 ### Interactive Setup Wizard
+
 - Guides you through creating multiple context-specific configurations
 - Automatically organizes the configs in your global .gitconfig file
 
 ### Multiple Context Support
+
 - Supports any number of different contexts (personal, work, client1, client2, etc.)
 - Each context gets its own configuration file
 
 ### Path-Based Pattern Matching
+
 - Uses git's conditional includes based on repository paths
 - Automatically applies the right identity based on where your repositories are located
 
 ### Configuration Management
+
 - Creates a `.gitconfig.d` directory to organize your context-specific configs
 - Backs up your existing configuration before making changes
 - Handles existing conditional includes safely
 
 ## Installation
 
-### Local Installation
+### NPM (Recommended)
+
+The easiest way to install Git Context Switcher:
+
+```bash
+# Install globally for command-line use
+npm install -g git-context-switcher
+
+# After installation, you can use the command from anywhere
+git-context --version
+```
+
+### Local Development Installation
 
 ```bash
 # Clone the repository
@@ -45,12 +61,6 @@ chmod +x index.js
 npm link
 ```
 
-### Global Installation (from npm)
-
-```bash
-npm install -g git-context-switcher
-```
-
 ## Usage
 
 ### Setup Wizard
@@ -62,6 +72,7 @@ git-context setup
 ```
 
 The wizard will:
+
 1. Create a `.gitconfig.d` directory in your home folder
 2. Back up your existing git config
 3. Guide you through setting up multiple contexts
@@ -98,15 +109,19 @@ git-context apply
 Git Context Switcher uses Git's [conditional includes](https://git-scm.com/docs/git-config#_conditional_includes) feature to apply different configurations based on the repository path.
 
 For example, if you have:
+
 - Personal projects in `~/personal/`
 - Work projects in `~/work/`
 
 The tool will create:
+
 1. A `.gitconfig.d` directory with separate config files:
+
    - `.gitconfig.d/personal.gitconfig`
    - `.gitconfig.d/work.gitconfig`
 
 2. Add these conditional includes to your main `.gitconfig`:
+
    ```
    [includeIf "gitdir:~/personal/**"]
        path = ~/.gitconfig.d/personal.gitconfig
@@ -117,6 +132,9 @@ The tool will create:
 
 When you work in different repositories, Git automatically applies the correct configuration based on the repository path.
 
+## Versioning
+
+Git Context Switcher follows [Semantic Versioning](https://semver.org/). For the versions available, see the [tags on this repository](https://github.com/befreestudios-io/git-context-switcher/tags) or check the [CHANGELOG.md](CHANGELOG.md) file.
 
 ## License
 
@@ -136,4 +154,4 @@ Please make sure your code follows the existing style and passes all tests.
 
 ## Security
 
-For security issues, please see our [Security Policy](SECURITY.md).
+For security issues, please see our [Security Policy](SECURITY.md).

index.js

@@ -1,43 +1,55 @@
 #!/usr/bin/env node
 
-import { program } from 'commander';
-import { createGitContextSwitcher } from './lib/gitContextSwitcher.js';
-
+import { program } from "commander";
+import { createGitContextSwitcher } from "./lib/gitContextSwitcher.js";
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+let packageJson;
+try {
+  const packageContent = readFileSync(join(__dirname, "package.json"), "utf8");
+  packageJson = JSON.parse(packageContent);
+} catch (error) {
+  console.error("Error reading or parsing package.json:", error.message);
+  process.exit(1);
+}
 const switcher = createGitContextSwitcher();
 
 program
-  .name('git-context-switcher')
-  .description('A tool to manage multiple git context configurations')
-  .version('1.0.0');
+  .name("git-context-switcher")
+  .description("A tool to manage multiple git context configurations")
+  .version(packageJson.version);
 
 program
-  .command('setup')
-  .description('Run the interactive setup wizard')
+  .command("setup")
+  .description("Run the interactive setup wizard")
   .action(() => switcher.runSetupWizard());
 
 program
-  .command('list')
-  .description('List all configured contexts')
+  .command("list")
+  .description("List all configured contexts")
   .action(() => switcher.listContexts());
 
 program
-  .command('add')
-  .description('Add a new context')
+  .command("add")
+  .description("Add a new context")
   .action(() => switcher.addContext());
 
 program
-  .command('remove')
-  .description('Remove an existing context')
+  .command("remove")
+  .description("Remove an existing context")
   .action(() => switcher.removeContext());
 
 program
-  .command('apply')
-  .description('Apply configuration based on current directory')
+  .command("apply")
+  .description("Apply configuration based on current directory")
   .action(() => switcher.applyContext());
 
 program.parse(process.argv);
 
 // Show help if no command provided
 if (!process.argv.slice(2).length) {
   program.outputHelp();
-}
+}

next-steps.md

@@ -0,0 +1,109 @@
+# Git Context Switcher - Next Steps
+
+## Project Overview
+
+Git Context Switcher is a tool that helps users switch between different Git configurations (personal, work, client projects, etc.) using Git's conditional includes feature. It creates and manages separate config files in the `.gitconfig.d` directory and updates the main `.gitconfig` with appropriate conditional includes.
+
+## Current Status
+
+- Version 1.0.0 published to npm
+- Basic functionality implemented
+- File system operations working properly
+- Tests are in place
+
+## Next Steps
+
+### High Priority
+
+1. **Complete FileSystem service improvements**
+
+   - Finish error handling improvements in the `_ensureTestDirectories` method
+   - Add better error messaging for permission issues
+   - Implement file locking for concurrent operations
+
+2. **Documentation Enhancement**
+
+   - Update README with more detailed examples
+   - Add troubleshooting section
+   - Document all available commands and options
+
+3. **Testing**
+   - Increase test coverage (aim for >80%)
+   - Add more integration tests
+   - Add tests for edge cases around file permissions
+
+### Medium Priority
+
+1. **Feature Enhancements** (v1.1.0)
+
+   - Add support for automatic context detection based on repository URL
+   - Implement context templates for quick setup
+   - Add ability to export/import contexts for sharing
+
+2. **Performance Improvements** (v1.2.0)
+
+   - Optimize file operations for large git config files
+   - Implement caching for frequently accessed configs
+
+3. **User Experience** (v1.3.0)
+   - Improve CLI output with better formatting and colors
+   - Add interactive mode for context setup
+   - Implement context validation
+
+### Low Priority
+
+1. **Platform Specific Enhancements** (v1.4.0)
+
+   - Add specific handling for Windows paths
+   - Create installation scripts for different platforms
+
+2. **Integration** (v1.5.0)
+   - Create hooks for popular IDEs and editors
+   - Add integration with other Git tools
+
+## Version Planning
+
+### Semantic Versioning Guidelines
+
+- **MAJOR (X.0.0)**: Breaking changes that are not backward compatible
+- **MINOR (0.X.0)**: New features that are backward compatible
+- **PATCH (0.0.X)**: Bug fixes and minor improvements that are backward compatible
+
+### Release Planning
+
+1. **v1.0.x Patches**:
+
+   - Bug fixes
+   - Documentation improvements
+   - Minor optimizations
+
+2. **v1.1.0 - v1.5.0**:
+
+   - Feature additions as outlined above
+   - Each feature set should be released as a minor version increment
+
+3. **v2.0.0 (Future)**:
+   - Consider for any breaking changes to the API or CLI interface
+   - Major architectural improvements
+
+### Release Process
+
+1. Update version in package.json
+2. Update CHANGELOG.md with changes
+3. Create git tag for the version
+4. Push to GitHub
+5. Publish to npm
+
+## Notes
+
+- Remember to follow security best practices when dealing with potentially sensitive git config data
+- Keep the validation of path safety as a top priority
+- Consider backward compatibility when making changes
+
+## Implementation Decisions
+
+- Continue using fs-extra for file operations due to its promise support and enhanced API
+- Maintain ES modules pattern for better future compatibility
+- Keep the configuration format simple and compatible with Git's native format
+
+Last updated: April 28, 2025