Add script

Author: davepagurek

.gitignore

@@ -23,4 +23,7 @@ pnpm-debug.log*
 temp/*
 in/
 out/
-translator/
+translator/
+
+# Don't commit custom dev builds
+public/p5.min.js

package.json

@@ -15,7 +15,8 @@
     "build:contributors": "tsx ./src/scripts/builders/people.ts",
     "build:reference": "tsx ./src/scripts/builders/reference.ts",
     "build:search": "tsx ./src/scripts/builders/search.ts",
-    "build:p5-version": "tsx ./src/scripts/p5-version.ts"
+    "build:p5-version": "tsx ./src/scripts/p5-version.ts",
+    "custom:dev": "tsx ./src/scripts/branchTest.ts"
   },
   "dependencies": {
     "@astrojs/check": "^0.5.5",

src/content/reference/config.ts

@@ -26,8 +26,8 @@ export const categories = [
 const paramSchema = z.object({
   name: z.string(),
   description: z.string(),
-  type: z.string(),
-  optional: z.boolean().optional(),
+  type: z.string().optional(),
+  optional: z.coerce.boolean().optional(),
 });
 
 const returnSchema = z.object({
@@ -41,15 +41,15 @@ const exampleSchema = z.string();
  * Method schema for methods associated with a class in the Reference collection.
  */
 const methodSchema = z.object({
-  description: z.string(),
+  description: z.string().optional(),
   path: z.string(),
 });
 
 /**
  * Property schema for properties associated with a class in the Reference collection.
  */
 const propertySchema = z.object({
-  description: z.string(),
+  description: z.string().optional(),
   path: z.string(),
 });
 
@@ -78,6 +78,7 @@ export const referenceSchema = z.object({
   properties: z.record(propertySchema).optional(),
   isConstructor: z
     .boolean()
+    .or(z.number().transform((n: number) => !!n))
     .or(z.literal("true").transform(() => true))
     .or(z.literal("false").transform(() => false))
     .optional(),

src/scripts/branchTest.ts

@@ -0,0 +1,27 @@
+import { execSync } from "child_process"
+import { existsSync, rmSync } from "fs"
+import path from "path"
+
+const url = process.argv[2]
+const match = /^(.+)#(.+)$/.exec(url)
+if (!match) {
+  console.error(`Please pass a git URL followed by a # and then a branch name, tag, or commit as the parameter to this script, e.g. https://github.com/processing/p5.js.git#main`)
+  process.exit(1)
+}
+
+const repoUrl = match[1]
+const branch = match[2]
+
+const env = `P5_LIBRARY_PATH='/p5.min.js' P5_REPO_URL='${repoUrl}' P5_BRANCH='${branch}'`
+
+// First delete the existing cloned p5 to make sure we clone fresh
+const parsedP5Path = path.join(__dirname, './parsers/in/p5.js/')
+if (existsSync(parsedP5Path)) {
+  rmSync(parsedP5Path, { recursive: true })
+}
+
+// Build the reference using the specified environment
+execSync(`${env} npm run build:reference`)
+
+// Run a dev server
+execSync(`${env} npm run dev`)

src/scripts/parsers/reference.ts

@@ -1,9 +1,10 @@
-import { cloneLibraryRepo, readFile } from "../utils";
+import { cloneLibraryRepo, p5RepoUrl, readFile } from "../utils";
 import fs from "fs/promises";
 import { exec, execSync } from "child_process";
 import path from "path";
 import { fileURLToPath } from "url";
 import type { ParsedLibraryReference } from "../../../types/parsers.interface";
+import { p5Version } from "@/src/globals/p5-version";
 
 // Derive the directory name (__dirname equivalent) in ES Module scope
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -18,16 +19,18 @@ const yuidocOutputPath = path.join(__dirname, "out")
 export const parseLibraryReference =
   async (): Promise<ParsedLibraryReference | null> => {
     // Clone p5.js
-    await cloneLibraryRepo(localPath, 'https://github.com/Garima3110/p5.js.git', 'shaders', { shouldFixAbsolutePathInPreprocessor: false });
-    // TODO(dave): let this happen via `npm run docs` in the p5 repo once we
-    // merge the 2.0 branch
+    await cloneLibraryRepo(localPath, process.env.P5_REPO_URL || p5RepoUrl, process.env.P5_BRANCH || p5Version, { shouldFixAbsolutePathInPreprocessor: false });
+
+    // Install dependencies and build docs in the p5 repo
     await createP5Docs('p5.js', 'data-p5')
-    // If dev
-    await createP5Build('p5.js')
-    /*await saveYuidocOutput('p5.js', 'data-p5', {
-      flags: `--config ${path.join(__dirname, '../../../yuidoc.json')}`,
-      inputPath: './src',
-    });*/
+
+    // If we're using a custom build of p5 instead of a public release, create
+    // a build and copy it to the specified path
+    if (process.env.P5_LIBRARY_PATH) {
+      await createP5Build('p5.js', '../../../public' + process.env.P5_LIBRARY_PATH)
+    }
+
+    // Copy the reference output so we can process it
     const p5Data = await getYuidocOutput('data-p5');
     if (!p5Data) throw new Error('Error generating p5 reference data!');
 
@@ -146,13 +149,13 @@ export const createP5Docs = async (inDirName: string, outDirName: string) => {
   )
 }
 
-export const createP5Build = async (inDirName: string) => {
+export const createP5Build = async (inDirName: string, outPath: string) => {
   execSync('npm run build', {
     cwd: path.join(__dirname, 'in', inDirName)
   })
   await fs.cp(
     path.join(__dirname, 'in', inDirName, 'lib', 'p5.min.js'),
-    path.join(__dirname, '../../../public', 'p5.min.js'),
+    path.join(__dirname, outPath),
   )
 }