mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2025-08-16 13:47:28 +02:00
b6ff1dd7f6
# Description of Changes
- **What was changed**
- Bumped `java.format.settings.google.version` to **1.28.0** in
`.devcontainer/devcontainer.json` and `.vscode/settings.json`.
- Expanded ignore patterns in `.devcontainer/devcontainer.json` to cover
`app/core/`, `app/common/`, `app/proprietary/` directories.
- Added a new top‐level `.dockerignore` to exclude build artifacts,
virtual environments, logs, OS files, and markdown docs.
- Consolidated EditorConfig YAML globs into `*.{yml,yaml}` to remove
duplication.
- Fixed missing newline in `.github/config/.files.yaml` and added label
metadata (`from_name`/`description`) in `.github/labels.yml`.
- Updated `build.gradle`:
- Introduced `junitPlatformVersion = "1.12.2"` and replaced hard-coded
launcher versions.
- Applied the `jacoco` plugin across all subprojects and configured
`jacocoTestReport` (XML + HTML).
- Wire-up `jacocoTestReport` to run after tests.
- **Why the change was made**
- Ensure all formatting tools (Google Java Format) stay in sync across
editors and containers.
- Clean up ignore rules to prevent build artifacts and sensitive files
from creeping into images and repos.
- Improve CI visibility by generating code-coverage reports with JaCoCo.
- Keep GitHub configuration files well-formed and enrich label
definitions for automation.
---
## 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/devGuide/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/devGuide/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/devGuide/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/devGuide/DeveloperGuide.md#6-testing)
for more details.
145 lines
6.6 KiB
JSON
145 lines
6.6 KiB
JSON
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
|
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
|
|
{
|
|
"name": "Stirling-PDF Dev Container",
|
|
"build": {
|
|
// Sets the run context to one level up instead of the .devcontainer folder.
|
|
"context": "..",
|
|
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
|
|
"dockerfile": "../Dockerfile.dev"
|
|
},
|
|
"runArgs": [
|
|
"-e",
|
|
"GIT_EDITOR=code --wait",
|
|
"--security-opt",
|
|
"label=disable"
|
|
],
|
|
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
|
"forwardPorts": [8080, 2002, 2003],
|
|
"portsAttributes": {
|
|
"8080": {
|
|
"label": "Stirling-PDF Dev Port"
|
|
},
|
|
"2002": {
|
|
"label": "unoserver Port"
|
|
},
|
|
"2003": {
|
|
"label": "UnoConvert Port"
|
|
}
|
|
},
|
|
"workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=delegated",
|
|
"mounts": [
|
|
"source=logs-volume,target=/workspace/logs,type=volume",
|
|
"source=build-volume,target=/workspace/build,type=volume"
|
|
],
|
|
"workspaceFolder": "/workspace",
|
|
// Configure tool-specific properties.
|
|
"customizations": {
|
|
"vscode": {
|
|
"settings": {
|
|
"terminal.integrated.shell.linux": "/bin/bash",
|
|
"editor.wordSegmenterLocales": "",
|
|
"editor.guides.bracketPairs": "active",
|
|
"editor.guides.bracketPairsHorizontal": "active",
|
|
"cSpell.enabled": false,
|
|
"[java]": {
|
|
"editor.defaultFormatter": "josevseb.google-java-format-for-vs-code"
|
|
},
|
|
"java.compile.nullAnalysis.mode": "automatic",
|
|
"java.configuration.updateBuildConfiguration": "interactive",
|
|
"java.format.enabled": true,
|
|
"java.format.settings.profile": "GoogleStyle",
|
|
"java.format.settings.google.version": "1.28.0",
|
|
"java.format.settings.google.extra": "--aosp --skip-sorting-imports --skip-javadoc-formatting",
|
|
"java.saveActions.cleanup": true,
|
|
"java.cleanup.actions": [
|
|
"invertEquals",
|
|
"instanceofPatternMatch"
|
|
],
|
|
"java.completion.engine": "dom",
|
|
"java.completion.enabled": true,
|
|
"java.completion.importOrder": [
|
|
"java",
|
|
"javax",
|
|
"org",
|
|
"com",
|
|
"net",
|
|
"io",
|
|
"jakarta",
|
|
"lombok",
|
|
"me",
|
|
"stirling"
|
|
],
|
|
"java.project.resourceFilters": [
|
|
".devcontainer/",
|
|
".git/",
|
|
".github/",
|
|
".gradle/",
|
|
".venv/",
|
|
".venv*/",
|
|
".vscode/",
|
|
"bin/",
|
|
"app/core/bin/",
|
|
"app/common/bin/",
|
|
"app/proprietary/bin/",
|
|
"build/",
|
|
"app/core/build/",
|
|
"app/common/build/",
|
|
"app/proprietary/build/",
|
|
"configs/",
|
|
"app/core/configs/",
|
|
"customFiles/",
|
|
"app/core/customFiles/",
|
|
"docs/",
|
|
"exampleYmlFiles",
|
|
"gradle/",
|
|
"images/",
|
|
"logs/",
|
|
"pipeline/",
|
|
"scripts/",
|
|
"testings/",
|
|
".git-blame-ignore-revs",
|
|
".gitattributes",
|
|
".gitignore",
|
|
"app/core/.gitignore",
|
|
"app/common/.gitignore",
|
|
"app/proprietary/.gitignore",
|
|
".pre-commit-config.yaml"
|
|
],
|
|
"java.signatureHelp.enabled": true,
|
|
"java.signatureHelp.description.enabled": true,
|
|
"java.maven.downloadSources": true,
|
|
"java.import.gradle.enabled": true,
|
|
"java.eclipse.downloadSources": true,
|
|
"java.import.gradle.wrapper.enabled": true,
|
|
"spring.initializr.defaultLanguage": "Java",
|
|
"spring.initializr.defaultGroupId": "stirling.software.SPDF",
|
|
"spring.initializr.defaultArtifactId": "SPDF"
|
|
},
|
|
"extensions": [
|
|
"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
|
|
"ms-vscode-remote.vscode-remote-extensionpack", // Remote Development Pack for SSH, WSL, and Containers
|
|
// "Oracle.oracle-java", // Oracle Java extension with additional features for Java development
|
|
"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
|
|
"EditorConfig.EditorConfig", // EditorConfig support for maintaining consistent coding styles
|
|
"ms-azuretools.vscode-docker", // Docker extension for Visual Studio Code
|
|
"charliermarsh.ruff", // Ruff extension for Ruff language support
|
|
"github.vscode-github-actions", // GitHub Actions extension for Visual Studio Code
|
|
"stylelint.vscode-stylelint", // Stylelint extension for CSS and SCSS linting
|
|
"redhat.vscode-yaml" // YAML extension for Visual Studio Code
|
|
]
|
|
}
|
|
},
|
|
// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
|
|
"remoteUser": "devuser",
|
|
"shutdownAction": "stopContainer",
|
|
"initializeCommand": "bash ./.devcontainer/git-init.sh",
|
|
"postStartCommand": "./.devcontainer/init-setup.sh"
|
|
}
|