Add Herb linter and fix HTML and ERB linting issues (#1434)

- Added `Herb LSP` to suggested VS Code extension, which will surface
ERB/HTML issues in `.rthml` templates.
- Fixed all surfaced issues
- Added ERB lint step on CI

Author: st0012

.github/workflows/lint.yml

@@ -27,3 +27,7 @@ jobs:
         bundler-cache: true
     - name: Run rubocop
       run: bundle exec rubocop
+    - name: Run herb linter
+      # npx should be available by default so we don't need `setup-node` action
+      # Don't lint erb files outside of lib as the current directory also includes vendor/bundle
+      run: npx @herb-tools/linter "lib/**/*.rhtml"

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "marcoroth.herb-lsp"
+    ]
+}

lib/rdoc/generator/template/darkfish/_footer.rhtml

@@ -1,5 +1,5 @@
 <footer id="validator-badges" role="contentinfo">
-  <p><a href="https://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+  <p><a href="https://validator.w3.org/check/referer">Validate</a></p>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>.</p>
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>
 </footer>

lib/rdoc/generator/template/darkfish/_head.rhtml

@@ -1,34 +1,34 @@
 <meta charset="<%= @options.charset %>">
-<meta name="viewport" content="width=device-width, initial-scale=1" />
+<meta name="viewport" content="width=device-width, initial-scale=1">
 
 <title><%= h @title %></title>
 
-<%- if defined?(klass) -%>
+<%- if defined?(klass) %>
   <meta name="keywords" content="ruby,<%= h "#{klass.type},#{klass.full_name}" %>">
 
-  <%- if klass.comment.empty? -%>
+  <%- if klass.comment.empty? %>
     <meta name="description" content="Documentation for the <%= h "#{klass.full_name} #{klass.type}" %>">
-  <%- else -%>
+  <%- else %>
     <meta name="description" content="<%= h "#{klass.type} #{klass.full_name}: #{excerpt(klass.comment)}" %>">
-  <%- end -%>
-<%- elsif defined?(file) -%>
+  <%- end %>
+<%- elsif defined?(file) %>
   <meta name="keywords" content="ruby,documentation,<%= h file.page_name %>">
   <meta name="description" content="<%= h "#{file.page_name}: #{excerpt(file.comment)}" %>">
-<%- elsif @title -%>
+<%- elsif @title %>
   <meta name="keywords" content="ruby,documentation,<%= h @title %>">
 
   <%- if @options.main_page and
       main_page = @files.find { |f| f.full_name == @options.main_page } then %>
     <meta name="description" content="<%= h "#{@title}: #{excerpt(main_page.comment)}" %>">
-  <%- else -%>
+  <%- else %>
     <meta name="description" content="Documentation for <%= h @title %>">
-  <%- end -%>
-<%- end -%>
+  <%- end %>
+<%- end %>
 
-<%- if canonical_url = @options.canonical_root -%>
+<%- if canonical_url = @options.canonical_root %>
 <% canonical_url = current.canonical_url if defined?(current) %>
 <link rel="canonical" href="<%= canonical_url %>">
-<%- end -%>
+<%- end %>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
@@ -43,6 +43,6 @@
 
 <link href="<%= h asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
 <link href="<%= h asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
-<%- @options.template_stylesheets.each do |stylesheet| -%>
+<%- @options.template_stylesheets.each do |stylesheet| %>
 <link href="<%= h asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
-<%- end -%>
+<%- end %>

lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml

@@ -3,13 +3,13 @@
   <h3>Extended With Modules</h3>
 
   <ul class="link-list">
-    <%- klass.extends.each do |ext| -%>
-  <%- unless String === ext.module then -%>
-    <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
-  <%- else -%>
-    <li><span class="extend"><%= ext.name %></span>
-  <%- end -%>
-  <%- end -%>
+  <%- klass.extends.each do |ext| %>
+  <%- unless String === ext.module then %>
+    <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a></li>
+  <%- else %>
+    <li><span class="extend"><%= ext.name %></span></li>
+  <%- end %>
+  <%- end %>
   </ul>
 </div>
