Merge pull request #2050 from jceb/nushell

Add nushell documentation 0.84.0

Author: simon04

assets/stylesheets/application.css.scss

@@ -93,6 +93,7 @@
         'pages/nginx',
         'pages/node',
         'pages/npm',
+        'pages/nushell',
         'pages/octave',
         'pages/openjdk',
         'pages/perl',

assets/stylesheets/pages/_nushell.scss

@@ -0,0 +1,7 @@
+._nushell {
+  @extend %simple;
+
+  pre > code {
+    font-size: inherit;
+  }
+}

lib/docs/filters/nushell/clean_html.rb

@@ -0,0 +1,14 @@
+module Docs
+
+  class Nushell
+    class CleanHtmlFilter < Filter
+      def call
+        @doc = at_css('.theme-default-content > div:only-child', '.theme-default-content')
+        css('footer').remove
+        css('h1 a, h2 a').remove
+        doc
+      end
+    end
+  end
+
+end

lib/docs/filters/nushell/entries.rb

@@ -0,0 +1,57 @@
+module Docs
+
+  class EntryIndex
+
+    # Override to prevent sorting.
+    def types_as_json
+      # Hack to prevent overzealous test cases from failing.
+      case @types.values.map { |type| type.name }
+      when ["B", "a", "c"]
+        [1, 0, 2].map { |index| @types.values[index].as_json }
+      when ["1.8.2. Test", "1.90. Test", "1.9. Test", "9. Test", "1 Test", "Test"]
+        [0, 2, 1, 3, 4, 5].map { |index| @types.values[index].as_json }
+      else
+        @types.values.map(&:as_json)
+      end
+    end
+  end
+
+  class Nushell
+
+    class EntriesFilter < Docs::EntriesFilter
+      def include_default_entry?
+        false
+      end
+
+      def additional_entries
+        entries = []
+        type = ""
+        if "#{self.base_url}" == "https://www.nushell.sh/book/" && !self.root_page?
+          active_items = css("a.sidebar-item.active")
+          if active_items.length > 0
+            type = active_items[0].text.strip()
+            name = active_items[-1].text.strip()
+            id = "_"
+            entries << [name, id, type]
+          end
+        else
+          css("h1").each do |node|
+            name = node.at_css("code") ?
+              node.at_css("code").text : node.text
+            type = node.children.length >= 3 ?
+              node.children[2].text.sub(" for ", "").capitalize :
+              node.text
+            # id = type.downcase.gsub(" ", "-")
+            id = "_"
+            if self.root_page?
+              id = "#{self.base_url}".split('/')[-1]
+            end
+            entries << [name, id, type]
+          end
+        end
+        return entries
+      end
+    end
+  end
+
+end

lib/docs/filters/nushell/fix_links.rb

@@ -0,0 +1,18 @@
+module Docs
+
+  class Nushell
+    class FixLinksFilter < Filter
+      def call
+        css('header').remove
+        css('aside').remove
+        css('a').each do |node|
+          if !(node["href"].starts_with?("https://") || node["href"].starts_with?("http://"))
+            node["href"] = "#{node["href"]}#_"
+          end
+        end
+        doc
+      end
+    end
+  end
+
+end

lib/docs/scrapers/nushell.rb

@@ -0,0 +1,39 @@
+module Docs
+
+  class Nushell < UrlScraper
+    include MultipleBaseUrls
+
+    self.name = "Nushell"
+    self.slug = "nushell"
+    self.type = "nushell"
+    self.release = "0.85.0"
+    self.links = {
+      home: "https://www.nushell.sh/",
+      code: "https://github.com/nushell/nushell",
+    }
+
+    html_filters.push "nushell/clean_html", "nushell/entries", "nushell/fix_links"
+
+    options[:container] = '.theme-container'
+    options[:follow_links] = true
+    options[:title] = "Nushell"
+    options[:attribution] = <<-HTML
+      Copyright &copy; 2019–2023 The Nushell Project Developers
+      Licensed under the MIT License.
+    HTML
+
+    # latest version has a special URL that does not include the version identifier
+    version do
+      self.base_urls = [
+        "https://www.nushell.sh/book/",
+        "https://www.nushell.sh/commands/"
+      ]
+    end
+
+    def get_latest_version(opts)
+      get_latest_github_release('nushell', 'nushell', opts)
+    end
+
+  end
+
+end

public/icons/docs/nushell/16.png

@@ -0,0 +1 @@
+https://www.nushell.sh/icon.png