Limit docs code snippets line length to max 60 chars (#317 / #318)

[Bukama]

I don't see a way to cut the examples in TempDir extension, so I leave this to maybe refactored method names in #277

Limit docs code snippets line length to max 60 chars (#317 / #318)

To avoid horizontal scroll bars inside the code examples of the
documentation pages the line length of them must not more
that 60 characters.

---

PR checklist

The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.

Documentation (general)

• There is documentation (Javadoc and site documentation; added or updated)
• There is implementation information to describe why a non-obvious source code / solution got implemented
• Site documentation has its own .adoc file in the docs folder, e.g. docs/report-entries.adoc
• Only one sentence per line (especially in .adoc files)
• Javadoc uses formal style, while sites documentation may use informal style (see Documentation: Personal or formal style #265)

Documentation (new extension)

• The docs/docs-nav.yml navigation has an entry for the new extension
• The package-info.java contains information about the new extension

Code

• Code adheres to code style, naming conventions etc.
• Successful tests cover all changes
• There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks (see Require configuration failiure tests? #164)
• Tests use AssertJ or our own PioneerAssert (which are based on AssertJ)

Contributing

• A prepared commit message exists
• The list of contributions inside README.md mentions the new contribution (real name optional)

---

I hereby agree to the terms of the JUnit Pioneer Contributor License Agreement.

[Michael1993]

LGTM.

What you could do (as a bonus) is pull in Java::Geci as a dependency and auto-insert the code snippets from our tests as examples. 😉

[beatngu13]

Thx for the hard work! But could it be that you mixed tabs and whitespaces for indentation? Example:

https://github.com/junit-pioneer/junit-pioneer/pull/318/files#diff-f66b5eb32a0e201487cfc4e81f6bdc04R17

Line 17 uses a tab, line 18 whitespaces.

[beatngu13]

What you could do (as a bonus) is pull in Java::Geci as a dependency and auto-insert the code snippets from our tests as examples. 😉

Haven't heard about Java::Geci, sounds cool! But I would suggest to do that in a separate PR.

[Bukama]

Thx for the hard work! But could it be that you mixed tabs and whitespaces for indentation? Example:

https://github.com/junit-pioneer/junit-pioneer/pull/318/files#diff-f66b5eb32a0e201487cfc4e81f6bdc04R17

Line 17 uses a tab, line 18 whitespaces.

Sometimes I don't understand IntellJ. AsciiDoc settings were set to "Use tab character" with "tab size 4" and IntelliJ printed 4 spaces... After dis- and reenabling the setting tabs are used. On the otherside: Shouldn't spotless take care of this or let the build break? Nevermind: Replaced all space with tabs.

[beatngu13]

Oh, non-ASCII chars in code snippets? 😬

[Bukama]

(Extended) ASCII-Code 248 :p http://www.asciitable.com/

I havn't come up with the short limit of 60 chars where about 40 are for intenden and System.out.println(..); 🤷‍♂️

[beatngu13]

Every day's a school say. 👍

[beatngu13]

Shouldn't spotless take care of this or let the build break?

Not that familiar with Spotless, could it be it doesn't check Asciidoc? I will have a look and create an issue if necessary.

[Bukama]

Shouldn't spotless take care of this or let the build break?

Not that familiar with Spotless, could it be it doesn't check Asciidoc? I will have a look and create an issue if necessary.

Maybe. At least there are only spotlessApplyJava and spotlessApplyGroovy targets in the Gradle.

Thanks for pointing the missing spaces. Don't know why IntelliJ hasn't shown them to me.

Displaying in Github is strange anyway. Some lines are aligned in IntellI, but are not in Github....

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
No Duplication information