@portll/cobolwork 0.5.0 → 0.7.0

package/schema/cobolwork-inventory.schema.json

@@ -0,0 +1,206 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-inventory.schema.json",
+ "title": "cobolwork inventory",
+ "description": "What cobolwork inventory found in a tree: its sources, their formats, and the copybooks they resolve or miss. A later minor release may add keys; a reader ignores keys it does not know.",
+ "type": "object",
+ "required": [
+  "tool",
+  "schemaVersion",
+  "summary"
+ ],
+ "properties": {
+  "tool": {
+   "const": "cobolwork-inventory"
+  },
+  "schemaVersion": {
+   "const": 3
+  },
+  "missingCopybooks": {
+   "type": "object",
+   "description": "Each copybook no tree or library holds, with how many COPY statements name it.",
+   "additionalProperties": {
+    "type": "integer",
+    "minimum": 0
+   }
+  },
+  "refusedCopies": {
+   "type": "array"
+  },
+  "unreadable": {
+   "type": "array"
+  },
+  "ebcdic": {
+   "type": "array"
+  },
+  "recursiveCopybooks": {
+   "type": "object",
+   "description": "Each copybook that copies itself, directly or through others."
+  },
+  "summary": {
+   "type": "object",
+   "required": [
+    "toolVersion",
+    "filesScanned",
+    "coverageIncomplete"
+   ],
+   "properties": {
+    "toolVersion": {
+     "type": "string"
+    },
+    "filesScanned": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "programs": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "programFiles": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copybookFiles": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "jclFiles": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copiesResolved": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copiesMissing": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copiesSystem": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copiesRefused": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copiesRecursive": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "filesUnreadable": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "filesEbcdic": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "notPrograms": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "dirsUnreadable": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "symlinks": {
+     "type": "object",
+     "properties": {
+      "followed": {
+       "type": "integer",
+       "minimum": 0
+      },
+      "outside": {
+       "type": "integer",
+       "minimum": 0
+      },
+      "broken": {
+       "type": "integer",
+       "minimum": 0
+      }
+     }
+    },
+    "withEmbeddedSql": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "withCics": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "withDli": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "formats": {
+     "type": "object",
+     "additionalProperties": {
+      "type": "integer",
+      "minimum": 0
+     }
+    },
+    "nosrc": {
+     "type": "boolean"
+    },
+    "coverageIncomplete": {
+     "type": "boolean"
+    },
+    "toolRevision": {
+     "type": [
+      "object",
+      "null"
+     ],
+     "description": "A commit and whether its tree held changes, with where it was read.",
+     "properties": {
+      "commit": {
+       "type": [
+        "string",
+        "null"
+       ]
+      },
+      "dirty": {
+       "type": [
+        "boolean",
+        "null"
+       ]
+      },
+      "tag": {
+       "type": "string"
+      },
+      "from": {
+       "type": "string"
+      }
+     }
+    },
+    "revision": {
+     "type": [
+      "object",
+      "null"
+     ],
+     "description": "A commit and whether its tree held changes, with where it was read.",
+     "properties": {
+      "commit": {
+       "type": [
+        "string",
+        "null"
+       ]
+      },
+      "dirty": {
+       "type": [
+        "boolean",
+        "null"
+       ]
+      },
+      "tag": {
+       "type": "string"
+      },
+      "from": {
+       "type": "string"
+      }
+     }
+    }
+   }
+  }
+ }
+}

package/schema/cobolwork-parse.schema.json

@@ -0,0 +1,105 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-parse.schema.json",
+ "title": "cobolwork parse",
+ "description": "What cobolwork parse read in one source file. A later minor release may add keys; a reader ignores keys it does not know.",
+ "type": "object",
+ "required": [
+  "tool",
+  "schemaVersion",
+  "file",
+  "format",
+  "finalFormat",
+  "programs",
+  "copies",
+  "diagnostics"
+ ],
+ "properties": {
+  "tool": {
+   "const": "cobolwork-parse"
+  },
+  "schemaVersion": {
+   "const": 1
+  },
+  "file": {
+   "type": "string"
+  },
+  "format": {
+   "type": "string",
+   "description": "The source format detected at the first line: fixed, free or terminal."
+  },
+  "finalFormat": {
+   "type": "string",
+   "description": "The format in force at the end, after any >>SOURCE directive."
+  },
+  "programs": {
+   "type": "array",
+   "items": {
+    "type": "object",
+    "required": [
+     "id",
+     "items",
+     "labels",
+     "calls",
+     "execs",
+     "diagnostics"
+    ],
+    "properties": {
+     "id": {
+      "type": [
+       "string",
+       "null"
+      ]
+     },
+     "items": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Data items declared."
+     },
+     "labels": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Sections and paragraphs."
+     },
+     "calls": {
+      "type": "integer",
+      "minimum": 0
+     },
+     "execs": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "EXEC blocks."
+     },
+     "diagnostics": {
+      "type": "integer",
+      "minimum": 0
+     }
+    }
+   }
+  },
+  "copies": {
+   "type": "array",
+   "items": {
+    "type": "object",
+    "required": [
+     "name",
+     "status"
+    ],
+    "properties": {
+     "name": {
+      "type": "string"
+     },
+     "status": {
+      "type": "string",
+      "description": "How the COPY was resolved, or why it was not."
+     }
+    }
+   }
+  },
+  "diagnostics": {
+   "type": "integer",
+   "minimum": 0,
+   "description": "Diagnostics in the file as a whole."
+  }
+ }
+}

package/schema/cobolwork-reach.schema.json

@@ -0,0 +1,74 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-reach.schema.json",
+ "title": "cobolwork reachability extract",
+ "description": "Who may start each transaction and job, and which run with elevated authority, reduced from a RACF unload and the SIT and brought as COBOLWORK_REACH. docs/spec/reach.md. lib/reach.mjs reads it; a key it does not read is reported under summary.feedWarnings, and a key opening with an underscore is a note for people.",
+ "type": "object",
+ "required": [
+  "extract",
+  "retrieved"
+ ],
+ "additionalProperties": false,
+ "patternProperties": {
+  "^_": {}
+ },
+ "properties": {
+  "$schema": {
+   "type": "string"
+  },
+  "version": {
+   "description": "The extract version. An extract without one is read as version 0, which holds the same keys as version 1.",
+   "type": "integer",
+   "minimum": 0,
+   "maximum": 1
+  },
+  "extract": {
+   "type": "string",
+   "minLength": 1,
+   "description": "Which extract this is."
+  },
+  "retrieved": {
+   "type": "string",
+   "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+   "description": "When the extract was taken."
+  },
+  "transactions": {
+   "$ref": "#/$defs/access",
+   "description": "Each transaction's access, by name."
+  },
+  "jobs": {
+   "$ref": "#/$defs/access",
+   "description": "Each job's access, by name."
+  },
+  "privileged": {
+   "type": "object",
+   "description": "The transactions and jobs that run with elevated authority.",
+   "additionalProperties": false,
+   "properties": {
+    "transactions": {
+     "$ref": "#/$defs/names"
+    },
+    "jobs": {
+     "$ref": "#/$defs/names"
+    }
+   }
+  }
+ },
+ "$defs": {
+  "access": {
+   "type": "object",
+   "additionalProperties": {
+    "enum": [
+     "open",
+     "restricted"
+    ]
+   }
+  },
+  "names": {
+   "type": "array",
+   "items": {
+    "type": "string"
+   }
+  }
+ }
+}