@amritk/mjst 0.23.0 → 0.24.0

package/README.md

@@ -321,6 +321,7 @@ npx mjst markdown ./config.schema.json --table --readme ./README.md
 | `--layout` | Default layout for nested properties: `headings` (default), `table`, or `none`. |
 | `--sort` | Property order: `schema` (default) or `alphabetical`. |
 | `--heading-level` | Heading level of the page title, 1-6 (default: `1`). |
+| `--type-label` | Whether every property heading gets its **Type:** line: `auto` (default) or `never`. Under `never` an enum lists its **Allowed values:** instead, since the label was the only other place they appeared. |
 | `--type-column` | When a property table renders its **Type** column: `auto` (default — only when a row fills it with something a reader could act on), `always`, or `never`. |
 | `--default-column` | When a property table renders its **Default** column: `auto` (default), `always`, or `never`. |
 | `--required-style` | How a property table says which properties are required: `marker` (default — `_required_` beside the name) or `column` (a **Required** column). |

package/dist/markdown/help-text.d.ts

@@ -3,4 +3,4 @@
  * HELP_TEXT: the flag list is small and stable, and the test cross-checks that
  * every flag is listed.
  */
-export declare const MARKDOWN_HELP_TEXT = "mjst markdown \u2014 generate markdown documentation from a JSON Schema\n\nUsage:\n  mjst markdown <schema> --out-dir <dir> [options]\n  mjst markdown <schema> --table --readme <file>\n\nTwo shapes come out of the same schema. By default it writes the prose\nreference \u2014 a heading, a type, the description and an example per property,\nacross as many pages as the schema's x-doc keyword declares. With --table it\nrenders one HTML table instead and splices it into an existing markdown file\nbetween <!-- config-table-start --> and <!-- config-table-end -->, leaving the\nrest of that file alone.\n\nProse reference options:\n  --out-dir <dir>      Directory the pages are written to (default: the current directory)\n  --file <path>        Output path of the index page (default: the schema's x-doc.file, then index.md)\n  --title <text>       Page title (default: the schema's title)\n  --language <lang>    Fence language for derived examples and literals (default: json)\n  --layout <mode>      Default layout for nested properties: headings (default), table, or none\n  --sort <order>       Property order: schema (default) or alphabetical\n  --heading-level <n>  Heading level of the page title, 1-6 (default: 1)\n\nProperty table options (the root x-doc.table, for every table on every page):\n  --type-column <when>     Render the Type column: auto (default), always, or never\n  --default-column <when>  Render the Default column: auto (default), always, or never\n  --required-style <how>   Say which properties are required: marker (default, beside\n                           the name) or column (a Required column)\n  --required-first         List the required properties at the top of every table\n\nTable options:\n  --table              Render the HTML config table instead of the prose pages\n  --readme <path>      Markdown file the table is spliced into (default: README.md)\n\nMisc:\n  --help, -h           Print this help\n\nDocs: https://github.com/amritk/mjst/tree/main/packages/cli#readme\n";
+export declare const MARKDOWN_HELP_TEXT = "mjst markdown \u2014 generate markdown documentation from a JSON Schema\n\nUsage:\n  mjst markdown <schema> --out-dir <dir> [options]\n  mjst markdown <schema> --table --readme <file>\n\nTwo shapes come out of the same schema. By default it writes the prose\nreference \u2014 a heading, a type, the description and an example per property,\nacross as many pages as the schema's x-doc keyword declares. With --table it\nrenders one HTML table instead and splices it into an existing markdown file\nbetween <!-- config-table-start --> and <!-- config-table-end -->, leaving the\nrest of that file alone.\n\nProse reference options:\n  --out-dir <dir>      Directory the pages are written to (default: the current directory)\n  --file <path>        Output path of the index page (default: the schema's x-doc.file, then index.md)\n  --title <text>       Page title (default: the schema's title)\n  --language <lang>    Fence language for derived examples and literals (default: json)\n  --layout <mode>      Default layout for nested properties: headings (default), table, or none\n  --sort <order>       Property order: schema (default) or alphabetical\n  --heading-level <n>  Heading level of the page title, 1-6 (default: 1)\n  --type-label <when>  Give every property heading its Type: line: auto (default) or\n                       never (an enum then lists its allowed values instead)\n\nProperty table options (the root x-doc.table, for every table on every page):\n  --type-column <when>     Render the Type column: auto (default), always, or never\n  --default-column <when>  Render the Default column: auto (default), always, or never\n  --required-style <how>   Say which properties are required: marker (default, beside\n                           the name) or column (a Required column)\n  --required-first         List the required properties at the top of every table\n\nTable options:\n  --table              Render the HTML config table instead of the prose pages\n  --readme <path>      Markdown file the table is spliced into (default: README.md)\n\nMisc:\n  --help, -h           Print this help\n\nDocs: https://github.com/amritk/mjst/tree/main/packages/cli#readme\n";

