Files
medusa-store/docs-util/packages/react-docs-generator/src/index.ts
Shahed Nasser 245e5c9a69 docs: generate documentation for UI components (#5849)
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
2023-12-13 16:02:41 +02:00

39 lines
1.0 KiB
JavaScript

#!/usr/bin/env node
import { program } from "commander"
import generate from "./commands/generate.js"
import path from "path"
import { fileURLToPath } from "url"
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
program
.description("Generate React specs used for documentation purposes.")
.requiredOption(
"-s, --src <srcPath>",
"Path to a file containing a React component or a directory of React components."
)
.requiredOption("-o, --output <outputPath>", "Path to the output directory.")
.option(
"--clean",
"Clean the output directory before creating the new specs",
false
)
.option(
"--tsconfigPath <tsconfigPath>",
"Path to TSConfig file.",
path.join(
__dirname,
"..",
"..",
"typedoc-config",
"extended-tsconfig",
"ui.json"
)
)
.option("--disable-typedoc", "Whether to disable Typedoc", false)
.option("--verbose-typedoc", "Whether to show Typedoc logs.", false)
.parse()
void generate(program.opts())