graphqlmd 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6065d284022c32bbad1063031cc29c1b2b572d48b55160cf74a7af632786e90
-  data.tar.gz: 0ac3353137d0d1009138b31502ce65c4fdbd9a792ab5bf51bc53e525869cdc27
+  metadata.gz: 491acad5247c7115bc66ce15c3ec49ecb2a5eede531a335743e1b2e3f732f4ad
+  data.tar.gz: 5185b2d3746e5af4df9beb70582ce94547fbf3c690b108c7449525cb66203da9
 SHA512:
-  metadata.gz: 8641781630e65ce96103d14ac799bc89d43cad59efd179e03db3fde1d38ab7613164e058356474d6c3ffef02cc0eb6dac06732deb66d40ae7c3fc2bfc3fc3984
-  data.tar.gz: 0caca010c75dbc7f4e454039fca3311dd50d41092e6cd6ac97f4b3fe7f2890fb03288268af4beade91284be5bc0a8c90962d7e8739e0f460485e325e9d28e72e
+  metadata.gz: a6abaef651cd3dbd565b0ba9e33cbd3faa87b9b78c0a2ab2f69db47671e2f1d560bcca25bc6ea6f074ceeef78008ff8c61fa945acfc15233bde4eb01b181087b
+  data.tar.gz: ad9b3d985f3721f9558acbdee3cbb1265e84b80db0312c5b3757939b8204462febe13a800dcfc62cf2ee7149010a76011b4559cc1b7ad56ee7a9844dbd94ce98

data/bin/graphqlmd

@@ -5,9 +5,12 @@ require 'optparse'
 
 options = {
   url: 'http://localhost:3000/graphql',
+  title: 'GraphQL API',
+  note: nil,
   is_hide_client_mutation_id: true,
   is_hide_scalar: true,
   is_hide_deprecated: false,
+  is_hide_table_of_contents: false,
   is_allow_links: true,
   is_vuepress: false,
   ignored_queries: [],
@@ -30,6 +33,16 @@ OptionParser.new do |opts|
     options[:url] = url
   end
 
+  opts.on(
+    '-t', '--title [TITLE]', "Title (default: #{options[:title]})"
+  ) do |title|
+    options[:title] = title
+  end
+
+  opts.on '--note [NOTE]', 'Text after title (default: nil)' do |note|
+    options[:note] = note
+  end
+
   opts.on '--no-deprecated', 'Do not add deprecated objects, fields, args and etc.' do
     options[:is_hide_deprecated] = true
   end
@@ -38,6 +51,10 @@ OptionParser.new do |opts|
     options[:is_allow_links] = false
   end
 
+  opts.on '--no-table-of-contents', 'Do not add table of contents' do
+    options[:is_hide_table_of_contents] = true
+  end
+
   opts.on '--client-mutation-id', 'Add clientMutationId to docs' do
     options[:is_hide_client_mutation_id] = false
   end

data/lib/graphqlmd.rb

@@ -9,7 +9,10 @@ class Graphqlmd::Graphqlmd
 
   def initialize options
     @url = options[:url]
+    @title = options[:title]
+    @note = options[:note]
     @is_hide_client_mutation_id = options[:is_hide_client_mutation_id]
+    @is_hide_table_of_contents = options[:is_hide_table_of_contents]
     @is_hide_deprecated = options[:is_hide_deprecated]
     @is_hide_scalar = options[:is_hide_scalar]
     @is_allow_links = options[:is_allow_links]
@@ -22,6 +25,10 @@ class Graphqlmd::Graphqlmd
   def call
     response = fetch_schema
     data = JSON.parse(response.body).dig 'data', 'schema'
+
+    puts_title
+    puts_note
+    puts_top_table_of_contents
     puts_queries data['queries']
     puts_mutations data['mutations']
     puts_objects data['types']
@@ -29,12 +36,37 @@ class Graphqlmd::Graphqlmd
 
 private
 
+  def puts_title
+    return if @title.nil?
+    return if @title.empty?
+
+    puts "# #{@title}\n\n"
+  end
+
+  def puts_note
+    return if @note.nil?
+    return if @note.empty?
+
+    puts "#{@note}\n\n"
+  end
+
+  def puts_top_table_of_contents
+    return if @is_hide_table_of_contents
+
+    puts '- [Queries](#queries)'
+    puts '- [Mutations](#mutations)'
+    puts '- [Objects](#objects)'
+    puts "\n"
+  end
+
   def puts_queries data
     print_header 'Queries'
     queries = data['fields']
       .reject { |v| @ignored_queries.include? v['name'] }
       .sort_by { |v| v['name'] }
 
+    puts_table_of_contents queries
+
     queries.each do |v|
       puts "\n### #{v['name']}\n"
       print_deprecation v
@@ -50,9 +82,10 @@ private
     mutations = data['fields']
       .reject { |v| @ignored_mutations.include? v['name'] }
       .sort_by { |v| v['name'] }
-
     mutations = mutations.reject { |v| v['isDeprecated'] } if @is_hide_deprecated
 
+    puts_table_of_contents mutations
+
     mutations.each do |v|
       puts "\n### #{v['name']}\n"
       print_deprecation v
@@ -71,6 +104,8 @@ private
       .sort_by { |v| v['name'] }
     objects = objects.reject { |v| v['kind'] == SCALAR } if @is_hide_scalar
 
+    puts_table_of_contents objects
+
     objects.each do |v|
       puts "\n### #{v['name']}\n"
       puts "#{print_description v['description']}\n" unless v['description'].nil?
@@ -85,6 +120,14 @@ private
     puts "## #{value}\n"
   end
 
+  def puts_table_of_contents items
+    return if @is_hide_table_of_contents
+
+    items.each do |v|
+      puts "- [#{v['name']}](##{v['name'].downcase})"
+    end
+  end
+
   def print_fields fields
     return if fields.nil?
     return if fields.empty?
@@ -120,7 +163,8 @@ private
     puts "Name | Type | Description\n"
     puts "-|-|-|-\n"
     args.each do |v|
-      puts "#{v['name']} | #{type_as_string(v['type'])} | #{print_description(v['description'])}\n"
+      description = v['description'] || (v['type'] && v['type']['ofType'] && v['type']['ofType']['description'])
+      puts "#{v['name']} | #{type_as_string(v['type'])} | #{print_description(description)}\n"
     end
   end
 

data/lib/graphqlmd/consts.rb

@@ -39,32 +39,41 @@ module Graphqlmd
       type {
         ...TypeRef
       }
+      description
       defaultValue
     }
     fragment TypeRef on __Type {
       kind
       name
+      description
       ofType {
         kind
         name
+        description
         ofType {
           kind
           name
+          description
           ofType {
             kind
             name
+            description
             ofType {
               kind
               name
+              description
               ofType {
                 kind
                 name
+                description
                 ofType {
                   kind
                   name
+                  description
                   ofType {
                     kind
                     name
+                    description
                   }
                 }
               }

data/lib/graphqlmd/version.rb

@@ -1,3 +1,3 @@
 module Graphqlmd
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphqlmd
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Alexander Kalinichev