package/dist/markdown/help-text.js

@@ -19,6 +19,8 @@ Prose reference options:
   --layout <mode>      Default layout for nested properties: headings (default), table, or none
   --sort <order>       Property order: schema (default) or alphabetical
   --heading-level <n>  Heading level of the page title, 1-6 (default: 1)
+  --type-label <when>  Give every property heading its Type: line: auto (default) or
+                       never (an enum then lists its allowed values instead)
 
 Property table options (the root x-doc.table, for every table on every page):
   --type-column <when>     Render the Type column: auto (default), always, or never

package/dist/markdown/parse-markdown-args.d.ts

@@ -1,4 +1,4 @@
-import type { DocLayout, DocSort, DocTableColumn, DocTableRequired } from '@amritk/generate-markdown';
+import type { DocHeadingType, DocLayout, DocSort, DocTableColumn, DocTableRequired } from '@amritk/generate-markdown';
 /** The flags and positional the `markdown` subcommand understands. */
 export type MarkdownArgs = {
     /** Path to the JSON Schema to document (the sole positional). */
@@ -17,6 +17,8 @@ export type MarkdownArgs = {
     sort?: DocSort;
     /** Heading level of the page title (`--heading-level`). */
     headingLevel?: number;
+    /** Whether a property heading gets its **Type:** line (`--type-label`). */
+    typeLabel?: DocHeadingType;
     /** When property tables render their Type column (`--type-column`). */
     typeColumn?: DocTableColumn;
     /** When property tables render their Default column (`--default-column`). */

package/dist/markdown/parse-markdown-args.js

@@ -6,6 +6,7 @@ const VALUE_KEYS = /* @__PURE__ */ new Set([
   "layout",
   "sort",
   "headingLevel",
+  "typeLabel",
   "typeColumn",
   "defaultColumn",
   "requiredStyle",
@@ -14,6 +15,7 @@ const VALUE_KEYS = /* @__PURE__ */ new Set([
 const BOOLEAN_KEYS = /* @__PURE__ */ new Set(["table", "requiredFirst"]);
 const LAYOUTS = ["headings", "table", "none"];
 const SORTS = ["schema", "alphabetical"];
+const HEADING_TYPES = ["auto", "never"];
 const TABLE_COLUMNS = ["auto", "always", "never"];
 const REQUIRED_STYLES = ["marker", "column"];
 const toCamelCase = (key) => key.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
@@ -54,6 +56,9 @@ const assignValue = (args, key, value) => {
     case "headingLevel":
       args.headingLevel = parseHeadingLevel(value);
       return;
+    case "typeLabel":
+      args.typeLabel = parseChoice("type-label", value, HEADING_TYPES);
+      return;
     case "typeColumn":
       args.typeColumn = parseChoice("type-column", value, TABLE_COLUMNS);
       return;

package/dist/markdown/run.js

@@ -14,6 +14,7 @@ const PAGE_FLAGS = [
   "layout",
   "sort",
   "headingLevel",
+  "typeLabel",
   "typeColumn",
   "defaultColumn",
   "requiredStyle",
@@ -71,7 +72,8 @@ const run = async (argv) => {
       default: args.defaultColumn,
       required: args.requiredStyle,
       requiredFirst: args.requiredFirst
-    }
+    },
+    headings: { type: args.typeLabel }
   };
   let files;
   try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amritk/mjst",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Generate TypeScript parsers and type definitions from JSON Schemas.",
   "type": "module",
   "engines": {
@@ -53,7 +53,7 @@
     "@amritk/api": "^0.16.5",
     "@amritk/asyncapi": "^0.3.3",
     "@amritk/generate-examples": "^0.8.7",
-    "@amritk/generate-markdown": "^0.9.0",
+    "@amritk/generate-markdown": "^0.10.0",
     "@amritk/helpers": "^0.23.1",
     "@amritk/lint": "^0.6.1",
     "@amritk/validation": "^0.3.0",