dev: update scripts

Author: Luke-zhang-04

scripts/checkDocs.mjs

@@ -0,0 +1,35 @@
+#!/bin/node
+
+/**
+ * @file Checks If documentation data is up to date
+ */
+
+import crypto from "crypto"
+import {dirname} from "path"
+import {fileURLToPath} from "url"
+import {promises as fs} from "fs"
+import yaml from "yaml"
+import getDocs from "./helpers/fetchDocs.mjs"
+
+export const hash = (algo, contents, format = "hex") =>
+    crypto.createHash(algo).update(contents).digest(format)
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+const newDocs = await getDocs()
+const newDocsString = `# THIS IS AN AUTOGENERATED FILE; DO NOT EDIT DIRECTLY\n\n${yaml.stringify(
+    newDocs,
+    {
+        sortMapEntries: true,
+    },
+)}`.trim()
+
+const oldDocsString = (
+    await fs.readFile(`${__dirname}/../data/documentation-data.yml`, "utf-8")
+).trim()
+
+if (hash("sha256", newDocsString) === hash("sha256", oldDocsString)) {
+    console.log("Documentation data is up to date")
+} else {
+    throw new Error("Documentation is out of date")
+}

scripts/fetchDocs.mjs scripts/helpers/fetchDocs.mjsscripts/fetchDocs.mjs renamed to scripts/helpers/fetchDocs.mjs

@@ -1,18 +1,8 @@
 #!/bin/node
 
-/**
- * @file gets Documentation from https://processing.org/reference and dumps it into
- *   `src/documentation-data.json` with some bootleg webscraping
- */
-
 import {JSDOM} from "jsdom"
-import {dirname} from "path"
 import fetch from "node-fetch"
-import {fileURLToPath} from "url"
-import {promises as fs} from "fs"
-import yaml from "yaml"
 
-const __dirname = dirname(fileURLToPath(import.meta.url))
 const docsUrl = "https://processing.org/reference"
 
 // Processing global variables
@@ -115,7 +105,7 @@ const escapeHTML = (html) =>
  * Gets the documentation for a single link
  *
  * @param {string} link - Link to get doc from
- * @returns {Promise<import("../src/types").DocumentationVariable>}
+ * @returns {Promise<import("../../src/types").DocumentationVariable>}
  */
 const documentVariable = async (link) => {
     const documentation = {
@@ -177,7 +167,7 @@ const documentVariable = async (link) => {
  * Gets the documentation for a single link
  *
  * @param {string} link - Link to get doc from
- * @returns {Promise<import("../src/types").DocumentationFunction>}
+ * @returns {Promise<import("../../src/types").DocumentationFunction>}
  */
 const documentFunction = async (link) => {
     const documentation = {
@@ -246,7 +236,7 @@ const documentFunction = async (link) => {
  * Gets the documentation for a single link
  *
  * @param {string} link - Link to get doc from
- * @returns {Promise<import("../src/types").DocumentationClass>}
+ * @returns {Promise<import("../../src/types").DocumentationClass>}
  */
 const documentClass = async (link) => {
     const documentation = {
@@ -328,7 +318,7 @@ const documentLinks = async ({classLinks, functionLinks, variableLinks}) => {
     /**
      * All documentation (final object dumped to JSON)
      *
-     * @type {import("../src/types").Documentation}
+     * @type {import("../../src/types").Documentation}
      */
     const documentation = {}
 
@@ -390,7 +380,10 @@ const documentLinks = async ({classLinks, functionLinks, variableLinks}) => {
     return documentation
 }
 
-;(async () => {
+/**
+ * @returns Documentation from https://processing.org/reference
+ */
+export const getDocs = async () => {
     const links = await getDocLinks()
 
     if (!links) {
@@ -405,11 +398,7 @@ const documentLinks = async ({classLinks, functionLinks, variableLinks}) => {
 
     const docs = await documentLinks(links)
 
-    await fs.writeFile(
-        `${__dirname}/../data/documentation-data.yml`,
-        `# THIS IS AN AUTOGENERATED FILE; DO NOT EDIT DIRECTLY\n\n${yaml.stringify(docs, {
-            sortMapEntries: true,
-        })}`,
-        "utf8",
-    )
-})()
+    return docs
+}
+
+export default getDocs

scripts/writeDocs.mjs

@@ -0,0 +1,24 @@
+#!/bin/node
+
+/**
+ * @file gets Documentation from https://processing.org/reference and dumps it into
+ *   `src/documentation-data.json` with some bootleg webscraping
+ */
+
+import {dirname} from "path"
+import {fileURLToPath} from "url"
+import {promises as fs} from "fs"
+import yaml from "yaml"
+import getDocs from "./helpers/fetchDocs.mjs"
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+const docs = await getDocs()
+
+await fs.writeFile(
+    `${__dirname}/../data/documentation-data.yml`,
+    `# THIS IS AN AUTOGENERATED FILE; DO NOT EDIT DIRECTLY\n\n${yaml.stringify(docs, {
+        sortMapEntries: true,
+    })}`,
+    "utf8",
+)