Exclude root project from type-safe project dependencies

[tynn]

In Gradle the rootProject is special and accessible from every project.

Expected Behavior

Skip root project for type-safe project dependencies

Current Behavior

With type-safe project dependencies, the root project raises several issues with some provided names.

Context

1. The root project is in the same hierarchy like its subprojects. Therefore it's not possible to name the root project Lib and have a subproject :lib as a subproject.
2. The root project name is also used by other tools (like Intellij) to display it to the user, but it's not possible to use a readable name including spaces or other characters not mathing the projects pattern.

Steps to Reproduce

enableFeaturePreview 'TYPESAFE_PROJECT_ACCESSORS'

rootProject.name = 'Lib' // or 'Some lib'

include ':lib'

[ov7a]

Thank you for providing a valid reproducer.

The issue is in the backlog of the relevant team but the existence of a workaround makes it non-critical so it might take a while before a fix is made.

---

Note: the source of the problem is a name clash between project name and subproject name.

* What went wrong:
org.gradle.api.internal.catalog.GeneratedClassCompilationException: Unable to compile generated sources:
  - File RootProjectAccessor.java, line: 29, method getLib() is already defined in class org.gradle.accessors.dm.RootProjectAccessor
> Unable to compile generated sources:
    - File RootProjectAccessor.java, line: 29, method getLib() is already defined in class org.gradle.accessors.dm.RootProjectAccessor

[osipxd]

@ov7a, can I contribute a fix? It seems like just RootProjectAccessorSource and everything related to it should be deleted. Yes it is a breaking change, but typesafe project accessors is still an experimental feature.

[osipxd]

Related issues that could be resolved by this proposal:

• Feedback on TYPESAFE_PROJECT_ACCESSORS: rootProject naming #18971
• Lift up project name restrictions of a root project for the project-accessors feature (allow the dot character) #16780
• typesafe project accessos fail on gradle sync #28644

[ov7a]

@osipxd Sorry for the late reply. The team responsible for this area should make a decision. They have been informed. Response time may vary.

[alllex]

Yet another problem with the root accessors is that changing the root project's name does not make the accessors to be regenerated. More surprisingly, the state accessors continue to work, and the builds are successful.

[alllex]

Related

• Allow root project name and a subproject name being the same when using project accessors #16608