Merge pull request #1536 from richardkmichael/harmonized-version

Harmonized CLI command version notation

Simon Legner committed 5 years ago

Commit 1c3ceca2 parents f2b6607 64bf56e2 files · +19 −18Browse files

Unified · Split

2 files

.github/CONTRIBUTING.md +2 −2
lib/tasks/docs.thor +17 −16

@@ -68,9 +68,9 @@ Follow the following steps to update documentations to their latest version: · 67 unmodified lines
68	2. Check if the license is still correct. If you update `options[:attribution]`, also update the documentation's entry in the array in [`assets/javascripts/templates/pages/about_tmpl.coffee`](../assets/javascripts/templates/pages/about_tmpl.coffee) to match.	68	2. Check if the license is still correct. If you update `options[:attribution]`, also update the documentation's entry in the array in [`assets/javascripts/templates/pages/about_tmpl.coffee`](../assets/javascripts/templates/pages/about_tmpl.coffee) to match.
69	3. If the documentation has a custom icon, ensure the icons in <code>public/icons/your_scraper_name/</code> are up-to-date. If you pull the updated icon from a place different than the one specified in the `SOURCE` file, make sure to replace the old link with the new one.	69	3. If the documentation has a custom icon, ensure the icons in <code>public/icons/your_scraper_name/</code> are up-to-date. If you pull the updated icon from a place different than the one specified in the `SOURCE` file, make sure to replace the old link with the new one.
70	4. If `self.links` is defined, check if the urls are still correct.	70	4. If `self.links` is defined, check if the urls are still correct.
71	5. Generate the docs using `thor docs:generate <doc>`.	71	5. Generate the docs using `thor docs:generate <doc@version>`.
72	6. Make sure `thor docs:generate` doesn't show errors and that the documentation still works well. Verify locally that everything works and that the categorization of entries is still good. Often, updates will require code changes in the scraper or its filters to tweak some new markup in the source website or to categorize new entries.	72	6. Make sure `thor docs:generate` doesn't show errors and that the documentation still works well. Verify locally that everything works and that the categorization of entries is still good. Often, updates will require code changes in the scraper or its filters to tweak some new markup in the source website or to categorize new entries.
73	7. Repeat steps 5 and 6 for all versions that you updated. `thor docs:generate` accepts a `--version` argument to specify which version to scrape.	73	7. Repeat steps 5 and 6 for all versions that you updated.
74	8. Create a PR and make sure to fill the checklist in section B of the PR template (remove the other sections).	74	8. Create a PR and make sure to fill the checklist in section B of the PR template (remove the other sections).
75		75
76	## Coding conventions	76	## Coding conventions

lib/tasks/docs.thor+17−16

     TTY::Pager.new.page(output)
   end
-  desc 'page <doc> [path] [--version] [--verbose] [--debug]', 'Generate a page (no indexing)'
+  desc 'page (<doc> | <doc@version>) [path] [--verbose] [--debug]', 'Generate a page (no indexing)'
-  option :version, type: :string
   option :verbose, type: :boolean
   option :debug, type: :boolean
   def page(name, path = '')
       Docs.install_report :filter, :request, :doc
     end
-    if Docs.generate_page(name, options[:version], path)
+    name, version = name.split(/@|~/)
+    if Docs.generate_page(name, version, path)
       puts 'Done'
     else
       puts "Failed!#{' (try running with --debug for more information)' unless options[:debug]}"
     handle_doc_not_found_error(error)
   end
-  desc 'generate <doc> [--version] [--verbose] [--debug] [--force] [--package]', 'Generate a documentation'
+  desc 'generate (<doc> | <doc@version>) [--verbose] [--debug] [--force] [--package]', 'Generate a documentation'
-  option :version, type: :string
   option :all, type: :boolean
   option :verbose, type: :boolean
   option :debug, type: :boolean
     require 'unix_utils' if options[:package]
-    doc = Docs.find(name, options[:version])
+    doc = find_doc(name)
     if doc < Docs::UrlScraper && !options[:force]
       puts <<-TEXT.strip_heredoc
     puts 'Done'
   end
-  desc 'download (<doc> <doc@version>... | --default | --installed | --all)', 'Download documentations'
+  desc 'download (<doc> <doc@version>... | --default | --installed | --all)', 'Download documentation packages'
   option :default, type: :boolean
   option :installed, type: :boolean
   option :all, type: :boolean
     handle_doc_not_found_error(error)
   end
-  desc 'package <doc> <doc@version>...', 'Package documentations'
+  desc 'package <doc> <doc@version>...', 'Create documentation packages'
   def package(*names)
     require 'unix_utils'
     docs = find_docs(names)
   private
-  def find_docs(names)
+  def find_doc(name)
-    names.flat_map do |name|
+    name, version = name.split(/@|~/)
-      name, version = name.split(/@|~/)
+    if version == 'all'
-      if version == 'all'
+      Docs.find(name, false).versions
-        Docs.find(name, false).versions
+    else
-      else
+      Docs.find(name, version)
-        Docs.find(name, version)
-      end
     end
   end
+  def find_docs(names)
+    names.flat_map {|name| find_doc(name)}
+  end
   def find_docs_by_slugs(slugs)
     slugs.flat_map do |slug|
       slug, version = slug.split(/~/)