chore: refine the hg-style.xml specification #2457

returnToInnocence · 2024-02-23T17:50:29Z

Purpose of the PR

fix the [Summary] Enhance code style warnings in server #2435 's subtask of refine the hg-style.xml specification.

Main Changes

Change the maximum wrap text length for XML to 120 (implemented through hg-style.xml)
Add a blank line between method definitions, inner class definitions, and static code blocks (implemented through hg-style.xml)
For Properties files, add the option "KEEP_BLANK_LINES." (implemented through hg-style.xml)
Add <p> tags to JavaDoc blank lines (implemented through hg-style.xml)
.xml file leaves a blank line at the end (through.editorconfig)
Class declaration requires a blank line before and after each line (implemented via hg-style.xml)
Javadoc line comment not in line (implemented via hg-style.xml)
.properties file leaves empty lines (implemented via hg-style.xml)
.yaml file braces {}, brackets [] remove spacing Spaces (implemented via hg-style.xml)

Verifying these changes

Trivial rework / code cleanup without any test coverage. (No Need)
Already covered by existing tests, such as (please modify tests here).
Need tests and can be verified as follows:
- By reformat the code modules that have completed merge at present, if there is no change, the test is successful😀

Does this PR potentially affect the following parts?

Nope
Dependencies (add/update license info)
Modify configurations
The public API
Other affects (typed here)
- When you use hugegraph-style.xml for code reformat, this pr mentions changes that will affect the final result
  However, you need to use the ctrl+C shortcut to enable the .editorconfig profile in addition to the reformat code option🙈

Documentation Status

Doc - TODO
- I'm writing the corresponding reformat code related documentation, and I will introduce the new pr corresponding documentation later
Doc - Done
Doc - No Need

javeme · 2024-02-24T03:02:04Z

LGTM

codecov · 2024-02-24T03:09:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.30%. Comparing base (bc421bb) to head (1fde1d0).
Report is 3 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #2457      +/-   ##
============================================
+ Coverage     66.23%   66.30%   +0.07%     
  Complexity      827      827              
============================================
  Files           511      511              
  Lines         42582    42622      +40     
  Branches       5935     5947      +12     
============================================
+ Hits          28204    28262      +58     
+ Misses        11566    11548      -18     
  Partials       2812     2812

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

returnToInnocence · 2024-02-24T03:42:04Z

LGTM

@javeme
Sorry, I just found a few more configuration omissions, I will mention a new commit to supplement

…nting 8 to 4 problem

javeme · 2024-02-25T04:39:14Z

.editorconfig

-
-[*.{java,xml,py}]
-indent_style = space
-indent_size = 4


not sure why delete this code?

Sorry sir, I didn't describe this clearly in main change

The reason for this change is that we encountered a problem while formatting the java code,

The intended effect of format is to automatically wrap and indent a line when it exceeds the maximum length of 100, which is a special case where the number of indented Spaces is eight

If the changes in the.editorConfig do not change, the indentation will change to 4, even though the code style has been set to 8

Before modification

After modification

I'm sorry, but I've found a new solution that doesn't require deleting the above, but instead enables a special option in.editorconfig for indenting more than the maximum line wrap of a single character

I'll make a new commit, which will undo my changes to the.editorconfig section and add the options above

Mainly refer to the configuration of the spring-cloud project

imbajin

LGTM almost

imbajin · 2024-02-26T09:57:57Z

hugegraph-style.xml

+  <codeStyleSettings language="XML">
+    <option name="RIGHT_MARGIN" value="120" />
+    <option name="WRAP_ON_TYPING" value="1" />
+    <option name="SOFT_MARGINS" value="120" />
+  </codeStyleSettings>


good, set max 120 chars for xml is better (could avoid some bugs when format with 100)

VGalaxies

GREAAAAAAAT! Looking forward to further improvements...

- Change the maximum wrap text length for XML to 120 (via `hg-style.xml`) - Add a blank line between method definitions, inner class definitions, and static code blocks (via `hg-style.xml`) - Add `<p>` tags to Javadoc blank lines (via `hg-style.xml`) - `.xml` file leaves a blank line at the end (via `.editorconfig`) - Class declaration requires a blank line before and after each line (via `hg-style.xml`) - Javadoc line comment not in line (via `hg-style.xml`) - `.properties` file leaves empty lines (via `hg-style.xml`) - `.yaml` file braces `{}`, brackets `[]` remove spaces (via `hg-style.xml`)

