chore: automate download node docs

workshopper · Dec 2, 2019 · d8737b0 · d8737b0
1 parent 43294e6
commit d8737b0
Show file tree

Hide file tree

Showing 50 changed files with 29 additions and 63,823 deletions.
diff --git a/docs-nodejs/addons.html b/docs-nodejs/addons.html
diff --git a/docs-nodejs/assert.html b/docs-nodejs/assert.html
diff --git a/docs-nodejs/async_hooks.html b/docs-nodejs/async_hooks.html
diff --git a/docs-nodejs/buffer.html b/docs-nodejs/buffer.html
diff --git a/docs-nodejs/child_process.html b/docs-nodejs/child_process.html
diff --git a/docs-nodejs/cli.html b/docs-nodejs/cli.html
diff --git a/docs-nodejs/cluster.html b/docs-nodejs/cluster.html
diff --git a/docs-nodejs/console.html b/docs-nodejs/console.html
diff --git a/docs-nodejs/crypto.html b/docs-nodejs/crypto.html
diff --git a/docs-nodejs/debugger.html b/docs-nodejs/debugger.html
diff --git a/docs-nodejs/deprecations.html b/docs-nodejs/deprecations.html
diff --git a/docs-nodejs/dgram.html b/docs-nodejs/dgram.html
diff --git a/docs-nodejs/dns.html b/docs-nodejs/dns.html
diff --git a/docs-nodejs/domain.html b/docs-nodejs/domain.html
diff --git a/docs-nodejs/errors.html b/docs-nodejs/errors.html
diff --git a/docs-nodejs/esm.html b/docs-nodejs/esm.html
diff --git a/docs-nodejs/events.html b/docs-nodejs/events.html
diff --git a/docs-nodejs/fs.html b/docs-nodejs/fs.html
diff --git a/docs-nodejs/globals.html b/docs-nodejs/globals.html
diff --git a/docs-nodejs/http.html b/docs-nodejs/http.html
diff --git a/docs-nodejs/http2.html b/docs-nodejs/http2.html
diff --git a/docs-nodejs/https.html b/docs-nodejs/https.html
diff --git a/docs-nodejs/inspector.html b/docs-nodejs/inspector.html
diff --git a/docs-nodejs/intl.html b/docs-nodejs/intl.html
diff --git a/docs-nodejs/modules.html b/docs-nodejs/modules.html
diff --git a/docs-nodejs/n-api.html b/docs-nodejs/n-api.html
diff --git a/docs-nodejs/net.html b/docs-nodejs/net.html
diff --git a/docs-nodejs/os.html b/docs-nodejs/os.html
diff --git a/docs-nodejs/path.html b/docs-nodejs/path.html
diff --git a/docs-nodejs/perf_hooks.html b/docs-nodejs/perf_hooks.html
diff --git a/docs-nodejs/policy.html b/docs-nodejs/policy.html
diff --git a/docs-nodejs/process.html b/docs-nodejs/process.html
diff --git a/docs-nodejs/punycode.html b/docs-nodejs/punycode.html
diff --git a/docs-nodejs/querystring.html b/docs-nodejs/querystring.html
diff --git a/docs-nodejs/readline.html b/docs-nodejs/readline.html
diff --git a/docs-nodejs/repl.html b/docs-nodejs/repl.html
diff --git a/docs-nodejs/report.html b/docs-nodejs/report.html
diff --git a/docs-nodejs/stream.html b/docs-nodejs/stream.html
diff --git a/docs-nodejs/string_decoder.html b/docs-nodejs/string_decoder.html
diff --git a/docs-nodejs/timers.html b/docs-nodejs/timers.html
diff --git a/docs-nodejs/tls.html b/docs-nodejs/tls.html
diff --git a/docs-nodejs/tracing.html b/docs-nodejs/tracing.html
diff --git a/docs-nodejs/tty.html b/docs-nodejs/tty.html
diff --git a/docs-nodejs/url.html b/docs-nodejs/url.html
diff --git a/docs-nodejs/util.html b/docs-nodejs/util.html
diff --git a/docs-nodejs/v8.html b/docs-nodejs/v8.html
diff --git a/docs-nodejs/vm.html b/docs-nodejs/vm.html
diff --git a/docs-nodejs/worker_threads.html b/docs-nodejs/worker_threads.html
diff --git a/package.json b/package.json
@@ -70,6 +70,7 @@
     "through": "^2.3.8",
     "through2": "^3.0.1",
     "through2-map": "^3.0.0",
+    "website-scraper": "^4.2.0",
     "workshopper-adventure": "^6.0.4",
     "workshopper-exercise": "^3.0.1",
     "workshopper-wrappedexec": "~0.1.3"
@@ -80,8 +81,10 @@
   },
   "scripts": {
     "download-node-docs": "./tools/download-node-docs.sh",
+    "docs": "./tools/docs.js",
     "lint": "./node_modules/.bin/standard",
-    "test": "npm run lint && ./node_modules/.bin/workshopper-adventure-test"
+    "test": "npm run lint && ./node_modules/.bin/workshopper-adventure-test",
+		"postinstall": "npm run docs"
   },
   "bin": {
     "learnyounode": "./bin/learnyounode"

diff --git a/tools/docs.js b/tools/docs.js
@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const fsp = fs.promises
+const scrape = require('website-scraper')
+const scrapeDir = 'scrape'
+const options = {
+  urls: ['https://nodejs.org/api/'],
+  filenameGenerator: 'bySiteStructure',
+  recursive: true,
+  maxRecursiveDepth: 1,
+  directory: scrapeDir
+}
+
+const main = async () => {
+  if (fs.existsSync(scrapeDir)) {
+    await fsp.rmdir(scrapeDir, { recursive: true })
+  }
+  await scrape(options)
+  fsp.rename(`${scrapeDir}/nodejs.org/api`, 'docs-nodejs').then(() => {
+    fsp.rmdir(scrapeDir, { recursive: true })
+  })
+}
+
+main()