-<%- end -%>
+<%- end %>

lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml

@@ -3,13 +3,13 @@
   <h3>Included Modules</h3>
 
   <ul class="link-list">
-  <%- klass.includes.each do |inc| -%>
-  <%- unless String === inc.module then -%>
-    <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
-  <%- else -%>
-    <li><span class="include"><%= inc.name %></span>
-  <%- end -%>
-  <%- end -%>
+  <%- klass.includes.each do |inc| %>
+  <%- unless String === inc.module then %>
+    <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
+  <%- else %>
+    <li><span class="include"><%= inc.name %></span></li>
+  <%- end %>
+  <%- end %>
   </ul>
 </div>
-<%- end -%>
+<%- end %>

lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml

@@ -2,14 +2,15 @@
   <h3>Documentation</h3>
 
   <ul>
-  <%- installed.each do |name, href, exists, type, _| -%>
-    <%- next if type == :extra -%>
+  <%- installed.each do |name, href, exists, type, _| %>
+    <%- next if type == :extra %>
     <li class="folder">
-    <%- if exists then -%>
+    <%- if exists then %>
       <a href="<%= href %>"><%= h name %></a>
-    <%- else -%>
+    <%- else %>
       <%= h name %>
-    <%- end -%>
-  <%- end -%>
+    <%- end %>
+    </li>
+  <%- end %>
   </ul>
 </div>

lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml

@@ -2,9 +2,9 @@
   <div class="nav-section">
     <h3>Class Methods</h3>
     <ul class="link-list" role="directory">
-      <%- class_methods.each do |meth| -%>
-      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
-      <%- end -%>
+      <%- class_methods.each do |meth| %>
+      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name %></a></li>
+      <%- end %>
     </ul>
   </div>
 <% end %>
@@ -13,9 +13,9 @@
   <div class="nav-section">
     <h3>Instance Methods</h3>
     <ul class="link-list" role="directory">
-      <%- instance_methods.each do |meth| -%>
-      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
-      <%- end -%>
+      <%- instance_methods.each do |meth| %>
+      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name %></a></li>
+      <%- end %>
     </ul>
   </div>
 <% end %>

lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml

@@ -1,32 +1,32 @@
 <%- simple_files = @files.select { |f| f.text? } %>
-<%- if defined?(current) -%>
-  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name -%>
-<%- end -%>
-<%- unless simple_files.empty? then -%>
+<%- if defined?(current) %>
+  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
+<%- end %>
+<%- unless simple_files.empty? then %>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  <%- simple_files.group_by do |f| -%>
-    <%- f.full_name[%r{\A[^/]+(?=/)}] || f.page_name -%>
-  <%- end.each do |n, files| -%>
-    <%- f = files.shift -%>
-    <%- if files.empty? -%>
-    <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
-      <%- next -%>
-    <%- end -%>
-    <li><details<% if dir == n %> open<% end %>><summary><%
+  <%- simple_files.group_by do |f|
+    f.full_name[%r{\A[^/]+(?=/)}] || f.page_name
+  end.each do |n, files| %>
+    <%- f = files.shift %>
+    <%- if files.empty? %>
+    <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a></li>
+      <%- next %>
+    <%- end %>
+    <li><details<%= ' open' if dir == n %>><summary><%
     if n == f.page_name
       %><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a><%
     else
       %><%= h n %><% files.unshift(f)
     end %></summary>
     <ul class="link-list">
-    <%- files.each do |f| -%>
-      <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
-    <%- end -%>
-    </ul></details>
-  <%- end -%>
+    <%- files.each do |f| %>
+      <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a></li>
+    <%- end %>
+    </ul></details></li>
+  <%- end %>
   </ul>
 </div>
-<%- end -%>
+<%- end %>

lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml

@@ -1,6 +1,6 @@
-<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? -%>
+<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? %>
 <div id="parent-class-section" class="nav-section">
   <h3>Ancestors</h3>
   <%= generate_ancestor_list(ancestors, klass) %>
 </div>
-<%- end -%>
+<%- end %>