JBRes-6959: Introduce Add-Comment Transformation #25

Vladislav0Art · 2025-12-08T11:11:41Z

Description

Add TransformationExecutor.kt‎ that executes the given transformation and file context, and its intellij-based implementation IntelliJTransformationExecutor.kt‎.
Assign built-in transformations in headless starter (not in trasnformations registry) to make the latter side-affect-free.
Add AddCommentTransformation.kt‎ that adds a comment mentioned in its config into the provided file.
Introduce IntelliJAwareTransformation.kt‎ that acts as a bridge between IntelliJ Platform and our transformations.
Introduce HeadlessLogger.kt‎ that logs in both idea.log and stdout/stderr.
Add musc utilitary functions to work with VFS and PSI files.
Now, TransformationService.kt‎ can apply the transformations.
Add a :java module (right now, no-op; see description of this commit d762958).

github-actions · 2025-12-08T11:20:17Z

Qodana Community for JVM

6 new problems were found

Inspection name	Severity	Problems
`Unstable API Usage`	🔶 Warning	5
`Unused symbol`	🔶 Warning	1

💡 Qodana analysis was run in the pull request mode: only the changed files were checked

View the detailed Qodana report

To be able to view the detailed Qodana report, you can either:

Register at Qodana Cloud and configure the action
Use GitHub Code Scanning with Qodana
Host Qodana report at GitHub Pages
Inspect and use qodana.sarif.json (see the Qodana SARIF format for details)

To get *.log files or any other Qodana artifacts, run the action with upload-result option set to true,
so that the action will upload the files as the job artifacts:

      - name: 'Qodana Scan'
        uses: JetBrains/[email protected]
        with:
          upload-result: true

Contact Qodana team

Contact us at [email protected]

Or via our issue tracker: https://jb.gg/qodana-issue
Or share your feedback: https://jb.gg/qodana-discussions

Because this parsing can be done in init block of an exact transformation. This makes the API easier since a user doesn't need to explicitly parse the config (it's responsibility of the transformation itself).

Additionally, register `AddCommentTransformation` as an example.

Otherwise, the build fails due to missing credentials in `java` module required to install a private Space module. It is so because `java` module used `core` as `implementation` dependency, all `core`'s deps must be resolvable, which isn't the case for `grazie-llm-interaction`. A possible solution is to duplicate private deps setup from `core`'s build.gradle.kts into `java`'s build file. Probably, there's a better one. Right now, merely removing a dependency on `core` in `java` module setup.

Vladislav0Art

TODO(@Vladislav0Art):

[+] go through the implementation one more time.
[+] fix left TODOs.

Copilot

Pull request overview

This PR introduces the foundational transformation execution infrastructure for the CodeCocoon plugin, enabling the system to apply code transformations to project files. It implements a platform-agnostic transformation executor pattern with an IntelliJ-specific implementation, introduces the first concrete transformation (AddCommentTransformation) as an example, and reorganizes code into a more modular structure.

Key changes include:

Introduction of TransformationExecutor abstraction and IntelliJTransformationExecutor implementation for applying transformations using IntelliJ PSI
Implementation of AddCommentTransformation as an example transformation that adds comments to Java/Kotlin files
Addition of HeadlessLogger wrapper to duplicate log messages to stdout/stderr for better visibility in headless mode
Migration of transformation registration from TransformationRegistry to HeadlessModeStarter to keep the registry side-effect-free
New utility functions for working with VirtualFiles and PSI files
Addition of a :java module (currently a placeholder for future Java-specific transformations)

Reviewed changes

Copilot reviewed 18 out of 20 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/services/TransformationService.kt`	Added transformation application pipeline with file filtering and result tracking
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/intellij/vfs/VirtualFiles.kt`	New utility functions for finding VirtualFiles by path and FileContext
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/intellij/psi/PsiFiles.kt`	New utility functions for retrieving PSI files and documents
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/intellij/logging/HeadlessLogger.kt`	New logger wrapper that duplicates messages to stdout/stderr for headless debugging
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/intellij/Project.kt`	Package reorganization from `components` to `intellij`
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/components/transformations/TransformationRegistry.kt`	Removed init block and side effects, simplified to pure registry
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/components/transformations/IntelliJAwareTransformation.kt`	New interface for transformations requiring IntelliJ Platform components
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/components/transformations/AddCommentTransformation.kt`	Example transformation that adds comments to Java/Kotlin files
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/components/executor/IntelliJTransformationExecutor.kt`	IntelliJ-specific executor using PSI and VFS for transformations
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/components/VirtualFiles.kt`	Moved to `intellij/vfs/VirtualFiles.kt`
`src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/appstarter/HeadlessModeStarter.kt`	Added transformation registration and updated logging to use HeadlessLogger
`settings.gradle.kts`	Added `:java` module
`java/src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/java/JavaTransformation.kt`	Placeholder for future Java-specific transformations
`java/build.gradle.kts`	Build configuration for Java module
`core/src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/transformation/Transformation.kt`	Changed config type from `Map<String, Any?>` to `Map<String, Any>` and removed `parseConfig()` method
`core/src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/transformation/TextBasedTransformation.kt`	New base class for text-based transformations with language filtering
`core/src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/executor/TransformationExecutor.kt`	Platform-agnostic interface for transformation execution
`codecocoon.yml`	Updated configuration to use `add-comment-transformation` example
`build.gradle.kts`	Added `:java` module as plugin dependency
`.idea/gradle.xml`	Updated Gradle configuration to include `:java` module

