Miroirs/devdocs
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/devdocs synced 2024-11-16 19:48:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1839 from axelf4/fix-erlang

Browse source 
Fix Erlang lib/ entries and func Types sec
This commit is contained in:
Simon Legner 2022-10-23 17:39:19 +02:00 committed by GitHub
commit c1c546e72b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 48 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
assets/stylesheets/pages/_erlang.scss
View file

@ -6,4 +6,10 @@
.note { @extend %note; }
.warning { @extend %note, %note-red; }
.note .label, .warning .label { font-weight: var(--boldFontWeight); }
.since {
color: var(--textColorLight);
font-weight: normal;
font-size: small;
}
}

80
lib/docs/filters/erlang/clean_html.rb
View file

@ -12,8 +12,6 @@ module Docs
node.before(node.children).remove
end
css('> br').remove
css('> font[size="+1"]:first-child').each do |node|
node.name = 'h1'
end
@ -30,63 +28,55 @@ module Docs
# others
css('a[name]').each do |node|
# parent = node.parent
# parent = parent.parent while parent.name == 'span'
(node.next_element || node.parent)['id'] ||= node['name']
node.before(node.children).remove
# Remove JS on-hover highlighting
css('h3.title-link', 'h4.title-link', 'div.data-type-name', 'div.func-head').each do |node|
node.remove_attribute('onmouseover')
node.remove_attribute('onmouseout')
end
css('h3').each do |node|
node.name = 'h2'
content = node.content
node.content = content.capitalize if content == content.upcase
end
css('p > .bold_code:first-child ~ br:last-child').each do |node|
# Subsume "Types" heading under function head heading
css('h4.func-head + .fun-types > h3.func-types-title')
.each { |node| node.name = 'h5' }
css('p > a[name]').each do |node|
parent = node.parent
parent.name = 'h3'
parent.css('> br').remove
parent.css('> code').each do |code|
code.css('*:not(a):not(br)').each { |n| n.before(n.children).remove }
code.inner_html = code.inner_html.gsub('<br>', "\n").strip
parent.name = 'h4'
parent['id'] ||= node['name']
parent.css('> br:last-child').remove
end
css('a[name]:empty').each { |n| (n.next_element || n.parent)['id'] ||= n['name'] }
css('h3', 'h4', 'h5').each do |node|
node.name = node.name.sub(/\d/) { |i| i.to_i - 1 }
end
# Convert <span/> code blocks to <code/> if inline otherwise <pre><code/></pre>
css('span.bold_code', 'span.code', '.func-head > span.title-name').each do |node|
node.remove_attribute('class')
node.css('span.bold_code', 'span.code')
.each { |n| n.before(n.children).remove }
if node.at_css('br') then
node.name = 'pre'
node.inner_html = "<code>" +
node.inner_html.remove(/\n/).gsub('<br>', "\n").strip +
"</code>"
else
node.name = 'code'
node.inner_html = node.inner_html.strip.gsub(/\s+/, ' ')
end
end
css('pre:not(.REFTYPES) *:not(a)', 'a[href^=javascript]').each do |node|
node.before(node.children).remove
end
css('pre:not(.REFTYPES)').each do |node|
css('*:not(.REFTYPES) > pre').each do |node|
node['data-language'] = 'erlang'
node.inner_html = node.inner_html.strip_heredoc
end
css('.REFBODY').each do |node|
if node.element_children.length == 0
node.name = 'p'
else
node.before(node.children).remove
end
end
css('.REFTYPES').each do |node|
next unless node.parent
html = "<pre>"
while node['class'] == 'REFTYPES'
node.inner_html = node.inner_html.remove(/\n/).gsub('<br>', "\n")
node.css('*:not(a)').each { |n| n.before(n.children).remove }
html << node.inner_html.strip + "\n"
node = node.next_element
node.previous_element.remove
end
html.gsub! %r{\n{2,}}, "\n"
html.strip!
html << "</pre>"
node.before(html)
end
css('.REFTYPES').remove
css('a[href^=javascript]').each { |n| n.before(n.children).remove }
css('table').each do |node|
node.remove_attribute('border')
@ -99,8 +89,6 @@ module Docs
node.remove_attribute('valign')
end
css('.bold_code').remove_attr('class')
doc
end
end

13
lib/docs/filters/erlang/entries.rb
View file

@ -2,14 +2,14 @@ module Docs
class Erlang
class EntriesFilter < Docs::EntriesFilter
def get_name
name = at_css('h1').content.strip
name = at_css('#content h1').content.strip
name << " (#{type.remove('Guide: ')})" if name == '1 Introduction'
name.sub! %r{\A(\d+)}, '\1.'
name
end
def get_type
name = at_css('h1').content.strip
name = at_css('#content h1').content.strip
if subpath.start_with?('lib/')
type = subpath[/lib\/(.+?)[\-\/]/, 1]
@ -44,10 +44,9 @@ module Docs
if subpath.start_with?('lib/')
names = Set.new
entry_nodes.each_with_object [] do |node, entries|
id = node['name']
id = node['id'] || node['name']
name = id.remove %r{\-\d*\z}
name << ' (type)' if name.sub!(/\Atype-/, '')
name.remove! 'Module:'
name.prepend "#{self.name}:"
entries << [name, id] if names.add?(name)
end
@ -67,9 +66,13 @@ module Docs
def entry_nodes
@entry_nodes ||= if subpath.start_with?('lib/')
css('p + div.REFBODY').each_with_object [] do |node, result|
r18_funs = css('p + div.REFBODY').each_with_object [] do |node, result|
result.concat(node.previous_element.css('a[name]').to_a)
end
css('article.data-types-body > h4', 'article.func > h4',
'div.data-type-name a[name]', 'div.exports-body > a[name]',
'div.fun-type a[name]').entries +
r18_funs
elsif subpath.start_with?('erts')
link = at_css(".flipMenu a[href='#{File.basename(subpath, '.html')}']")
list = link.parent.parent

9
lib/docs/filters/erlang/pre_clean_html.rb
View file

@ -4,15 +4,6 @@ module Docs
def call
css('.flipMenu li[title] > a').remove unless subpath.start_with?('erts') # perf
css('.REFTYPES').each do |node|
node.name = 'pre'
end
css('span.bold_code', 'span.code').each do |node|
node.name = 'code'
node.inner_html = node.inner_html.strip.gsub(/\s+/, ' ')
end
doc
end
end