An open API service indexing awesome lists of open source software.

https://github.com/debricked/vs-code-extension

A Visual Studio Code extension that integrates the Debricked CLI to provide security vulnerability scanning and license compliance directly within the editor.
https://github.com/debricked/vs-code-extension

auditing compliance dependency license productivity risk-mitigation scan security vulnerability-scanners

Last synced: about 2 months ago
JSON representation

A Visual Studio Code extension that integrates the Debricked CLI to provide security vulnerability scanning and license compliance directly within the editor.

Awesome Lists containing this project

README

        


Debricked Logo
Debricked: VS Code Extension (In Active Development ๐Ÿšง)






CI


pages-build-deployment


License


GitHub release


GitHub issues


GitHub pull requests


GitHub contributors


GitHub last commit


GitHub commit activity


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


  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:


๐Ÿ“ข 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