Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define a standard for module folder names #1174

Closed
2 tasks done
ndr-brt opened this issue Apr 20, 2022 · 0 comments · Fixed by #1190
Closed
2 tasks done

Define a standard for module folder names #1174

ndr-brt opened this issue Apr 20, 2022 · 0 comments · Fixed by #1190
Assignees
Labels
refactoring Cleaning up code and dependencies
Milestone

Comments

@ndr-brt
Copy link
Member

ndr-brt commented Apr 20, 2022

Feature Request

Issue #1135 raised a problem that should be avoided:
gradle is not able to handle modules with the same folder name.
e.g. there cannot be two modules like these (this case does not exist, just for example):

extensions/in-memory/asset-index
extensions/sql/asset-index

So every "leaf" module folder should have an unique name, like:

extensions/in-memory/asset-index-in-memory
extensions/sql/asset-index-sql

And this should be reflected to the artifact id published.

Related to this topic, module names should be coherent with the domain names in the codebase, e.g. a module regarding the AssetIndex should be called asset-index-sql and not assetindex-sql

Which Areas Would Be Affected?

folder structure, CI

Why Is the Feature Desired?

To avoid bugs like #1135, to have a cleaner structure

Solution Proposal

A check on the CI should be added, giving error on leaf module folder conflict

Type of Issue

cleanup

Checklist

  • assigned appropriate label?
  • Do NOT select a milestone or an assignee!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Cleaning up code and dependencies
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant