Issue #6619: Update cached Google Style Guide #6620

Vampire · 2019-03-30T02:23:34Z

romani · 2019-03-30T12:48:46Z

lets finish discussion in issue first.

rnveach

Please rebase on the latest master and add new label to google style guide (similar to sun) on items discussed in main issue that need to still be updated.

rnveach · 2019-04-17T22:50:21Z

src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/CommentsIndentationCheck.java

@@ -34,7 +34,7 @@
 * Comments are indented at the same level as the surrounding code.
 * Detailed info about such convention can be found
 * <a href=
- * "https://checkstyle.org/styleguides/google-java-style-20170228.html#s4.8.6.1-block-comment-style">
+ * "https://checkstyle.org/styleguides/google-java-style-20180523/google.github.io/styleguide/javaguide.html#s4.8.6.1-block-comment-style">


I am not seeing google-java-style-20180523.html.
I assume javaguide is the google-java-style-20180523? What is the purpose of putting in such a weird nested folder instead of where it was before?

@Vampire , please rebase on latest and explain extra folders.
I think you simply copied them from github repository (previously I did "page save" in browser, as it was simpler at that time, I do not remember why), so it is ok, we just need to know.

I am not seeing google-java-style-20180523.html.
I assume javaguide is the google-java-style-20180523?

Exactly

What is the purpose of putting in such a weird nested folder instead of where it was before?

Previously @romani just used the browsers "Save page as" functionality, which most often does not work as intended and for example added these ugly effects I highlighted in the issue, as the page-save saves stuff that was added dynamically via JavaScript. But the JavaScript is also still there, so things are doubled. And the dynamically added images are not where expected, so you get those missing images displayed.

I used the software "WinHTTrack Website Copier" to do a proper site download that displays correctly, including all resources where they are expected.

I used the software "WinHTTrack Website Copier"

After some time of thinking on this ...
lets not depend on some tool here, I do not know such tool, and I will not be able to use it as it is for Windows.
Please update please folders to be at google-java-style-20180523 I hope style guide html style will not be changed in recent few years. So all we will need to update periodically is html file. So some any tool, and even "Save as" will work.

lets not depend on some tool here, I do not know such tool, and I will not be able to use it as it is for Windows.

It is not.
Don't get trapped by the "Win" in the name, it is just the Windows build of HTTrack which is available for Windows, Linux, OSX and even Android: http://www.httrack.com/page/2/

Please update please folders to be at google-java-style-20180523 I hope style guide html style will not be changed in recent few years. So all we will need to update periodically is html file. So some any tool, and even "Save as" will work.

The nice thing with HTTrack is, that it properly downloads websites and all related things that are necessary for offline or cached version.
Actually in this case it is not necessary yes, because it the actual HTML that is stored in the Google repository, so we can just copy in the files.
But keep it in mind for probably future supported style guides where the source is not the actual HTML, there HTTrack or any other proper website copier is much better and more reliable than using "Save as" in the browser which will usually save JS-post-processed versions of the pages which end up unnice like it was with the Google Styleguide here too.

romani · 2019-04-27T16:08:24Z

@Vampire , your update is awesome step forward, please find time to finish it.

Vampire · 2019-05-01T23:23:22Z

Please rebase on the latest master

Done

and add new label to google style guide (similar to sun) on items discussed in main issue that need to still be updated.

Done

rnveach

I am approving this but told @romani some things I dislike about the new folders.
We now have styleguide listed twice in the URL, and I don't think google.github.io is necessary or pretty.

Vampire · 2019-05-06T10:57:50Z

Well, my intention was to keep it like the website copier left it for easy updating and diffing in the future.
If you guys really have a problem with the paths, we can change that of course.

romani

good work! Users will appreciate this update a lot. Thanks a lot!

attention to #6620 (comment)

few minors:

src/xdocs/google_style.xml

romani · 2019-05-07T00:42:10Z

src/xdocs/google_style.xml

+                        Google Java Style</a>(<a
+                        href="styleguides/google-java-style-20180523/google.github.io/styleguide/javaguide.html"
+                    >cached page</a>),
+                    version of 23 May 2018, current as of 30 March 2019


I am not sure why we need "30 March", what is reason to have it ?
Not sure why user need to know date of export. We use date as some sort of anchor to commit in googe style repo.
it is probably better to place SHA1 of commit/link-to-commit to be even more exact.

Well, I as user would be interested in this information tbh.
It is more visible with the sun style where we have "version of 20 April 1999, current as of 30 March 2019".
It shows the user when was last checked that the cached and reported-on version is current.
If I only read "version of 20 April 1999" or "version of 23 May 2018", I ask myself "is this also compatible with the latest version, were there any changes?".
If I see that it was last checked on "30 March 2019", I'm pretty confident the report is against a pretty recent version of the styleguide.
(Updated to 07 May 2019 now, as I just rechecked it is still recent)

romani · 2019-05-07T00:46:30Z

src/xdocs/google_style.xml

                                <a
                                    href="config_whitespace.html#MethodParamPad">MethodParamPad</a>
                                <br />
                                <br />
-                                <img src="images/ok_green.png" alt="" />
+                                <img src="images/ok_blue.png" alt="" />


lets keep all non-NoWhitespaceBefore as green because "Existing Check covers all requirements from Google.".

Well, I interpreted it as "the combination of these checks covers all requirements.
Because actually none of the single checks "covers all requirements".
That's why I switched them all to blue and maybe there should actually be only one icon per styleguide rule, not one icon per checkstyle rule.
For now I switched the others back to green as requested.

src/xdocs/style_configs.xml

Vampire force-pushed the issue-6619 branch from f8bb904 to 89d30c8 Compare March 30, 2019 02:41

romani closed this Mar 30, 2019

rnveach reopened this Apr 17, 2019

rnveach requested changes Apr 17, 2019

View reviewed changes

rnveach self-assigned this Apr 17, 2019

romani added the awaiting changes label Apr 27, 2019

romani unassigned rnveach Apr 27, 2019

Vampire force-pushed the issue-6619 branch from 89d30c8 to a4c51c2 Compare May 1, 2019 23:22

Vampire force-pushed the issue-6619 branch from a4c51c2 to ca679be Compare May 1, 2019 23:33

rnveach approved these changes May 6, 2019

View reviewed changes

rnveach assigned romani May 6, 2019

rnveach removed the awaiting changes label May 6, 2019

romani requested changes May 7, 2019

View reviewed changes

Vampire force-pushed the issue-6619 branch from ca679be to b544035 Compare May 7, 2019 09:48

Vampire added 2 commits May 7, 2019 11:49

minor: remove spurious punctuation at the end of list items

394a453

Issue checkstyle#6619: Update cached Google Style Guide

0555db4

Vampire force-pushed the issue-6619 branch from b544035 to 0555db4 Compare May 7, 2019 09:49

romani merged commit 9a2f293 into checkstyle:master May 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #6619: Update cached Google Style Guide #6620

Issue #6619: Update cached Google Style Guide #6620

Vampire commented Mar 30, 2019

romani commented Mar 30, 2019

rnveach left a comment

rnveach Apr 17, 2019

romani Apr 27, 2019

Vampire May 1, 2019 •

edited

Loading

romani May 7, 2019

Vampire May 7, 2019

romani commented Apr 27, 2019

Vampire commented May 1, 2019

rnveach left a comment

Vampire commented May 6, 2019

romani left a comment •

edited

Loading

romani May 7, 2019

Vampire May 7, 2019

romani May 7, 2019

Vampire May 7, 2019

Issue #6619: Update cached Google Style Guide #6620

Issue #6619: Update cached Google Style Guide #6620

Conversation

Vampire commented Mar 30, 2019

romani commented Mar 30, 2019

rnveach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vampire May 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

romani commented Apr 27, 2019

Vampire commented May 1, 2019

rnveach left a comment

Choose a reason for hiding this comment

Vampire commented May 6, 2019

romani left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vampire May 1, 2019 •

edited

Loading

romani left a comment •

edited

Loading