🚀 Angular Renamer Extension for Visual Studio Code
📖 Overview
Welcome to the Angular Renamer extension for Visual Studio Code – your ultimate companion for effortless refactoring in Angular projects! 🎉
Are you tired of the tedious process of manually renaming components, services, and other Angular entities? Say goodbye to the hassle! Angular Renamer is here to revolutionize your development workflow, providing lightning-fast, error-free renaming with just a few clicks.
✨ Features That Will Make You Smile
🔄 Intelligent Automatic Renaming
- Rename components, pipes, directives, and services with ease
- All associated files are updated instantly (.ts, .html, .css, .spec.ts, etc.)
🧠 Smart Class Name Updates
- Class names are automatically adjusted to follow Angular best practices
- Keeps your codebase clean and consistent
🔍 Project-Wide Import Path Correction
- Never worry about broken imports again!
- All references across your project are updated seamlessly
- Optimized algorithms ensure speedy renaming, even in large projects
- Minimal impact on your VS Code performance
🛡️ Error Prevention
- Built-in safeguards to prevent common renaming mistakes
- Clear, actionable error messages if something goes wrong
🏗️ Architectural Marvel: Our Project Structure
Dive into the well-organized structure that powers Angular Renamer:
src/
├── components/
│ ├── components_handlers.ts // Component-specific logic
│ ├── handlers.ts // Main component renaming orchestrator
│ ├── index.ts // Convenient exports
│ └── renamers.ts // File and folder renaming utilities
├── general/
│ ├── checker.ts // Entity type identification
│ ├── handlers.ts // Generic renaming logic
│ ├── index.ts // Unified exports
│ └── utilities.ts // Shared helper functions
├── settings/
│ ├── settings.interface.ts // Contain Settings ibterface
│ ├── index.ts // Unified exports and handle function
│ └── utilities.ts
└── extension.ts // Entry point of the extension
🛠️ The Magic Behind the Scenes
🧩 Components Module
components_handlers.ts
: Houses the brilliant minds behind component class name generation and replacement.
handlers.ts
: The maestro orchestrating the entire renaming symphony for components.
renamers.ts
: The skilled artist meticulously renaming files and folders.
🔧 General Module
checker.ts
: Our detective, identifying Angular entities with Sherlock-like precision.
handlers.ts
: The swiss army knife for renaming services, guards, pipes, and directives.
utilities.ts
: A treasure trove of helper functions, making our extension smarter by the day.
🚀 Blasting Off: Getting Started
🔧 Installation in 3... 2... 1...
- Launch your trusty Visual Studio Code
- Navigate to the Extensions view (it's the block-looking icon in the sidebar)
- Search for "Angular Renamer" in the marketplace
- Click that shiny "Install" button and watch the magic happen!
🎮 Usage: As Easy as 1-2-3!
- Spot the Angular entity you want to rename in the Explorer view
- Right-click and select "Rename" (or use the F2 shortcut for the keyboard ninjas)
- Type the new name and hit Enter – then sit back and watch Angular Renamer work its magic!
⚙️ Customization: Make It Yours!
While Angular Renamer works wonders out of the box, we know you love to tinker. Here are some ways to customize your experience:
- Rename Patterns: Define custom patterns for generated class names
- Excluded Folders: Specify folders that should be off-limits for renaming
- File Extensions: Add or remove file extensions to be included in the renaming process
To access these settings:
- Open VS Code settings (File > Preferences > Settings)
- Search for "Angular Renamer"
- Tweak to your heart's content!
🔍 Troubleshooting: We've Got Your Back!
Running into a hiccup? No worries! Try these steps:
- Check the Output Panel: Look for the "Angular Renamer" output channel for detailed logs
- Verify File Permissions: Ensure VS Code has write access to your project files
- Restart VS Code: Sometimes, the old "turn it off and on again" works wonders!
- Update the Extension: Make sure you're running the latest version for all the newest fixes
Still stuck? Don't hesitate to reach out to our support team!
🐛 Found a Bug? Have a Brilliant Idea?
We love hearing from you! Head over to our GitHub Issues page to:
- Report bugs (the more details, the better!)
- Suggest new features (dream big!)
- Engage with other developers
🌟 Want to Contribute?
Awesome! We're always looking for fellow developers to make Angular Renamer even better:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
)
- Commit your changes (
git commit -m 'Add some AmazingFeature'
)
- Push to the branch (
git push origin feature/AmazingFeature
)
- Open a Pull Request
Check out our Contribution Guidelines for more details.
📜 License
Angular Renamer is proudly open source, licensed under the MIT License. See the LICENSE file for the full legal text.
📞 Get in Touch
Questions? Suggestions? Just want to say hi? We'd love to hear from you!
😜🤩 May your Angular coding time be happy and crazy 🤩😜
Empowering developers to focus on what matters most – building amazing Angular applications! 🚀
Made with ❤️ by developers, for developers.