-
Notifications
You must be signed in to change notification settings - Fork 46
HIVE-28696: Enforce uniform codestyle in Markdown files in hive-site #31
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
base: main
Are you sure you want to change the base?
Conversation
|
@zabetak, this is amazing. I didn't knew, spotless can work for other language as well. Using this will help greatly. Let me know if I can help with review. I have 1 request though to review #30 and get this merged first. Otherwise because of merge conflicts i would need to rework (manually) and again run this spotless plugin on top of that as it is helping with the padding of columns in markdown. |
|
|
||
| title: "Apache Hive : AboutThisWiki" | ||
| date: 2024-12-12 | ||
| --- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small Observation: A horizontal line is appearing at the top of the page as the number of dash - is changed. from 3 to the width of the text. Nothing major though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I understand Hugo's version of markdown, the original markdown is perfectly fine. It represents some YAML metadata (see goldmark-meta). The official Hugo website uses the same syntax. It would be nice if we could avoid changing these lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A related PR has been merged into spotless recently: diffplug/spotless#2713. We would need to configure spotless to use flexmark with the YamlFrontMatter extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm sure there is a solution for this. The overall question is if enforcing a certain style is desired or it's just gonna be annoying in the long term :)
|
@Aggarwal-Raghav Apart from uniform style do you see other benefits for getting this PR in? Does it solve any of the issues that you identified previously? I am trying to gather pros/cons to see if its worth pursuing this further. |
|
@zabetak , no I don't see any other benefits but this much only is worth having IMO. It will help in developer readability and markdown file navigation. |
Enforce style using maven the spotless plugin.
Just testing for the moment. Didn't review all changes.
Enforce style during maven build:
Formatting can be applied to all files using: