chore(QTDI-2895): [Refactoring] S6126 Text blocks#1233
Conversation
- used intellij inspection as it is...
There was a problem hiding this comment.
Pull request overview
Refactors multi-line string literals across the codebase to use Java text blocks (addressing Sonar rule S6126), primarily improving readability/maintainability of embedded snippets (Asciidoc/JSON/YAML/README content) and test expectations without intended behavioral changes.
Changes:
- Replace string-concatenation multi-line literals with Java text blocks in production code and annotations.
- Update affected unit tests to assert against text-block formatted expected outputs.
- Convert various generated/readme/template string payloads (Asciidoc/JSON/YAML/properties/HTML) to text blocks.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| documentation/src/main/java/org/talend/runtime/documentation/StaticRedirector.java | Convert embedded redirect HTML content to a text block. |
| component-tools/src/test/java/org/talend/sdk/component/tools/ComponentValidatorTest.java | Update expected exception messages to text blocks. |
| component-tools/src/test/java/org/talend/sdk/component/tools/AsciidocDocumentationGeneratorTest.java | Update expected generated Asciidoc outputs to text blocks. |
| component-tools/src/main/java/org/talend/sdk/component/tools/validator/InternationalizationValidator.java | Convert the autofix log suffix message to a text block. |
| component-tools/src/main/java/org/talend/sdk/component/tools/AsciidocDocumentationGenerator.java | Convert the generated Asciidoc table header prefix to a text block. |
| component-studio/component-runtime-di/src/test/java/org/talend/sdk/component/runtime/di/schema/TaCoKitGuessSchemaTest.java | Convert large logged stacktrace sample to a text block. |
| component-starter-server/src/test/java/org/talend/sdk/component/starter/server/service/facet/component/ComponentGeneratorConfigurationTest.java | Convert generated Java source expectations to text blocks. |
| component-starter-server/src/test/java/org/talend/sdk/component/starter/server/front/ProjectResourceTest.java | Convert README.adoc expectation to a text block. |
| component-starter-server/src/main/java/org/talend/sdk/component/starter/server/service/openapi/OpenAPIGenerator.java | Convert generated Messages.properties content to a text block. |
| component-starter-server/src/main/java/org/talend/sdk/component/starter/server/service/facet/wadl/WADLFacet.java | Convert facet README content to a text block. |
| component-starter-server/src/main/java/org/talend/sdk/component/starter/server/service/facet/travis/TravisFacet.java | Convert generated .travis.yml and facet README strings to text blocks. |
| component-starter-server/src/main/java/org/talend/sdk/component/starter/server/service/facet/codenvy/CodenvyFacet.java | Convert facet README content to a text block. |
| component-server-parent/component-server/src/test/java/org/talend/sdk/component/server/test/InitTestInfra.java | Convert embedded documentation.adoc test content to a text block. |
| component-server-parent/component-server/src/test/java/org/talend/sdk/component/server/service/VirtualDependenciesServiceTemplatingTest.java | Convert multi-line properties expectations to text blocks. |
| component-server-parent/component-server/src/test/java/org/talend/sdk/component/server/front/DocumentationResourceImplTest.java | Convert large Asciidoc sample content and expectations to text blocks. |
| component-server-parent/component-server/src/test/java/org/talend/sdk/component/server/front/beam/BeamActionSerializationTest.java | Convert expected JSON payload to a text block. |
| component-server-parent/component-server/src/test/java/org/talend/sdk/component/server/front/ActionResourceImplTest.java | Convert expected JSON payload to a text block. |
| component-server-parent/component-server/src/main/java/org/talend/sdk/component/server/configuration/ComponentServerConfiguration.java | Convert @Documentation annotation value to a text block. |
| component-server-parent/component-server-api/src/main/java/org/talend/sdk/component/server/api/BulkReadResource.java | Convert OpenAPI @RequestBody description to a text block while preserving trailing spaces via \\s. |
| component-api/src/main/java/org/talend/sdk/component/api/service/schema/Schema.java | Convert @Partial annotation value to a text block. |
| component-api/src/main/java/org/talend/sdk/component/api/service/asyncvalidation/AsyncValidation.java | Convert @Documentation annotation value to a text block. |
| component-api/src/main/java/org/talend/sdk/component/api/configuration/ui/layout/GridLayout.java | Convert @Documentation annotation value to a text block. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
hey @copilot , |
wanna see your changes... and new review :D |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

https://qlik-dev.atlassian.net/browse/QTDI-2895
AI generated code
https://internal.qlik.dev/general/ways-of-working/code-reviews/#guidelines-for-ai-generated-code