Skip to content

Conversation

@koppor
Copy link
Member

@koppor koppor commented Sep 14, 2025

Tries to use an action to check if all code conforms to our style

Follow-up to #13885

Had to disable JavaDoc formatting, because of

  • IDEA-379285
  • non-alignment will move everything to column 1

I patched one action to get it working

Some collections of actions - for reference


Cannot disable JavaDoc parameter alignment, because all JavaDoc will be changed:

image

IntelliJ itself recommends to check-in configuration into VCS: https://www.jetbrains.com/help/idea/configure-project-settings.html?_cl=MTsxOzE7OTRVRlhLb3ZQWXA3TEdjQXlRT3RrYW1jUU1lWDdNN25DNGZnNk53R0h6ZWVTMktiWjVDS1NQYmxhRjF5NkNIWjs%3D#share-project-through-vcs

Alternative is backup-and-sync: https://www.jetbrains.com/help/idea/sharing-your-ide-settings.html?_cl=MTsxOzE7OTRVRlhLb3ZQWXA3TEdjQXlRT3RrYW1jUU1lWDdNN25DNGZnNk53R0h6ZWVTMktiWjVDS1NQYmxhRjF5NkNIWjs%3D

Steps to test

  1. Make a wrong change to the code
  2. Checks should fail

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • [/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
  • [/] I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.


@Inject
private SrvStateManager srvStateManager;
private SrvStateManager srvStateManager;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The patch reformats code without adding new statements, which contradicts the guideline that code should not be reformatted only because of syntax. This change should be reverted unless new statements are added.


@Inject
private FilesToServe filesToServe;
private FilesToServe filesToServe;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The patch reformats code without adding new statements, which contradicts the guideline that code should not be reformatted only because of syntax. This change should be reverted unless new statements are added.

@koppor koppor marked this pull request as draft September 14, 2025 22:09
@koppor koppor added the dev: code-quality Issues related to code or architecture decisions label Sep 14, 2025
@koppor koppor marked this pull request as ready for review September 14, 2025 22:47
Siedlerchr
Siedlerchr previously approved these changes Sep 14, 2025
@jabref-machine
Copy link
Collaborator

Your pull request needs to link an issue correctly.

To ease organizational workflows, please link this pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue:

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message.

Examples

  • Fixes #xyz links pull-request to issue. Merging the PR will close the issue.
  • Fixes https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
  • Fixes https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
  • Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the issue.

@trag-bot
Copy link

trag-bot bot commented Sep 14, 2025

@trag-bot didn't find any issues in the code! ✅✨

@trag-bot
Copy link

trag-bot bot commented Sep 14, 2025

@trag-bot didn't find any issues in the code! ✅✨

@koppor koppor enabled auto-merge September 14, 2025 22:57
@koppor koppor added this pull request to the merge queue Sep 14, 2025
Merged via the queue into JabRef:main with commit 0c1132d Sep 14, 2025
40 of 42 checks passed
@koppor koppor deleted the reformat-check branch September 14, 2025 23:09
Siedlerchr added a commit that referenced this pull request Sep 17, 2025
* upstream/main:
  Add new check for format (#13909)
  Consistent casing in fieldnames (#13867)
  Revert "Pressing TAB in last field in entry editor moves focus to the next ta…" (#13912)
  Fix YAML
  Fix on-pr-opened-updated.yml syntax
  Pressing TAB in last field in entry editor moves focus to the next tab's first field  (#13870)
  Modularize JabSrv (#13908)
  New translations jabref_en.properties (Italian) (#13907)
  Remove wrong `assert` statement (#13906)
  Add .git-blame-ignore-revs (#13884)
  Do not show transprot info messages (#13904)
  Pubmed api key support (#13899)
  Fix warnings for native access
  Fix automerge workflow (#13903)
  Add comment on issue on binary (#13902)
  Have checkstyle and VCS configuration distributed (#13900)
  Add unknown field to lsp consistency check (#13880)
  Put config for general tab if missing (#13901)
  Fix autosave manager exception on shutdown (#13882)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev: ci-cd dev: code-quality Issues related to code or architecture decisions project: jabcon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants