docs: added typedoc plugin to parse DML json files (#8300)

* docs-util: add docblock generator for models built with DML

* add missing turbo task

* docs-util: added typedoc plugin to parse dml json files
This commit is contained in:
Shahed Nasser
2024-07-29 14:19:04 +02:00
committed by GitHub
parent df734a3ce9
commit 7ad4e7b1c9
11 changed files with 124 additions and 29 deletions
@@ -34,6 +34,7 @@
},
"devDependencies": {
"@types/node": "^20.9.4",
"@types/pluralize": "^0.0.33"
"@types/pluralize": "^0.0.33",
"types": "*"
}
}
@@ -5,7 +5,7 @@ import { GeneratorEvent } from "../helpers/generator-event-manager.js"
import { minimatch } from "minimatch"
import getBasePath from "../../utils/get-base-path.js"
import toJsonFormatted from "../../utils/to-json-formatted.js"
import { DmlFile } from "../../types/index.js"
import { DmlFile } from "types"
/**
* A class used to generate DML JSON files with descriptions of properties.
@@ -5,7 +5,7 @@ import { getDmlOutputBasePath } from "../../utils/get-output-base-paths.js"
import path from "path"
import { camelToWords, RELATION_NAMES, snakeToPascal } from "utils"
import toJsonFormatted from "../../utils/to-json-formatted.js"
import { DmlFile, DmlObject } from "../../types/index.js"
import { DmlFile, DmlObject } from "types"
/**
* DML generator for data models created with DML.
@@ -2,7 +2,7 @@ import { readdirSync, existsSync, readFileSync, writeFileSync } from "fs"
import { getDmlOutputBasePath } from "../utils/get-output-base-paths.js"
import path from "path"
import getMonorepoRoot from "../utils/get-monorepo-root.js"
import { DmlFile } from "../types/index.js"
import { DmlFile } from "types"
import toJsonFormatted from "../utils/to-json-formatted.js"
export default async function () {