refine the hg-style.xml #2435 no indents change

35e244a

dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. feature New feature tests Add or improve test cases labels Feb 23, 2024

returnToInnocence changed the title ~~refine the hg-style.xml #2435 no indents change~~ chore: refine the hg-style.xml specification Feb 23, 2024

returnToInnocence mentioned this pull request Feb 23, 2024

[Summary] Enhance code style warnings in server #2435

Closed

18 tasks

javeme previously approved these changes Feb 24, 2024

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 24, 2024

returnToInnocence marked this pull request as draft February 24, 2024 03:37

returnToInnocence changed the title ~~chore: refine the hg-style.xml specification~~ chore: refine the hg-style.xml specification [WIP] Feb 24, 2024

Supplement the hg-style.xml

02198ed

returnToInnocence dismissed javeme’s stale review via 02198ed February 25, 2024 02:12

Update .editorconfig to Solve the reformat java code single line inde…

6bf3a7d

…nting 8 to 4 problem

returnToInnocence changed the title ~~chore: refine the hg-style.xml specification [WIP]~~ chore: refine the hg-style.xml specification Feb 25, 2024

returnToInnocence marked this pull request as ready for review February 25, 2024 02:23

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. ci-cd Build or deploy and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Feb 25, 2024

Restore the empty tag space

4794c29

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Feb 25, 2024

javeme reviewed Feb 25, 2024

View reviewed changes

imbajin previously approved these changes Feb 26, 2024

View reviewed changes

imbajin added this to the 1.3.0 milestone Feb 26, 2024

Restores the.editorconfig in master and adds continuation_indent_size

1fde1d0

returnToInnocence dismissed imbajin’s stale review via 1fde1d0 February 26, 2024 13:45

returnToInnocence requested a review from imbajin February 26, 2024 15:53

returnToInnocence requested a review from javeme February 26, 2024 15:53

imbajin approved these changes Feb 27, 2024

View reviewed changes

imbajin requested a review from VGalaxies February 27, 2024 03:21

VGalaxies approved these changes Feb 27, 2024

View reviewed changes

VGalaxies merged commit 47a68f0 into apache:master Feb 27, 2024
21 checks passed

returnToInnocence mentioned this pull request Mar 18, 2024

[Feature] Migrate the hg-style.xml to.editorconfig #2485

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: refine the hg-style.xml specification #2457

chore: refine the hg-style.xml specification #2457

returnToInnocence commented Feb 23, 2024 •

edited by imbajin

Loading

javeme commented Feb 24, 2024

codecov bot commented Feb 24, 2024 •

edited

Loading

returnToInnocence commented Feb 24, 2024 •

edited

Loading

javeme Feb 25, 2024

returnToInnocence Feb 25, 2024 •

edited

Loading

returnToInnocence Feb 26, 2024 •

edited

Loading

imbajin left a comment

imbajin Feb 26, 2024

VGalaxies left a comment

chore: refine the hg-style.xml specification #2457

chore: refine the hg-style.xml specification #2457

Conversation

returnToInnocence commented Feb 23, 2024 • edited by imbajin Loading

Purpose of the PR

Main Changes

Verifying these changes

Does this PR potentially affect the following parts?

Documentation Status

javeme commented Feb 24, 2024

codecov bot commented Feb 24, 2024 • edited Loading

Codecov Report

returnToInnocence commented Feb 24, 2024 • edited Loading

javeme Feb 25, 2024

Choose a reason for hiding this comment

returnToInnocence Feb 25, 2024 • edited Loading

Choose a reason for hiding this comment

Before modification

After modification

returnToInnocence Feb 26, 2024 • edited Loading

Choose a reason for hiding this comment

imbajin left a comment

Choose a reason for hiding this comment

imbajin Feb 26, 2024

Choose a reason for hiding this comment

VGalaxies left a comment

Choose a reason for hiding this comment

returnToInnocence commented Feb 23, 2024 •

edited by imbajin

Loading

codecov bot commented Feb 24, 2024 •

edited

Loading

returnToInnocence commented Feb 24, 2024 •

edited

Loading

returnToInnocence Feb 25, 2024 •

edited

Loading

returnToInnocence Feb 26, 2024 •

edited

Loading