@01-edu/shared 1.0.5 → 1.0.6

package/bin/check-definitions.js

@@ -1,31 +1,63 @@
 #!/usr/bin/env node
 
-import { readFile, stat } from 'node:fs/promises'
+import { readFile, stat, watch } from 'node:fs/promises'
 
 import { checkAndBuildDefinitions } from '../definitions-checker.js'
 
-const auditValidation = validation => validation.type.endsWith('_audit')
-try {
-  const result = await checkAndBuildDefinitions(async key => {
-    const referencePath = `content${key ? `/${key}` : ''}/def.json`
-    const def = JSON.parse(await readFile(referencePath, 'utf8'))
-    def.attrs || (def.attrs = {})
-    def.referencePath = referencePath
-    switch (def.type) {
-      case 'project':
-      // biome-ignore lint/suspicious/noFallthroughSwitchClause: We want to fallthrough
-      case 'raid': {
-        await stat(`content/${key}/audit/README.md`)
+const isAudit = validation => validation.type.endsWith('_audit')
+const readDef = async key => {
+  const path = key == null ? 'content/def.json' : `content/${key}/def.json`
+  const def = JSON.parse(await readFile(path, 'utf8'))
+  def.attrs || (def.attrs = {})
+  def.referencePath = path
+
+  switch (def.type) {
+    case 'project':
+    // biome-ignore lint/suspicious/noFallthroughSwitchClause: We want to fallthrough
+    case 'raid': {
+      const audit = (def.attrs.validations || []).find(isAudit)
+      if (!audit) {
+        throw Error('project and raid must have an audit validation specified')
+      }
+      if (audit.form) {
+        throw Error(
+          'audit form attribute is automatically set to be ./audit/README.md, do not specify it',
+        )
       }
-      case 'exercise': {
-        await stat(`content/${key}/README.md`)
+      audit.form = `content/${key}/audit/README.md`
+      await stat(audit.form)
+    }
+    case 'exercise': {
+      if (def.attrs.subject) {
+        throw Error(
+          'subject attribute is automatically set to be ./README.md, do not specify it',
+        )
       }
+      def.attrs.subject = `content/${key}/README.md`
+      await stat(def.attrs.subject)
     }
+  }
+
+  return def
+}
+
+const runChecks = async () => {
+  try {
+    return await checkAndBuildDefinitions(readDef)
+  } catch ({ message, stack, ...props }) {
+    console.error(message)
+    console.error(props)
+  }
+}
 
-    return def
-  })
-} catch ({ message, ...props }) {
-  console.error(message, props)
+if (process.argv.includes('--watch') || process.argv.includes('-w')) {
+  await runChecks()
+  for await (const event of watch('.', { recursive: true })) {
+    console.clear()
+    console.log(event.eventType, 'on', event.filename, '\n')
+    await runChecks()
+  }
+} else if (!(await runChecks())) {
   process.exit(1)
 }
 

package/definitions-checker.js

@@ -31,7 +31,7 @@ const assertDef = def => {
   if (refId && typeof refId !== 'number') throw Error(`Invalid refId property`)
   if (childrenAttrs) throw Error(`childrenAttrs is no longer supported`)
 
-  for (const [key, value] of Object.entries(attrs)) {
+  for (const key of Object.keys(attrs)) {
     if (relationAttributes[key]) {
       throw Error(
         `Attr ${key} should be defined in the relation with its parent, not on the object itself.`,
@@ -89,7 +89,7 @@ const assertRelation = (parent, key, relation) => {
     throw Error(`Self reference in child ${key}`)
   }
 
-  for (const [key, value] of Object.entries(relation)) {
+  for (const key of Object.keys(relation)) {
     if (key === 'ref') continue
     const matches = attributes[key]
     if (matches?.[type]?.restrictive) {
@@ -138,29 +138,6 @@ const checkAttrs = object => {
   }
 }
 
-// TODO: replace by Set.intersection once available in node
-const intersection = (a, b) => {
-  const result = new Set()
-  for (const element of a) {
-    b.has(element) && result.add(element)
-  }
-  return result
-}
-
-const generatePairs = arr => {
-  const result = []
-  let i = -1
-  // Only go up to the second to last element
-  while (++i < arr.length - 1) {
-    let j = i
-    // Start from the next element to avoid duplicates
-    while (++j < arr.length) {
-      result.push([arr[i], arr[j]])
-    }
-  }
-  return result
-}
-
 const isExam = def => def.type === 'exam'
 const assertExams = definitions => {
   const groups = {}
@@ -197,7 +174,13 @@ const assertExams = definitions => {
 export const checkAndBuildDefinitions = async readDef => {
   const cache = {}
   const getDefs = async ([key, relation]) => {
-    const def = cache[key] || (cache[key] = await readDef(key))
+    let def
+    try {
+      def = cache[key] || (cache[key] = await readDef(key))
+    } catch (err) {
+      err.name = key
+      throw err
+    }
     try {
       assertDef(def)
     } catch (err) {
@@ -207,7 +190,12 @@ export const checkAndBuildDefinitions = async readDef => {
     }
     relation && (relation.ref = def)
     const relations = Object.entries(def.children || {}).map(getDefs)
-    return [def, ...(await Promise.all(relations)).flat()]
+    try {
+      return [def, ...(await Promise.all(relations)).flat()]
+    } catch (err) {
+      key && (err.parents || (err.parents = [])).push(key)
+      throw err
+    }
   }
 
   const definitions = await getDefs([])
@@ -215,7 +203,6 @@ export const checkAndBuildDefinitions = async readDef => {
   // Assert all relations looks ok, possible child / parent, allowed attributes
   for (const def of definitions) {
     if (!def.children) continue
-    const allowedTypes = childTypes[def.type]
     try {
       for (const entry of Object.entries(def.children)) {
         assertRelation(def, entry[0], entry[1])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@01-edu/shared",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "type": "module",
   "description": "",
   "scripts": {