saulteafarmer/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Stirling-Tools/Stirling-PDF.git synced 2025-04-22 16:51:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Stirling-PDF/.vscode/extensions.json

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

21 lines
1.5 KiB
JSON
Raw Permalink Normal View History

VS Code Extensions for Development (#2826) # Description of Changes # Introduce Recommended VS Code Extensions for Development ## Summary This PR introduces a curated list of recommended Visual Studio Code extensions to enhance the development workflow for Python, Java, and Spring Boot projects. These extensions provide essential features such as code formatting, linting, debugging, dependency management, and remote development support. ## Motivation Setting up a consistent development environment can be challenging, especially when working in a team. By providing a predefined list of VS Code extensions, we ensure that all developers have access to the necessary tools for an efficient and streamlined workflow. This helps maintain code quality, improves productivity, and reduces configuration overhead. ## Benefits - **Improved Code Quality**: Extensions like `black-formatter`, `flake8`, and `checkstyle` enforce best coding practices. - **Enhanced Debugging and Development**: Java and Python-specific extensions provide powerful debugging, IntelliSense, and dependency management capabilities. - **Spring Boot Support**: Tools like `vscode-spring-boot-dashboard` and `vscode-spring-initializr` streamline Spring Boot application development. - **Remote Development Capabilities**: Extensions like `remote-containers` and `remote-extensionpack` enable seamless development in containerized and remote environments. - **Consistency Across Team Members**: Ensures a unified development experience across all contributors, reducing the time spent on setup and troubleshooting. ## Changes Introduced - Added a `.vscode/extensions.json` file containing a list of recommended VS Code extensions. - The list includes extensions for: - Python development (formatting, linting, debugging) - Java development (code formatting, debugging, dependency management, Gradle) - Spring Boot development (Spring Boot dashboard, Spring Initializr, etc.) - Remote development support (Containers, SSH, WSL) - Code spell checking and pre-commit hook management ## How to Use 1. Open VS Code. 2. When prompted, install the recommended extensions. 3. Alternatively, open the command palette (`Ctrl + Shift + P` or `Cmd + Shift + P` on macOS) and run: ```sh Extensions: Show Recommended Extensions ``` 4. Install the required extensions from the list. ## Next Steps - Developers should install the recommended extensions to take full advantage of the improvements. - Optionally, update the list in `.vscode/extensions.json` if new extensions are required in the future. --- ### References - [VS Code Extension Recommendations](https://code.visualstudio.com/docs/editor/extension-gallery#_workspace-recommended-extensions) - [Prettier for Code Formatting](https://prettier.io/) - [Flake8 Linter for Python](https://flake8.pycqa.org/en/latest/) Let me know if you have any feedback or suggestions! --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
2025-02-01 00:34:04 +01:00
{
"recommendations": [
"elagil.pre-commit-helper", // Support for pre-commit hooks to enforce code quality
"josevseb.google-java-format-for-vs-code", // Google Java code formatter to follow the Google Java Style Guide
"ms-python.black-formatter", // Python code formatter using Black
"ms-python.flake8", // Flake8 linter for Python to enforce code quality
"ms-python.python", // Official Microsoft Python extension with IntelliSense, debugging, and Jupyter support
Update VS Code extensions: Remove unnecessary Java tools and add new tools like EditorConfig, Docker and GitHub extensions. (#3147) # Description of Changes Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
2025-03-10 09:20:51 +01:00
"ms-vscode-remote.vscode-remote-extensionpack", // Remote Development Pack for SSH, WSL, and Containers
Removed conflicting Oracle Java extension from devcontainer and VS Code config (#3292) # Description of Changes Please provide a summary of the changes, including: - Commented out the `Oracle.oracle-java` extension in `.devcontainer/devcontainer.json` and `.vscode/extensions.json`. - Reason: The Oracle Java extension conflicts with **Language Support for Java™ by Red Hat**, which is already included in the `vscjava.vscode-java-pack`. - This cleanup improves developer experience by avoiding extension conflicts and potential Java tooling issues in VS Code. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
2025-04-03 11:02:57 +00:00
// "Oracle.oracle-java", // Oracle Java extension with additional features for Java development
VS Code Extensions for Development (#2826) # Description of Changes # Introduce Recommended VS Code Extensions for Development ## Summary This PR introduces a curated list of recommended Visual Studio Code extensions to enhance the development workflow for Python, Java, and Spring Boot projects. These extensions provide essential features such as code formatting, linting, debugging, dependency management, and remote development support. ## Motivation Setting up a consistent development environment can be challenging, especially when working in a team. By providing a predefined list of VS Code extensions, we ensure that all developers have access to the necessary tools for an efficient and streamlined workflow. This helps maintain code quality, improves productivity, and reduces configuration overhead. ## Benefits - **Improved Code Quality**: Extensions like `black-formatter`, `flake8`, and `checkstyle` enforce best coding practices. - **Enhanced Debugging and Development**: Java and Python-specific extensions provide powerful debugging, IntelliSense, and dependency management capabilities. - **Spring Boot Support**: Tools like `vscode-spring-boot-dashboard` and `vscode-spring-initializr` streamline Spring Boot application development. - **Remote Development Capabilities**: Extensions like `remote-containers` and `remote-extensionpack` enable seamless development in containerized and remote environments. - **Consistency Across Team Members**: Ensures a unified development experience across all contributors, reducing the time spent on setup and troubleshooting. ## Changes Introduced - Added a `.vscode/extensions.json` file containing a list of recommended VS Code extensions. - The list includes extensions for: - Python development (formatting, linting, debugging) - Java development (code formatting, debugging, dependency management, Gradle) - Spring Boot development (Spring Boot dashboard, Spring Initializr, etc.) - Remote development support (Containers, SSH, WSL) - Code spell checking and pre-commit hook management ## How to Use 1. Open VS Code. 2. When prompted, install the recommended extensions. 3. Alternatively, open the command palette (`Ctrl + Shift + P` or `Cmd + Shift + P` on macOS) and run: ```sh Extensions: Show Recommended Extensions ``` 4. Install the required extensions from the list. ## Next Steps - Developers should install the recommended extensions to take full advantage of the improvements. - Optionally, update the list in `.vscode/extensions.json` if new extensions are required in the future. --- ### References - [VS Code Extension Recommendations](https://code.visualstudio.com/docs/editor/extension-gallery#_workspace-recommended-extensions) - [Prettier for Code Formatting](https://prettier.io/) - [Flake8 Linter for Python](https://flake8.pycqa.org/en/latest/) Let me know if you have any feedback or suggestions! --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
2025-02-01 00:34:04 +01:00
"streetsidesoftware.code-spell-checker", // Spell checker for code to avoid typos
"vmware.vscode-boot-dev-pack", // Developer tools for Spring Boot by VMware
"vscjava.vscode-java-pack", // Java Extension Pack with essential Java tools for VS Code
"vscjava.vscode-spring-boot-dashboard", // Spring Boot dashboard for managing and visualizing Spring Boot applications
Update VS Code extensions: Remove unnecessary Java tools and add new tools like EditorConfig, Docker and GitHub extensions. (#3147) # Description of Changes Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
2025-03-10 09:20:51 +01:00
"EditorConfig.EditorConfig", // EditorConfig support for maintaining consistent coding styles
"ms-azuretools.vscode-docker", // Docker extension for Visual Studio Code
"GitHub.copilot", // GitHub Copilot AI pair programmer for Visual Studio Code
"GitHub.vscode-pull-request-github", // GitHub Pull Requests extension for Visual Studio Code
"charliermarsh.ruff" // Ruff code formatter for Python to follow the Ruff Style Guide
VS Code Extensions for Development (#2826) # Description of Changes # Introduce Recommended VS Code Extensions for Development ## Summary This PR introduces a curated list of recommended Visual Studio Code extensions to enhance the development workflow for Python, Java, and Spring Boot projects. These extensions provide essential features such as code formatting, linting, debugging, dependency management, and remote development support. ## Motivation Setting up a consistent development environment can be challenging, especially when working in a team. By providing a predefined list of VS Code extensions, we ensure that all developers have access to the necessary tools for an efficient and streamlined workflow. This helps maintain code quality, improves productivity, and reduces configuration overhead. ## Benefits - **Improved Code Quality**: Extensions like `black-formatter`, `flake8`, and `checkstyle` enforce best coding practices. - **Enhanced Debugging and Development**: Java and Python-specific extensions provide powerful debugging, IntelliSense, and dependency management capabilities. - **Spring Boot Support**: Tools like `vscode-spring-boot-dashboard` and `vscode-spring-initializr` streamline Spring Boot application development. - **Remote Development Capabilities**: Extensions like `remote-containers` and `remote-extensionpack` enable seamless development in containerized and remote environments. - **Consistency Across Team Members**: Ensures a unified development experience across all contributors, reducing the time spent on setup and troubleshooting. ## Changes Introduced - Added a `.vscode/extensions.json` file containing a list of recommended VS Code extensions. - The list includes extensions for: - Python development (formatting, linting, debugging) - Java development (code formatting, debugging, dependency management, Gradle) - Spring Boot development (Spring Boot dashboard, Spring Initializr, etc.) - Remote development support (Containers, SSH, WSL) - Code spell checking and pre-commit hook management ## How to Use 1. Open VS Code. 2. When prompted, install the recommended extensions. 3. Alternatively, open the command palette (`Ctrl + Shift + P` or `Cmd + Shift + P` on macOS) and run: ```sh Extensions: Show Recommended Extensions ``` 4. Install the required extensions from the list. ## Next Steps - Developers should install the recommended extensions to take full advantage of the improvements. - Optionally, update the list in `.vscode/extensions.json` if new extensions are required in the future. --- ### References - [VS Code Extension Recommendations](https://code.visualstudio.com/docs/editor/extension-gallery#_workspace-recommended-extensions) - [Prettier for Code Formatting](https://prettier.io/) - [Flake8 Linter for Python](https://flake8.pycqa.org/en/latest/) Let me know if you have any feedback or suggestions! --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
2025-02-01 00:34:04 +01:00
]
}
Reference in New Issue Copy Permalink