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.

Sign up for GitHub

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

Jump to bottom

Update description of intelliJ checkstyle configuration #6766

Merged
merged 3 commits into from
Aug 19, 2020
Merged

Update description of intelliJ checkstyle configuration #6766

merged 3 commits into from
Aug 19, 2020

Conversation

marcelluethi
Copy link
Contributor

The instructions for configuring checkstyle in intelliJ seem not to be up-to-date. This PR updates the description to match the latest checkstyle version (5.41.0) and intellij version (2020.2).

This PR changes one screenshot, which I found to be in two versions in the repo (docs/images and docs/.gibook/assets). It seems that the former is not used anymore. However, as I don't understand the documentation processes fully, I did not remove it.

koppor
koppor reviewed Aug 18, 2020
View reviewed changes
Copy link
Member

@koppor koppor left a comment

Choose a reason for hiding this comment

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

Thank you for the update!

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace.md
6. Ensure that the latest CheckStyle version is selected \(8.32 or higher\)
7. Set the "Scan Scope" to "Only Java sources \(including tests\)
8. Save settings by clicking "OK"
9. Your configuration should now look like this:

![checkstyle settings](../.gitbook/assets/intellij-checkstyle-settings.png)
Copy link
Member

Choose a reason for hiding this comment

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

Here is the link to the image. I think, gitbook copies (instead of moving) all images to that directory during synchronization.

Can you just delete the other image?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just deleted the unused image, together with two other images that I found were not used anywhere in the project.

@marcelluethi
Copy link
Contributor Author

I just found that the description of how to ignore the buildSrc in Gradle has also changed. I have updated the description accordingly.

All the instructions given in the guide should now be up-to-date.

I am still having some problems to run it from Intellij using Intellij's runner (not all generated files are found by intellij). However, I suppose that this issue is not related to the instructions in this guide.

@koppor koppor merged commit a02a2aa into JabRef:master Aug 19, 2020
@koppor
Copy link
Member

koppor commented Aug 19, 2020

Thank you for the update! We can discuss the IntelliJ issues in our gitter channel

Siedlerchr added a commit that referenced this pull request Aug 19, 2020
@Siedlerchr
Merge remote-tracking branch 'upstream/master' into macsign
685a56c 
* upstream/master:
  Merge identical group color indicators (#6768)
  Squashed 'src/main/resources/csl-styles/' changes from c8c6c6d..0895562
  Add restart warning for autocompletion in preferences (#6769)
  Fix markdown
  Update description of intelliJ checkstyle configuration (#6766)
timbachmann added a commit to timbachmann/jabref-6187 that referenced this pull request Dec 4, 2020
@timbachmann
Revert "Update description of intelliJ checkstyle configuration (JabR…
2d0a46d 
…ef#6766)"

This reverts commit a02a2aa
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koppor koppor koppor left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marcelluethi @koppor