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 1563677
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 31 deletions.
16 changes: 6 additions & 10 deletions development/generate_api_coverage.rb
Expand Up @@ -35,15 +35,8 @@ def initialize(raw_doc)
end

def parse
Enumerator.new do |data|
puppeteer_entrypoint = @root.members.first
data << ClassDoc.new('Puppeteer', method_docs_for(puppeteer_entrypoint))

puppeteer_entrypoint.members.each do |member|
if member.kind == 'Class'
data << ClassDoc.new(member.name, method_docs_for(member))
end
end
@root.members.first.members.filter_map do |member|
ClassDoc.new(member.name, method_docs_for(member)) if member.kind == 'Class'
end
end

Expand Down Expand Up @@ -212,7 +205,10 @@ def api_coverages

apidoc_content = File.read(File.join(__dir__, 'puppeteer.api.json'))
class_docs = ApiDocJsonParser.new(apidoc_content).parse

puppeteer_methods = class_docs.filter_map { |doc| doc.methods if doc.name.start_with?('Puppeteer') }.flatten
puppeteer_doc = ClassDoc.new('Puppeteer', puppeteer_methods.sort_by(&:name))
class_docs.delete_if { |doc| doc.name.start_with?('Puppeteer') }
class_docs.unshift(puppeteer_doc)

File.open(File.join('.', 'docs', 'api_coverage.md'), 'w') do |f|
f.write("# API coverages\n")
Expand Down
22 changes: 1 addition & 21 deletions docs/api_coverage.md
Expand Up @@ -6,16 +6,12 @@

* ~~clearCustomQueryHandlers~~
* connect
* connect
* ~~createBrowserFetcher~~
* ~~customQueryHandlerNames~~
* ~~DEFAULT_INTERCEPT_RESOLUTION_PRIORITY~~
* defaultArgs => `#default_args`
* devices
* ~~errors~~
* ~~EVALUATION_SCRIPT_URL~~
* executablePath => `#executable_path`
* launch
* networkConditions => `#network_conditions`
* ~~registerCustomQueryHandler~~
* ~~unregisterCustomQueryHandler~~

Expand Down Expand Up @@ -366,22 +362,6 @@
## ~~ProtocolError~~
## Puppeteer
* ~~clearCustomQueryHandlers~~
* connect
* ~~customQueryHandlerNames~~
* ~~registerCustomQueryHandler~~
* ~~unregisterCustomQueryHandler~~
## ~~PuppeteerNode~~
* ~~connect~~
* ~~createBrowserFetcher~~
* ~~defaultArgs~~
* ~~executablePath~~
* ~~launch~~
## ~~SecurityDetails~~
* ~~issuer~~
Expand Down

0 comments on commit 1563677

Please sign in to comment.