Skip to content

Commit

Permalink
merge Puppeteer and PuppeteerNode docs
Browse files Browse the repository at this point in the history
  • Loading branch information
YusukeIwaki committed Aug 14, 2022
1 parent f173cf2 commit 1967160
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 30 deletions.
39 changes: 27 additions & 12 deletions development/generate_api_coverage.rb
Expand Up @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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")
Expand Down
18 changes: 0 additions & 18 deletions docs/api_coverage.md
Expand Up @@ -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`
Expand Down Expand Up @@ -366,22 +364,6 @@
## ~~ProtocolError~~
## Puppeteer
* ~~clearCustomQueryHandlers~~
* connect
* ~~customQueryHandlerNames~~
* ~~registerCustomQueryHandler~~
* ~~unregisterCustomQueryHandler~~
## ~~PuppeteerNode~~
* ~~connect~~
* ~~createBrowserFetcher~~
* ~~defaultArgs~~
* ~~executablePath~~
* ~~launch~~
## ~~SecurityDetails~~
* ~~issuer~~
Expand Down

0 comments on commit 1967160

Please sign in to comment.