Debricked: VS Code Extension (In Active Development 🚧)

Welcome to the Debricked: VS Code Extension project! This extension integrates Debricked's capabilities directly into your Visual Studio Code environment, enhancing your development workflow with advanced features for security and dependency management.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. ✨ Features
2. 🚀 Installation
3. 💡 Usage
4. 🛠️ Development
   • 📚 Prerequisites
   • 🔧 Setup
   • 🔨 Building
   • 🧪 Testing
5. 🤝 Contributing
6. 📝 License
7. 📢 Acknowledgments
8. 👥 Contributors
9. 🌐 Stay Connected
10. 💬 Support
11. 📢 Acknowledgments
12. 📝 License
13. 📱 Social Media

✨ Features

• Dependency Analysis: Automatically scans and analyzes your project's dependencies.
• Security Alerts: Provides real-time security alerts for known vulnerabilities.
• License Compliance: Ensures your project complies with open source licenses.
• Integration with Debricked: Seamlessly integrates with Debricked's services.

🚀 Installation

To install the Debricked VS Code Extension, follow these steps:

1. Open Visual Studio Code.
2. Go to the Extensions view by clicking the Extensions icon in the Activity Bar on the side of the window.
3. Search for Debricked.
4. Click Install on the Debricked extension.

Alternatively, you can install it via the command line:

  code --install-extension debricked.vscode-extension

💡 Usage

After installing the extension, you can start using it by:

1. Opening any project in VS Code.
2. The extension will automatically scan your project and provide dependency and security analysis in the VS Code interface.
3. Access detailed reports and recommendations from the Debricked panel in the Activity Bar.

🛠️ Development

📚 Prerequisites

Ensure you have the following tools installed:

• Node.js (version 20 or later)
• npm
• Visual Studio Code

🔧 Setup

Clone the repository and install dependencies:

  
    git clone https://github.com/debricked/VS-Code-extension.git
    cd VS-Code-extension
    npm install
  

🔨 Building

To compile the extension, run:

  npm run compile

The compiled files will be located in the dist folder.

🧪 Testing

Run the tests using:

  npm run test

Test coverage reports will be generated in the coverage folder.

🤝 Contributing

We welcome contributions from the community! To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.
6. For detailed guidelines, refer to our Contributing Guide.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.

👥 Contributors

We appreciate all the Contributors who have helped make this project better.

🌐 Stay Connected

GitHub Repository: debricked/VS-Code-extension
Issues & Feedback: Have a question or found a bug? Submit an issue.
Contribute: Interested in contributing? Check out our Contributing Guide.

💬 Support

If you need help or have any questions, feel free to reach out:

• Email: [email protected]
• Community: Join the discussion on our community forum.
• Please ⭐️ this repository if this project helped you!

📢 Acknowledgments

Special thanks to the Debricked team for their support and contributions.

Inspired by the Visual Studio Code Extension Guide.

📝 License

This project is licensed under the MIT License.

📱 Social Media

Follow us on:

Thank you for visiting the debricked VS Code extension. We strive to make this project a valuable tool for developers and appreciate your interest and contributions. Here are a few final notes:

© 2024 debricked. All rights reserved.

back to top