From 1967160417df8c45ede170fc16adca3f31d1b085 Mon Sep 17 00:00:00 2001 From: YusukeIwaki Date: Mon, 15 Aug 2022 00:48:13 +0900 Subject: [PATCH] merge Puppeteer and PuppeteerNode docs --- development/generate_api_coverage.rb | 39 +++++++++++++++++++--------- docs/api_coverage.md | 18 ------------- 2 files changed, 27 insertions(+), 30 deletions(-) diff --git a/development/generate_api_coverage.rb b/development/generate_api_coverage.rb index 6ac7ea8..6996ef1 100644 --- a/development/generate_api_coverage.rb +++ b/development/generate_api_coverage.rb @@ -21,6 +21,18 @@ def inspect }.compact.inspect end + def class? + @kind == 'Class' + end + + def method? + @kind == 'Method' || @kind == 'Function' + end + + def property? + @kind == 'Variable' && @name =~ /^[a-z]/ + end + def members @__members ||= @members.map do |json| Member.new(json) @@ -34,22 +46,23 @@ def initialize(raw_doc) @root = Member.new(json) end - def parse - Enumerator.new do |data| - puppeteer_entrypoint = @root.members.first - data << ClassDoc.new('Puppeteer', method_docs_for(puppeteer_entrypoint)) + def puppeteer_doc + ClassDoc.new('Puppeteer', method_docs_for(puppeteer_entrypoint)) + end - puppeteer_entrypoint.members.each do |member| - if member.kind == 'Class' - data << ClassDoc.new(member.name, method_docs_for(member)) - end - end + def class_docs + puppeteer_entrypoint.members.filter_map do |member| + ClassDoc.new(member.name, method_docs_for(member)) if member.class? end end + private def puppeteer_entrypoint + @root.members.first + end + private def method_docs_for(member) member.members.filter_map do |m| - MethodDoc.new(m.name) if %w(Method Function Variable).include?(m.kind) + MethodDoc.new(m.name) if m.method? || m.property? end end end @@ -211,8 +224,10 @@ def api_coverages end apidoc_content = File.read(File.join(__dir__, 'puppeteer.api.json')) -class_docs = ApiDocJsonParser.new(apidoc_content).parse - +parser = ApiDocJsonParser.new(apidoc_content) +class_docs = parser.class_docs +class_docs.delete_if { |doc| doc.name.start_with?('Puppeteer') } +class_docs.unshift(parser.puppeteer_doc) File.open(File.join('.', 'docs', 'api_coverage.md'), 'w') do |f| f.write("# API coverages\n") diff --git a/docs/api_coverage.md b/docs/api_coverage.md index ce88084..3fbd16e 100644 --- a/docs/api_coverage.md +++ b/docs/api_coverage.md @@ -8,11 +8,9 @@ * connect * ~~createBrowserFetcher~~ * ~~customQueryHandlerNames~~ -* ~~DEFAULT_INTERCEPT_RESOLUTION_PRIORITY~~ * defaultArgs => `#default_args` * devices * ~~errors~~ -* ~~EVALUATION_SCRIPT_URL~~ * executablePath => `#executable_path` * launch * networkConditions => `#network_conditions` @@ -366,22 +364,6 @@ ## ~~ProtocolError~~ -## Puppeteer - -* ~~clearCustomQueryHandlers~~ -* connect -* ~~customQueryHandlerNames~~ -* ~~registerCustomQueryHandler~~ -* ~~unregisterCustomQueryHandler~~ - -## ~~PuppeteerNode~~ - -* ~~connect~~ -* ~~createBrowserFetcher~~ -* ~~defaultArgs~~ -* ~~executablePath~~ -* ~~launch~~ - ## ~~SecurityDetails~~ * ~~issuer~~