Files not reviewed (1)

.idea/gradle.xml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/appstarter/HeadlessModeStarter.kt

...github/pderakhshanfar/codecocoonplugin/components/executor/IntelliJTransformationExecutor.kt

...ithub/pderakhshanfar/codecocoonplugin/components/transformations/AddCommentTransformation.kt

src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/services/TransformationService.kt

...ithub/pderakhshanfar/codecocoonplugin/components/transformations/AddCommentTransformation.kt

src/main/kotlin/com/github/pderakhshanfar/codecocoonplugin/services/TransformationService.kt

dragoi75 · 2025-12-17T06:12:28Z

codecocoon.yml

@@ -1,5 +1,5 @@
 # Absolute or project-local path to the root of the project you want to transform
-projectRoot: "/absolute/path/to/your/project"


For the sake of avoiding merge conflicts every time we change this, I think we should not commit the path here :)

I suggest we do the following:

Remove codecocoon.yml from being tracked by git by replacing it with codecocoon.example.yml (or similar).

An actual codecocoon.yml will be local to every developer.

Created an issue for this: JBRes-7332

...ithub/pderakhshanfar/codecocoonplugin/components/transformations/AddCommentTransformation.kt

Vladislav0Art added 15 commits December 15, 2025 14:51

feat: add java submodule

34d234e

feat: create JavaTransformation interface in java submodule

dd0816a

feat: create TextBasedTransformation abstract class

7178f06

feat: create TransformationExecutor interface

1268435

feat: create IntelliJAwareTransformation interface

7dbe3e2

feat: implement IntelliJTransformationExecutor

6ecbdb8

refactor: restructure project files

5bcdf96

feat: add HeadlessLogger that mirrors logs into stdout/stderr

b4c416b

feat: implement AddCommentTransformation to serve as example

2caaec6

feat: apply given transformations in TransformationService

3019c32

feat: use AddCommentTransformation in HeadlessModeStarter

17ca22d

feat: remove parseConfig from Transformation

d0cc52c

Because this parsing can be done in init block of an exact transformation. This makes the API easier since a user doesn't need to explicitly parse the config (it's responsibility of the transformation itself).

feat: register transformations in HeadlessModeStarter

bb3f1cc

Additionally, register `AddCommentTransformation` as an example.

feat: add add-comment-transformation in yaml config

2572e36

refactoring: minor

b69dda8

Vladislav0Art force-pushed the vartiukhov/feature/add-comment-transformation branch from 8a44bff to b69dda8 Compare December 15, 2025 15:01

Vladislav0Art added 2 commits December 15, 2025 16:11

refactoring: minor

e692c7d

Vladislav0Art changed the title ~~Vartiukhov/feature/add comment transformation~~ JBRes-6959: Introduce Add-Comment Transformation Dec 15, 2025

Vladislav0Art added 2 commits December 15, 2025 17:05

refactor: change package name of added transformations

3f6bb87

refactor: remove added project root

403a5ca

Vladislav0Art commented Dec 15, 2025

View reviewed changes

Vladislav0Art marked this pull request as ready for review December 15, 2025 16:14

Vladislav0Art requested a review from Copilot December 15, 2025 16:15

Copilot started reviewing on behalf of Vladislav0Art December 15, 2025 16:20 View session

Copilot AI reviewed Dec 15, 2025

View reviewed changes

Vladislav0Art added 2 commits December 15, 2025 21:36

refactor: use id instead of name in executor

cafcccb

refactor: minor modifications

4625d24

dragoi75 approved these changes Dec 17, 2025

View reviewed changes

feat: remove name member field of Transformation

20c6106

Vladislav0Art merged commit dc06183 into main Dec 17, 2025
1 check passed

Vladislav0Art mentioned this pull request Dec 17, 2025

JBRes-7332: Replace codecocoon.yml with an example file to avoid accidental committing #33

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

JBRes-6959: Introduce Add-Comment Transformation #25

JBRes-6959: Introduce Add-Comment Transformation #25

Uh oh!

Vladislav0Art commented Dec 8, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Dec 8, 2025 •

edited

Loading

Uh oh!

Vladislav0Art left a comment •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dragoi75 Dec 17, 2025

Uh oh!

Vladislav0Art Dec 17, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -1,5 +1,5 @@
		# Absolute or project-local path to the root of the project you want to transform
		projectRoot: "/absolute/path/to/your/project"

JBRes-6959: Introduce Add-Comment Transformation #25

JBRes-6959: Introduce Add-Comment Transformation #25

Uh oh!

Conversation

Vladislav0Art commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions bot commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qodana Community for JVM

Uh oh!

Vladislav0Art left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dragoi75 Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Vladislav0Art Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Vladislav0Art commented Dec 8, 2025 •

edited

Loading

github-actions bot commented Dec 8, 2025 •

edited

Loading

Vladislav0Art left a comment •

edited

Loading