schema-markdown 1.2.11 → 1.2.13

package/README.md

@@ -78,22 +78,58 @@ try {
 ~~~
 
 
-## Document a Schema
-
-To document the schema, download the
-[documentation application](https://github.com/craigahobbs/schema-markdown-doc#the-schema-markdown-documentation-viewer)
-stub and save the type model as JSON:
-
-~~~
-curl -O https://craigahobbs.github.io/schema-markdown-doc/extra/index.html
-node --input-type=module \
-    -e 'import {modelTypes} from "model.js"; console.log(JSON.stringify(modelTypes))' \
-    > model.json
+## Schema Documentation
+
+You can document a schema with BareScript's
+[schemaDoc application](https://craigahobbs.github.io/bare-script/library/#var.vGroup='schemaDoc.bare')
+running on the
+[MarkdownUp application](https://craigahobbs.github.io/markdown-up/).
+
+If your
+[type model JSON file](https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types')
+or
+[Schema Markdown file](https://craigahobbs.github.io/schema-markdown-js/language/)
+is publicly visible, you can use the BareScript model application with the `var.vURL` query argument:
+
+<https://craigahobbs.github.io/bare-script/model/#var.vURL='https://craigahobbs.github.io/bare-script/library/model.json'>
+
+**Note:** Schema Markdown files use the `.smd` file extension.
+
+
+### Self-Hosting Schema Documentation
+
+You can host the schemaDoc application yourself by adding a schemaDoc HTML stub:
+
+``` html
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>MarkdownUp</title>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <link rel="stylesheet" href="https://craigahobbs.github.io/markdown-up/app.css">
+        <link rel="preload" href="https://craigahobbs.github.io/markdown-up/bare-script/static/markdown.css" as="style">
+        <link rel="modulepreload" href="https://craigahobbs.github.io/markdown-up/lib/appImports.js" as="script">
+    </head>
+    <script type="module">
+        import {MarkdownUp} from 'https://craigahobbs.github.io/markdown-up/lib/appImports.js';
+        const app = new MarkdownUp(window, {
+            'markdownText': `\
+~~~markdown-script
+include <schemaDoc.bare>
+
+schemaDocMain('model.json', 'My Model')
 ~~~
+`
+        });
+        app.run();
+    </script>
+</html>
+```
 
-To host locally, start a local static web server:
+To view locally, start a local static web server:
 
-~~~
+~~~ sh
 python3 -m http.server
 ~~~
 

package/lib/parser.js

@@ -56,10 +56,11 @@ const rLineSplit = /\r?\n/;
  *
  * @param {string|string[]} text - The Schema Markdown text
  * @param {Object} [options = {}] - The options object
- * @param {Object} [options.types={}] - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @param {Object} [options.types={}] - The
+ *     [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
  * @param {string} [options.filename=''] - The name of file being parsed (for error messages)
  * @param {boolean} [options.validate=true] - If true, validate after parsing
- * @returns {Object} The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @returns {Object} The [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
  * @throws [SchemaMarkdownParserError]{@link module:lib/parser.SchemaMarkdownParserError}
  */
 export function parseSchemaMarkdown(text, {types = {}, filename = '', validate = true} = {}) {

package/lib/schema.js

@@ -10,10 +10,10 @@ import {validateTypeModelErrors} from './schemaUtil.js';
 /**
  * Get a user type's referenced type model
  *
- * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
  * @param {string} typeName - The type name
  * @param {Object} [referencedTypes=null] - Optional map of referenced user type name to user type model
- * @returns {Object} The referenced [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @returns {Object} The referenced [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
  */
 export function getReferencedTypes(types, typeName, referencedTypes = {}) {
     return getReferencedTypesHelper(types, {'user': typeName}, referencedTypes);
@@ -120,7 +120,7 @@ export class ValidationError extends Error {
  * Type-validate a value using a user type model. Container values are duplicated since some member types are
  * transformed during validation.
  *
- * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
  * @param {string} typeName - The type name
  * @param {Object} value - The value object to validate
  * @param {?string} [memberFqn=null] - The fully-qualified member name
@@ -455,10 +455,10 @@ function validateAttr(type, attr, value, memberFqn) {
 /**
  * Get the struct's members (inherited members first)
  *
- * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
- * @param {Object} struct - The [struct model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Struct'}
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
+ * @param {Object} struct - The [struct model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Struct'}
  * @returns {Array<Object>} The array of
- *     [struct member models]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='StructMember'}
+ *     [struct member models]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='StructMember'}
  */
 export function getStructMembers(types, struct) {
     // No base structs?
@@ -488,10 +488,10 @@ export function getStructMembers(types, struct) {
 /**
  * Get the enum's values (inherited values first)
  *
- * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
- * @param {Object} enum_ - The [enum model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Enum'}
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
+ * @param {Object} enum_ - The [enum model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Enum'}
  * @returns {Array<Object>} The array of
- *     [enum value models]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='EnumValue'}
+ *     [enum value models]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='EnumValue'}
  */
 export function getEnumValues(types, enum_) {
     // No base enums?
@@ -521,8 +521,8 @@ export function getEnumValues(types, enum_) {
 /**
  * Validate a type model's types object
  *
- * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
- * @returns {Object} The validated [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
+ * @returns {Object} The validated [type model]{@link https://craigahobbs.github.io/bare-script/model/#var.vURL=''&var.vName='Types'}
  * @throws [ValidationError]{@link module:lib/schema.ValidationError}
  */
 export function validateTypeModel(types) {

package/package.json

@@ -1,7 +1,7 @@
 {
     "type": "module",
     "name": "schema-markdown",
-    "version": "1.2.11",
+    "version": "1.2.13",
     "description": "A schema definition and validation library",
     "keywords": [
         "schema",
@@ -24,8 +24,10 @@
         "test": "node --test test/"
     },
     "devDependencies": {
-        "c8": "~10.1",
-        "eslint": "~9.14",
+        "@eslint/js": "~10.0",
+        "c8": "~11.0",
+        "eslint": "~10.1",
+        "globals": "~17.4",
         "jsdoc": "~4.0"
     }
 }