tldr-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69d3aaf2f20daf765bd313d5dc9dc95da2a83a0c44fef218b09e549370ebb493
-  data.tar.gz: 93e8e3ed79d2324b6caf67475f26becffe84206ff4b021ea95bda0e6aeacb052
+  metadata.gz: 6bc8340ef090cdcfd533ff82ad775c7ede0266eb86f8e2339413c602e5e5d56f
+  data.tar.gz: f7876530905c3b140c1e0496545e2152a52ac02eb238015b6591097bdca829d6
 SHA512:
-  metadata.gz: c05a3e0db692a108529ecb6743fc108db8ef754f5f7df397ba55852e5bef4fdaf091295acc47527dc6210dd8b1bb53d32db06c4924fe58b1c1b236336f6af19f
-  data.tar.gz: bec29e50961368dd1237b206eacc9f93d3428d96160730e724cb7b033b540994de9ffd2a82e055dbae35f387b43b55f8d3b4dcfd143bdfeff617c648da207e9b
+  metadata.gz: 95ff5d7ceb347ce99837f9c03ac552082456daf00b59759d83fb64fa981d4c8c53b22f2329a8796f3b90b30f5acdfd7fa9e8d0d72573065995df66f04a15ff93
+  data.tar.gz: 2a65eec38bff5e22f050c240ea21512c6c8e112e1932f3b6b73e3e0a1c00abe0ad5c35c6f806606a0ed9eee1b2241e7307a36d18b5f87cb5de4037feb77c8558

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 
 ## [Unreleased]
 
+## [0.3.0] - 2024-03-06
+
+- Added support to personal local pages created at ~/.config/tldr/pages
 
 ## [0.2.0] - 2024-03-06
 

data/lib/tldr/cli/commands.rb

@@ -15,6 +15,9 @@ module TLDR
       URL_SUFFIX =
         ENV.fetch('TLDR_URL_SUFFIX', '.md')
 
+      LOCAL_BASE =
+        ENV.fetch('TLDR_LOCAL_BASE', "#{Dir.home}/.config/tldr/pages")
+
       usage do
         program 'tldr'
 
@@ -82,6 +85,15 @@ module TLDR
         desc 'select platform, supported are linux / osx / sunos / windows / common'
       end
 
+      option :source do
+        optional
+        short '-s'
+        long '--source=string'
+        default 'local'
+        permit %w[local remote]
+        desc 'select page source to be local or remote (default: local)'
+      end
+
       argument :query do
         arity zero_or_more
       end
@@ -96,11 +108,17 @@ module TLDR
         elsif params[:version]
           version
         elsif params[:query]
-          query, lang, platform =
-            params.to_h.values_at(:query, :lang, :platform)
+          query, lang, platform, source =
+            params.to_h.values_at(:query, :lang, :platform, :source)
 
           page_path = "/#{platform}/#{query}"
 
+          if source == 'local' && local_page?(local_path(page_path, lang: lang))
+            content = File.read(local_path(page_path, lang: lang))
+            render_markdown(content)
+            return
+          end
+
           response = Faraday.get(remote_path(page_path, lang: lang))
           return not_found unless response.success?
 
@@ -131,6 +149,15 @@ module TLDR
         MESSAGE
       end
 
+      def local_page?(page_path)
+        File.exist?(page_path)
+      end
+
+      def local_path(fragment, lang: 'en', relative: false)
+        lang = lang == 'en' ? '' : ".#{lang}"
+        "#{relative ? '' : LOCAL_BASE}#{lang}#{fragment}#{URL_SUFFIX}"
+      end
+
       def remote_path(fragment, lang: 'en', relative: false)
         lang = lang == 'en' ? '' : ".#{lang}"
         "#{relative ? '' : URL_BASE}#{lang}#{fragment}#{URL_SUFFIX}"

data/lib/tldr/cli/version.rb

@@ -2,6 +2,6 @@
 
 module TLDR
   module CLI
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tldr-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Vinciguerra