-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6c9b048
commit 79c5d77
Showing
1 changed file
with
84 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,110 @@ | ||
| # VS-Code-extension README | ||
|
|
||
| This is the README for your extension "VS-Code-extension". After writing up a brief description, we recommend including the following sections. | ||
| # Debricked: VS Code Extension | ||
|
|
||
| [](https://github.com/debricked/VS-Code-extension/actions) | ||
| [](https://github.com/debricked/VS-Code-extension/coverage) | ||
|
|
||
| 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. | ||
|
|
||
| ## Table of Contents | ||
| - [Features](#features) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Development](#development) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Setup](#setup) | ||
| - [Building](#building) | ||
| - [Testing](#testing) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| - [Acknowledgments](#acknowledgments) | ||
| - [Footer](#footer) | ||
| - [Sidebar](#sidebar) | ||
| - [Contributors](#contributors) | ||
| - [Milestones](#milestones) | ||
|
|
||
| ## Features | ||
|
|
||
| Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. | ||
|
|
||
| For example if there is an image subfolder under your extension project workspace: | ||
|
|
||
| \!\[feature X\]\(images/feature-x.png\) | ||
|
|
||
| > Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. | ||
| ## Requirements | ||
|
|
||
| If you have any requirements or dependencies, add a section describing those and how to install and configure them. | ||
|
|
||
| ## Extension Settings | ||
|
|
||
| Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. | ||
| - **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. | ||
|
|
||
| For example: | ||
| ## Installation | ||
|
|
||
| This extension contributes the following settings: | ||
| To install the Debricked VS Code Extension, follow these steps: | ||
|
|
||
| * `myExtension.enable`: Enable/disable this extension. | ||
| * `myExtension.thing`: Set to `blah` to do something. | ||
| 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. | ||
|
|
||
| ## Known Issues | ||
| Alternatively, you can install it via the command line: | ||
|
|
||
| Calling out known issues can help limit users opening duplicate issues against your extension. | ||
| ```sh | ||
| code --install-extension debricked.vscode-extension | ||
| ``` | ||
|
|
||
| ## Release Notes | ||
| ## Usage | ||
| After installing the extension, you can start using it by: | ||
|
|
||
| Users appreciate release notes as you update your extension. | ||
| 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. | ||
|
|
||
| ### 1.0.0 | ||
| ## Development | ||
| ### Prerequisites | ||
| Ensure you have the following tools installed: | ||
|
|
||
| Initial release of ... | ||
| - Node.js (version 14 or later) | ||
| - npm | ||
| - Visual Studio Code | ||
|
|
||
| ### 1.0.1 | ||
| ### Setup | ||
| Clone the repository and install dependencies: | ||
|
|
||
| Fixed issue #. | ||
| ```sh | ||
| git clone https://github.com/debricked/VS-Code-extension.git | ||
| cd VS-Code-extension | ||
| npm install | ||
| ``` | ||
|
|
||
| ### 1.1.0 | ||
| ### Building | ||
| To compile the extension, run: | ||
|
|
||
| Added features X, Y, and Z. | ||
| ```sh | ||
| npm run compile | ||
| ``` | ||
|
|
||
| --- | ||
| The compiled files will be located in the dist folder. | ||
|
|
||
| ## Following extension guidelines | ||
| ### Testing | ||
| Run the tests using: | ||
|
|
||
| Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. | ||
| ```sh | ||
| npm run test | ||
| ``` | ||
|
|
||
| * [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) | ||
| Test coverage reports will be generated in the coverage folder. | ||
|
|
||
| ## Working with Markdown | ||
| ## Contributing | ||
| We welcome contributions from the community! To contribute, please follow these steps: | ||
|
|
||
| You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: | ||
| 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. | ||
|
|
||
| * Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). | ||
| * Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). | ||
| * Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. | ||
| ## License | ||
| This project is licensed under the MIT License. See the LICENSE file for details. | ||
|
|
||
| ## For more information | ||
| ## Acknowledgments | ||
| - Special thanks to the Debricked team for their support and contributions. | ||
| - Inspired by the Visual Studio Code Extension Guide. | ||
|
|
||
| * [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) | ||
| * [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) | ||
| ## Contributors | ||
| We appreciate all the Contributors who have helped make this project better. | ||
|
|
||
| **Enjoy!** | ||
| ## Milestones | ||
| Check out our Milestones to see our project roadmap and upcoming features. |