doc-detective-common 1.2.6 → 1.2.8

package/.devcontainer/devcontainer.json

@@ -1,25 +1,37 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
 {
-	"name": "Ubuntu",
-	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/base:jammy",
-	"features": {
-		"ghcr.io/devcontainers/features/node:1": {}
-	}
+  "name": "Ubuntu",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/base:jammy",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {}
+  },
 
-	// Features to add to the dev container. More info: https://containers.dev/features.
-	// "features": {},
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
 
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
 
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "uname -a",
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "npm i",
 
-	// Configure tool-specific properties.
-	// "customizations": {},
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "github.copilot",
+        "aaron-bond.better-comments",
+        "esbenp.prettier-vscode",
+        "GitHub.vscode-pull-request-github",
+        "streetsidesoftware.code-spell-checker"
+      ]
+    }
+  }
 
-	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-	// "remoteUser": "root"
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
 }

package/dev/dev.js

@@ -0,0 +1,3 @@
+const { validate, schemas } = require("../src/index");
+
+console.log(validate("find_v2",schemas.find_v2.examples[0]))

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "doc-detective-common",
-  "version": "1.2.6",
-
+  "version": "1.2.8",
   "description": "Shared components for Doc Detective projects.",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
-    "test": "jest"
+    "dereferenceSchemas": "node ./src/schemas/dereferenceSchemas.js",
+    "test": "npm run dereferenceSchemas && jest"
   },
   "precommit": "test",
   "repository": {

package/src/index.js

@@ -0,0 +1,5 @@
+const { schemas } = require("./schemas");
+const { validate } = require("./validate");
+
+exports.schemas = schemas;
+exports.validate = validate;

package/src/schemas/dereferenceSchemas.js

@@ -0,0 +1,46 @@
+const parser = require("@apidevtools/json-schema-ref-parser");
+const path = require("path");
+const fs = require("fs");
+const { exit } = require("process");
+
+(async () => {
+  await dereferenceSchemas();
+})();
+
+/*
+ * Walks through all schema in src/src_schema
+ * For each schema, dereferences it and writes it to src/schema
+ */
+async function dereferenceSchemas() {
+  const inputDir = path.resolve(`${__dirname}/src_schemas`);
+  const outputDir = path.resolve(`${__dirname}/output_schemas`);
+  const files = fs.readdirSync(inputDir);
+  for await (const file of files) {
+    const filePath = path.resolve(`${inputDir}/${file}`);
+    // Load from file
+    let schema = fs.readFileSync(filePath).toString();
+    // Convert to JSON
+    schema = JSON.parse(schema);
+    // Set ID
+    schema.$id = `${filePath}`;
+    // Update references to current relative path
+    schema = updateRefPaths(schema, inputDir);
+    // Dereference schema
+    schema = await parser.dereference(schema);
+    // Write to file
+    fs.writeFileSync(`${outputDir}/${file}`, JSON.stringify(schema, null, 2));
+  }
+}
+
+// Prepend app-root path to referenced relative paths
+function updateRefPaths(schema) {
+  for (let [key, value] of Object.entries(schema)) {
+    if (typeof value === "object") {
+      updateRefPaths(value);
+    }
+    if (key === "$ref") {
+      schema[key] = path.resolve(`${__dirname}/src_schemas/${value}`);
+    }
+  }
+  return schema;
+}

package/src/schemas/index.js

@@ -0,0 +1,22 @@
+const fs = require("fs");
+
+exports.schemas = loadSchemas();
+
+// Load schemas from file
+function loadSchemas() {
+  const schemas = {};
+  // Read files from schema directory
+  path = `${__dirname}/output_schemas`;
+  var files = fs.readdirSync(path);
+  // Loop through all schema files
+  files.forEach(async (file) => {
+    // Exit early for files that don't match naming pattern
+    if (!file.includes(".schema.json")) return;
+    const key = file.replace(".schema.json", "");
+    // Load schema from file
+    let schema = require(`./output_schemas/${file}`);
+    // Load into `schema` object
+    schemas[key] = schema;
+  });
+  return schemas;
+}