@hanzo/docs-docgen 3.0.5 → 3.1.0

package/README.md

@@ -1,3 +1,3 @@
-# Fumadocs Doc Gen
+# Hanzo Docs Doc Gen
 
 Remark plugins & Docs Generator utilities.

package/dist/index.d.ts

@@ -67,7 +67,7 @@ type RemarkInstallOptions = {
   Tabs?: string;
   Tab?: string;
   /**
-   * Persist Tab value (Fumadocs UI only)
+   * Persist Tab value (Hanzo Docs UI only)
    *
    * @defaultValue false
    */

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["queue: Promise<void>[]","element: Record<string, unknown>","tasks: Promise<void>[]"],"sources":["../src/remark-docgen.ts","../src/utils.ts","../src/file-generator.ts","../src/remark-install.ts","../src/remark-show.ts"],"sourcesContent":["import { type BlockContent, type Code, type Root } from 'mdast';\nimport { type Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport type { VFile } from 'vfile';\n\ntype Awaitable<T> = T | Promise<T>;\n\nexport interface DocGenerator {\n  name: string;\n\n  /**\n   * Transform codeblocks to another mdast element\n   */\n  run: (input: unknown, context: Context) => Awaitable<object | object[] | undefined>;\n\n  onFile?: (tree: Root, file: VFile) => void;\n}\n\ninterface Context {\n  node: Code;\n  path: string;\n  cwd: string;\n}\n\nexport interface RemarkDocGenOptions {\n  generators?: DocGenerator[];\n}\n\nconst metaRegex = /doc-gen:(?<name>.+)/;\n\nexport function remarkDocGen({ generators = [] }: RemarkDocGenOptions): Transformer<Root, Root> {\n  return async (tree, file) => {\n    generators.forEach((gen) => gen.onFile?.(tree, file));\n    const queue: Promise<void>[] = [];\n\n    visit(tree, 'code', (code, _, parent) => {\n      if (code.lang !== 'json' || !code.meta || !parent) return;\n\n      const matches = metaRegex.exec(code.meta);\n      if (!matches) return;\n\n      const name = matches[1];\n      const gen = generators.find((g) => g.name === name);\n\n      const run = async (): Promise<void> => {\n        const result = await gen?.run(JSON.parse(code.value), {\n          cwd: file.cwd,\n          path: file.path,\n          node: code,\n        });\n        const index = parent.children.findIndex((c) => c === code);\n\n        if (result && index !== -1) {\n          const items = Array.isArray(result)\n            ? (result as BlockContent[])\n            : [result as BlockContent];\n\n          parent.children.splice(index, 1, ...items);\n        }\n      };\n\n      queue.push(run());\n    });\n\n    await Promise.all(queue);\n  };\n}\n","import type { Expression, Program } from 'estree';\nimport type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';\n\nexport function createElement(name: string, attributes: object[], children?: unknown): object {\n  const element: Record<string, unknown> = {\n    type: 'mdxJsxFlowElement',\n    name,\n    attributes,\n  };\n\n  if (children) element.children = children;\n\n  return element;\n}\n\nexport function expressionToAttribute(key: string, value: Expression): MdxJsxAttribute {\n  return {\n    type: 'mdxJsxAttribute',\n    name: key,\n    value: {\n      type: 'mdxJsxAttributeValueExpression',\n      value: '',\n      data: {\n        estree: {\n          type: 'Program',\n          body: [\n            {\n              type: 'ExpressionStatement',\n              expression: value,\n            },\n          ],\n        } as Program,\n      },\n    },\n  };\n}\n","import * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport type { Code, Paragraph } from 'mdast';\nimport { z } from 'zod';\nimport type { DocGenerator } from './remark-docgen';\n\nexport interface FileGeneratorOptions {\n  /** @defaultValue true */\n  trim?: boolean;\n\n  /**\n   * Resolve reference files relative to `vfile.path`\n   *\n   * @defaultValue false\n   */\n  relative?: boolean;\n}\n\nexport type FileGeneratorInput = z.output<typeof fileGeneratorSchema>;\n\nexport const fileGeneratorSchema = z.object({\n  file: z.string(),\n\n  /**\n   * Turn file content into a code block\n   *\n   * @defaultValue false\n   */\n  codeblock: z\n    .union([\n      z.object({\n        lang: z.string().optional(),\n        meta: z.string().optional(),\n      }),\n      z.boolean(),\n    ])\n    .default(false),\n});\n\nexport function fileGenerator({\n  relative = false,\n  trim = true,\n}: FileGeneratorOptions = {}): DocGenerator {\n  return {\n    name: 'file',\n    async run(input, ctx) {\n      const { file, codeblock = false } = fileGeneratorSchema.parse(input);\n\n      const dest = relative\n        ? path.resolve(ctx.cwd, path.dirname(ctx.path), file)\n        : path.resolve(ctx.cwd, file);\n      let value = await fs.readFile(dest).then((res) => res.toString());\n      if (trim) value = value.trim();\n\n      if (codeblock === false) {\n        return {\n          type: 'paragraph',\n          children: [{ type: 'text', value }],\n        } as Paragraph;\n      }\n\n      const codeOptions = codeblock === true ? {} : codeblock;\n\n      return {\n        type: 'code',\n        lang: codeOptions.lang ?? path.extname(dest).slice(1),\n        meta: codeOptions.meta,\n        value,\n      } as Code;\n    },\n  };\n}\n","import type { Code, Root } from 'mdast';\nimport type { Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport convert from 'npm-to-yarn';\nimport { createElement, expressionToAttribute } from './utils';\n\ninterface PackageManager {\n  name: string;\n\n  /**\n   * Convert from npm to another package manager\n   */\n  command: (command: string) => string;\n}\n\nexport type RemarkInstallOptions = {\n  Tabs?: string;\n  Tab?: string;\n\n  /**\n   * Persist Tab value (Fumadocs UI only)\n   *\n   * @defaultValue false\n   */\n  persist?:\n    | {\n        id: string;\n      }\n    | false;\n\n  packageManagers?: PackageManager[];\n};\n\n/**\n * It generates the following structure from a code block with `package-install` as language\n *\n * @example\n * ```tsx\n * <Tabs items={[\"npm\", \"pnpm\", \"yarn\", \"bun\"]}>\n *  <Tab value=\"pnpm\">...</Tab>\n *  ...\n * </Tabs>\n * ```\n *\n * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.\n */\nexport function remarkInstall({\n  Tab = 'Tab',\n  Tabs = 'Tabs',\n  persist = false,\n  packageManagers = [\n    { command: (cmd) => convert(cmd, 'npm'), name: 'npm' },\n    { command: (cmd) => convert(cmd, 'pnpm'), name: 'pnpm' },\n    { command: (cmd) => convert(cmd, 'yarn'), name: 'yarn' },\n    { command: (cmd) => convert(cmd, 'bun'), name: 'bun' },\n  ],\n}: RemarkInstallOptions = {}): Transformer<Root, Root> {\n  return (tree) => {\n    visit(tree, 'code', (node) => {\n      if (node.lang !== 'package-install') return 'skip';\n\n      const value =\n        node.value.startsWith('npm') || node.value.startsWith('npx')\n          ? node.value\n          : `npm install ${node.value}`;\n\n      const insert = createElement(\n        Tabs,\n        [\n          ...(typeof persist === 'object'\n            ? [\n                {\n                  type: 'mdxJsxAttribute',\n                  name: 'groupId',\n                  value: persist.id,\n                },\n                {\n                  type: 'mdxJsxAttribute',\n                  name: 'persist',\n                  value: null,\n                },\n              ]\n            : []),\n          expressionToAttribute('items', {\n            type: 'ArrayExpression',\n            elements: packageManagers.map(({ name }) => ({\n              type: 'Literal',\n              value: name,\n            })),\n          }),\n        ],\n        packageManagers.map(({ command, name }) => ({\n          type: 'mdxJsxFlowElement',\n          name: Tab,\n          attributes: [{ type: 'mdxJsxAttribute', name: 'value', value: name }],\n          children: [\n            {\n              type: 'code',\n              lang: 'bash',\n              meta: node.meta,\n              value: command(value),\n            } satisfies Code,\n          ],\n        })),\n      );\n\n      Object.assign(node, insert);\n    });\n  };\n}\n","/// <reference types=\"mdast-util-mdx-jsx\" />\nimport type { Transformer } from 'unified';\nimport type { Root, RootContent } from 'mdast';\nimport { visit } from 'unist-util-visit';\n\nexport function remarkShow(options?: {\n  variables?: Record<string, unknown>;\n}): Transformer<Root, Root> {\n  const variables = options?.variables ?? {};\n\n  return async (tree, file) => {\n    const { toJs } = await import('estree-util-to-js');\n    const tasks: Promise<void>[] = [];\n\n    visit(tree, 'mdxJsxFlowElement', (node) => {\n      if (node.name !== 'show') return;\n\n      for (const attr of node.attributes) {\n        if (attr.type !== 'mdxJsxAttribute' || attr.name !== 'on') continue;\n\n        if (!attr.value || typeof attr.value !== 'object' || !attr.value.data?.estree)\n          // skip invalid <show> components and its children\n          return 'skip';\n\n        const js = toJs(attr.value.data.estree);\n\n        const callback = new Function(...Object.keys(variables), `return ${js.value}`)(\n          ...Object.values(variables),\n        );\n\n        tasks.push(\n          (async () => {\n            const value = typeof callback === 'function' ? await callback(file) : callback;\n\n            Object.assign(node, {\n              type: 'mdxJsxFlowElement',\n              name: null,\n              attributes: [],\n              children: value === true ? node.children : [],\n            } satisfies RootContent);\n          })(),\n        );\n\n        return 'skip';\n      }\n    });\n\n    await Promise.all(tasks);\n  };\n}\n"],"mappings":";;;;;;;;AA4BA,MAAM,YAAY,qCAAqB;AAEvC,SAAgB,aAAa,EAAE,aAAa,EAAE,IAAkD;AAC9F;2CAAc,MAAM,MAAS;AAC3B,cAAW,SAAS,QAAQ;;8BAAI,4EAAS,MAAM,KAAK;KAAC;GACrD,MAAMA,QAAyB,EAAE;AAEjC,SAAM,MAAM,SAAS,MAAM,GAAG,WAAW;AACvC,QAAI,KAAK,SAAS,UAAU,CAAC,KAAK,QAAQ,CAAC,OAAQ;IAEnD,MAAM,UAAU,UAAU,KAAK,KAAK,KAAK;AACzC,QAAI,CAAC,QAAS;IAEd,MAAM,OAAO,QAAQ;IACrB,MAAM,MAAM,WAAW,MAAM,MAAM,EAAE,SAAS,KAAK;IAEnD,MAAM;+CAAiC;MACrC,MAAM,yDAAe,IAAK,IAAI,KAAK,MAAM,KAAK,MAAM,EAAE;OACpD,KAAK,KAAK;OACV,MAAM,KAAK;OACX,MAAM;OACP,CAAC;MACF,MAAM,QAAQ,OAAO,SAAS,WAAW,MAAM,MAAM,KAAK;AAE1D,UAAI,UAAU,UAAU,IAAI;OAC1B,MAAM,QAAQ,MAAM,QAAQ,OAAO,GAC9B,SACD,CAAC,OAAuB;AAE5B,cAAO,SAAS,OAAO,OAAO,GAAG,GAAG,MAAM;;;;;;;AAI9C,UAAM,KAAK,KAAK,CAAC;KACjB;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBAjCZ,IAAM;;;;;;;;AC5BtB,SAAgB,cAAc,MAAc,YAAsB,UAA4B;CAC5F,MAAMC,UAAmC;EACvC,MAAM;EACN;EACA;EACD;AAED,KAAI,SAAU,SAAQ,WAAW;AAEjC,QAAO;;AAGT,SAAgB,sBAAsB,KAAa,OAAoC;AACrF,QAAO;EACL,MAAM;EACN,MAAM;EACN,OAAO;GACL,MAAM;GACN,OAAO;GACP,MAAM,EACJ,QAAQ;IACN,MAAM;IACN,MAAM,CACJ;KACE,MAAM;KACN,YAAY;KACb,CACF;IACF,EACF;GACF;EACF;;;;;ACdH,MAAa,sBAAsB,EAAE,OAAO;CAC1C,MAAM,EAAE,QAAQ;CAOhB,WAAW,EACR,MAAM,CACL,EAAE,OAAO;EACP,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC3B,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC5B,CAAC,EACF,EAAE,SAAS,CACZ,CAAC,CACD,QAAQ,MAAM;CAClB,CAAC;AAEF,SAAgB,cAAc,EAC5B,WAAW,OACX,OAAO,SACiB,EAAE,EAAgB;AAC1C,QAAO;EACL,MAAM;EACN,AAAM,IAAI,OAAO;yCAAK;;IACpB,MAAM,EAAE,MAAM,YAAY,UAAU,oBAAoB,MAAM,MAAM;IAEpE,MAAM,OAAO,WACT,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,EAAE,KAAK,GACnD,KAAK,QAAQ,IAAI,KAAK,KAAK;IAC/B,IAAI,cAAc,GAAG,SAAS,KAAK,CAAC,MAAM,QAAQ,IAAI,UAAU,CAAC;AACjE,QAAI,KAAM,SAAQ,MAAM,MAAM;AAE9B,QAAI,cAAc,MAChB,QAAO;KACL,MAAM;KACN,UAAU,CAAC;MAAE,MAAM;MAAQ;MAAO,CAAC;KACpC;IAGH,MAAM,cAAc,cAAc,OAAO,EAAE,GAAG;AAE9C,WAAO;KACL,MAAM;KACN,2BAAM,YAAY,qEAAQ,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE;KACrD,MAAM,YAAY;KAClB;KACD;;;EAEJ;;;;;;;;;;;;;;;;;;ACxBH,SAAgB,cAAc,EAC5B,MAAM,OACN,OAAO,QACP,UAAU,OACV,kBAAkB;CAChB;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACtD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACvD,KACuB,EAAE,EAA2B;AACrD,SAAQ,SAAS;AACf,QAAM,MAAM,SAAS,SAAS;AAC5B,OAAI,KAAK,SAAS,kBAAmB,QAAO;GAE5C,MAAM,QACJ,KAAK,MAAM,WAAW,MAAM,IAAI,KAAK,MAAM,WAAW,MAAM,GACxD,KAAK,QACL,eAAe,KAAK;GAE1B,MAAM,SAAS,cACb,MACA,CACE,GAAI,OAAO,YAAY,WACnB,CACE;IACE,MAAM;IACN,MAAM;IACN,OAAO,QAAQ;IAChB,EACD;IACE,MAAM;IACN,MAAM;IACN,OAAO;IACR,CACF,GACD,EAAE,EACN,sBAAsB,SAAS;IAC7B,MAAM;IACN,UAAU,gBAAgB,KAAK,EAAE,YAAY;KAC3C,MAAM;KACN,OAAO;KACR,EAAE;IACJ,CAAC,CACH,EACD,gBAAgB,KAAK,EAAE,SAAS,YAAY;IAC1C,MAAM;IACN,MAAM;IACN,YAAY,CAAC;KAAE,MAAM;KAAmB,MAAM;KAAS,OAAO;KAAM,CAAC;IACrE,UAAU,CACR;KACE,MAAM;KACN,MAAM;KACN,MAAM,KAAK;KACX,OAAO,QAAQ,MAAM;KACtB,CACF;IACF,EAAE,CACJ;AAED,UAAO,OAAO,MAAM,OAAO;IAC3B;;;;;;ACtGN,SAAgB,WAAW,SAEC;;CAC1B,MAAM,oFAAY,QAAS,4EAAa,EAAE;AAE1C;0CAAc,MAAM,MAAS;GAC3B,MAAM,EAAE,eAAe,OAAO;GAC9B,MAAMC,QAAyB,EAAE;AAEjC,SAAM,MAAM,sBAAsB,SAAS;AACzC,QAAI,KAAK,SAAS,OAAQ;AAE1B,SAAK,MAAM,QAAQ,KAAK,YAAY;;AAClC,SAAI,KAAK,SAAS,qBAAqB,KAAK,SAAS,KAAM;AAE3D,SAAI,CAAC,KAAK,SAAS,OAAO,KAAK,UAAU,YAAY,sBAAC,KAAK,MAAM,0EAAM,QAErE,QAAO;KAET,MAAM,KAAK,KAAK,KAAK,MAAM,KAAK,OAAO;KAEvC,MAAM,WAAW,IAAI,SAAS,GAAG,OAAO,KAAK,UAAU,EAAE,UAAU,GAAG,QAAQ,CAC5E,GAAG,OAAO,OAAO,UAAU,CAC5B;AAED,WAAM,oCACS;MACX,MAAM,QAAQ,OAAO,aAAa,mBAAmB,SAAS,KAAK,GAAG;AAEtE,aAAO,OAAO,MAAM;OAClB,MAAM;OACN,MAAM;OACN,YAAY,EAAE;OACd,UAAU,UAAU,OAAO,KAAK,WAAW,EAAE;OAC9C,CAAuB;SACtB,CACL;AAED,YAAO;;KAET;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBArCZ,IAAM"}
+{"version":3,"file":"index.js","names":["queue: Promise<void>[]","element: Record<string, unknown>","tasks: Promise<void>[]"],"sources":["../src/remark-docgen.ts","../src/utils.ts","../src/file-generator.ts","../src/remark-install.ts","../src/remark-show.ts"],"sourcesContent":["import { type BlockContent, type Code, type Root } from 'mdast';\nimport { type Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport type { VFile } from 'vfile';\n\ntype Awaitable<T> = T | Promise<T>;\n\nexport interface DocGenerator {\n  name: string;\n\n  /**\n   * Transform codeblocks to another mdast element\n   */\n  run: (input: unknown, context: Context) => Awaitable<object | object[] | undefined>;\n\n  onFile?: (tree: Root, file: VFile) => void;\n}\n\ninterface Context {\n  node: Code;\n  path: string;\n  cwd: string;\n}\n\nexport interface RemarkDocGenOptions {\n  generators?: DocGenerator[];\n}\n\nconst metaRegex = /doc-gen:(?<name>.+)/;\n\nexport function remarkDocGen({ generators = [] }: RemarkDocGenOptions): Transformer<Root, Root> {\n  return async (tree, file) => {\n    generators.forEach((gen) => gen.onFile?.(tree, file));\n    const queue: Promise<void>[] = [];\n\n    visit(tree, 'code', (code, _, parent) => {\n      if (code.lang !== 'json' || !code.meta || !parent) return;\n\n      const matches = metaRegex.exec(code.meta);\n      if (!matches) return;\n\n      const name = matches[1];\n      const gen = generators.find((g) => g.name === name);\n\n      const run = async (): Promise<void> => {\n        const result = await gen?.run(JSON.parse(code.value), {\n          cwd: file.cwd,\n          path: file.path,\n          node: code,\n        });\n        const index = parent.children.findIndex((c) => c === code);\n\n        if (result && index !== -1) {\n          const items = Array.isArray(result)\n            ? (result as BlockContent[])\n            : [result as BlockContent];\n\n          parent.children.splice(index, 1, ...items);\n        }\n      };\n\n      queue.push(run());\n    });\n\n    await Promise.all(queue);\n  };\n}\n","import type { Expression, Program } from 'estree';\nimport type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';\n\nexport function createElement(name: string, attributes: object[], children?: unknown): object {\n  const element: Record<string, unknown> = {\n    type: 'mdxJsxFlowElement',\n    name,\n    attributes,\n  };\n\n  if (children) element.children = children;\n\n  return element;\n}\n\nexport function expressionToAttribute(key: string, value: Expression): MdxJsxAttribute {\n  return {\n    type: 'mdxJsxAttribute',\n    name: key,\n    value: {\n      type: 'mdxJsxAttributeValueExpression',\n      value: '',\n      data: {\n        estree: {\n          type: 'Program',\n          body: [\n            {\n              type: 'ExpressionStatement',\n              expression: value,\n            },\n          ],\n        } as Program,\n      },\n    },\n  };\n}\n","import * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport type { Code, Paragraph } from 'mdast';\nimport { z } from 'zod';\nimport type { DocGenerator } from './remark-docgen';\n\nexport interface FileGeneratorOptions {\n  /** @defaultValue true */\n  trim?: boolean;\n\n  /**\n   * Resolve reference files relative to `vfile.path`\n   *\n   * @defaultValue false\n   */\n  relative?: boolean;\n}\n\nexport type FileGeneratorInput = z.output<typeof fileGeneratorSchema>;\n\nexport const fileGeneratorSchema = z.object({\n  file: z.string(),\n\n  /**\n   * Turn file content into a code block\n   *\n   * @defaultValue false\n   */\n  codeblock: z\n    .union([\n      z.object({\n        lang: z.string().optional(),\n        meta: z.string().optional(),\n      }),\n      z.boolean(),\n    ])\n    .default(false),\n});\n\nexport function fileGenerator({\n  relative = false,\n  trim = true,\n}: FileGeneratorOptions = {}): DocGenerator {\n  return {\n    name: 'file',\n    async run(input, ctx) {\n      const { file, codeblock = false } = fileGeneratorSchema.parse(input);\n\n      const dest = relative\n        ? path.resolve(ctx.cwd, path.dirname(ctx.path), file)\n        : path.resolve(ctx.cwd, file);\n      let value = await fs.readFile(dest).then((res) => res.toString());\n      if (trim) value = value.trim();\n\n      if (codeblock === false) {\n        return {\n          type: 'paragraph',\n          children: [{ type: 'text', value }],\n        } as Paragraph;\n      }\n\n      const codeOptions = codeblock === true ? {} : codeblock;\n\n      return {\n        type: 'code',\n        lang: codeOptions.lang ?? path.extname(dest).slice(1),\n        meta: codeOptions.meta,\n        value,\n      } as Code;\n    },\n  };\n}\n","import type { Code, Root } from 'mdast';\nimport type { Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport convert from 'npm-to-yarn';\nimport { createElement, expressionToAttribute } from './utils';\n\ninterface PackageManager {\n  name: string;\n\n  /**\n   * Convert from npm to another package manager\n   */\n  command: (command: string) => string;\n}\n\nexport type RemarkInstallOptions = {\n  Tabs?: string;\n  Tab?: string;\n\n  /**\n   * Persist Tab value (Hanzo Docs UI only)\n   *\n   * @defaultValue false\n   */\n  persist?:\n    | {\n        id: string;\n      }\n    | false;\n\n  packageManagers?: PackageManager[];\n};\n\n/**\n * It generates the following structure from a code block with `package-install` as language\n *\n * @example\n * ```tsx\n * <Tabs items={[\"npm\", \"pnpm\", \"yarn\", \"bun\"]}>\n *  <Tab value=\"pnpm\">...</Tab>\n *  ...\n * </Tabs>\n * ```\n *\n * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.\n */\nexport function remarkInstall({\n  Tab = 'Tab',\n  Tabs = 'Tabs',\n  persist = false,\n  packageManagers = [\n    { command: (cmd) => convert(cmd, 'npm'), name: 'npm' },\n    { command: (cmd) => convert(cmd, 'pnpm'), name: 'pnpm' },\n    { command: (cmd) => convert(cmd, 'yarn'), name: 'yarn' },\n    { command: (cmd) => convert(cmd, 'bun'), name: 'bun' },\n  ],\n}: RemarkInstallOptions = {}): Transformer<Root, Root> {\n  return (tree) => {\n    visit(tree, 'code', (node) => {\n      if (node.lang !== 'package-install') return 'skip';\n\n      const value =\n        node.value.startsWith('npm') || node.value.startsWith('npx')\n          ? node.value\n          : `npm install ${node.value}`;\n\n      const insert = createElement(\n        Tabs,\n        [\n          ...(typeof persist === 'object'\n            ? [\n                {\n                  type: 'mdxJsxAttribute',\n                  name: 'groupId',\n                  value: persist.id,\n                },\n                {\n                  type: 'mdxJsxAttribute',\n                  name: 'persist',\n                  value: null,\n                },\n              ]\n            : []),\n          expressionToAttribute('items', {\n            type: 'ArrayExpression',\n            elements: packageManagers.map(({ name }) => ({\n              type: 'Literal',\n              value: name,\n            })),\n          }),\n        ],\n        packageManagers.map(({ command, name }) => ({\n          type: 'mdxJsxFlowElement',\n          name: Tab,\n          attributes: [{ type: 'mdxJsxAttribute', name: 'value', value: name }],\n          children: [\n            {\n              type: 'code',\n              lang: 'bash',\n              meta: node.meta,\n              value: command(value),\n            } satisfies Code,\n          ],\n        })),\n      );\n\n      Object.assign(node, insert);\n    });\n  };\n}\n","/// <reference types=\"mdast-util-mdx-jsx\" />\nimport type { Transformer } from 'unified';\nimport type { Root, RootContent } from 'mdast';\nimport { visit } from 'unist-util-visit';\n\nexport function remarkShow(options?: {\n  variables?: Record<string, unknown>;\n}): Transformer<Root, Root> {\n  const variables = options?.variables ?? {};\n\n  return async (tree, file) => {\n    const { toJs } = await import('estree-util-to-js');\n    const tasks: Promise<void>[] = [];\n\n    visit(tree, 'mdxJsxFlowElement', (node) => {\n      if (node.name !== 'show') return;\n\n      for (const attr of node.attributes) {\n        if (attr.type !== 'mdxJsxAttribute' || attr.name !== 'on') continue;\n\n        if (!attr.value || typeof attr.value !== 'object' || !attr.value.data?.estree)\n          // skip invalid <show> components and its children\n          return 'skip';\n\n        const js = toJs(attr.value.data.estree);\n\n        const callback = new Function(...Object.keys(variables), `return ${js.value}`)(\n          ...Object.values(variables),\n        );\n\n        tasks.push(\n          (async () => {\n            const value = typeof callback === 'function' ? await callback(file) : callback;\n\n            Object.assign(node, {\n              type: 'mdxJsxFlowElement',\n              name: null,\n              attributes: [],\n              children: value === true ? node.children : [],\n            } satisfies RootContent);\n          })(),\n        );\n\n        return 'skip';\n      }\n    });\n\n    await Promise.all(tasks);\n  };\n}\n"],"mappings":";;;;;;;;AA4BA,MAAM,YAAY,qCAAqB;AAEvC,SAAgB,aAAa,EAAE,aAAa,EAAE,IAAkD;AAC9F;2CAAc,MAAM,MAAS;AAC3B,cAAW,SAAS,QAAQ;;8BAAI,4EAAS,MAAM,KAAK;KAAC;GACrD,MAAMA,QAAyB,EAAE;AAEjC,SAAM,MAAM,SAAS,MAAM,GAAG,WAAW;AACvC,QAAI,KAAK,SAAS,UAAU,CAAC,KAAK,QAAQ,CAAC,OAAQ;IAEnD,MAAM,UAAU,UAAU,KAAK,KAAK,KAAK;AACzC,QAAI,CAAC,QAAS;IAEd,MAAM,OAAO,QAAQ;IACrB,MAAM,MAAM,WAAW,MAAM,MAAM,EAAE,SAAS,KAAK;IAEnD,MAAM;+CAAiC;MACrC,MAAM,yDAAe,IAAK,IAAI,KAAK,MAAM,KAAK,MAAM,EAAE;OACpD,KAAK,KAAK;OACV,MAAM,KAAK;OACX,MAAM;OACP,CAAC;MACF,MAAM,QAAQ,OAAO,SAAS,WAAW,MAAM,MAAM,KAAK;AAE1D,UAAI,UAAU,UAAU,IAAI;OAC1B,MAAM,QAAQ,MAAM,QAAQ,OAAO,GAC9B,SACD,CAAC,OAAuB;AAE5B,cAAO,SAAS,OAAO,OAAO,GAAG,GAAG,MAAM;;;;;;;AAI9C,UAAM,KAAK,KAAK,CAAC;KACjB;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBAjCZ,IAAM;;;;;;;;AC5BtB,SAAgB,cAAc,MAAc,YAAsB,UAA4B;CAC5F,MAAMC,UAAmC;EACvC,MAAM;EACN;EACA;EACD;AAED,KAAI,SAAU,SAAQ,WAAW;AAEjC,QAAO;;AAGT,SAAgB,sBAAsB,KAAa,OAAoC;AACrF,QAAO;EACL,MAAM;EACN,MAAM;EACN,OAAO;GACL,MAAM;GACN,OAAO;GACP,MAAM,EACJ,QAAQ;IACN,MAAM;IACN,MAAM,CACJ;KACE,MAAM;KACN,YAAY;KACb,CACF;IACF,EACF;GACF;EACF;;;;;ACdH,MAAa,sBAAsB,EAAE,OAAO;CAC1C,MAAM,EAAE,QAAQ;CAOhB,WAAW,EACR,MAAM,CACL,EAAE,OAAO;EACP,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC3B,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC5B,CAAC,EACF,EAAE,SAAS,CACZ,CAAC,CACD,QAAQ,MAAM;CAClB,CAAC;AAEF,SAAgB,cAAc,EAC5B,WAAW,OACX,OAAO,SACiB,EAAE,EAAgB;AAC1C,QAAO;EACL,MAAM;EACN,AAAM,IAAI,OAAO;yCAAK;;IACpB,MAAM,EAAE,MAAM,YAAY,UAAU,oBAAoB,MAAM,MAAM;IAEpE,MAAM,OAAO,WACT,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,EAAE,KAAK,GACnD,KAAK,QAAQ,IAAI,KAAK,KAAK;IAC/B,IAAI,cAAc,GAAG,SAAS,KAAK,CAAC,MAAM,QAAQ,IAAI,UAAU,CAAC;AACjE,QAAI,KAAM,SAAQ,MAAM,MAAM;AAE9B,QAAI,cAAc,MAChB,QAAO;KACL,MAAM;KACN,UAAU,CAAC;MAAE,MAAM;MAAQ;MAAO,CAAC;KACpC;IAGH,MAAM,cAAc,cAAc,OAAO,EAAE,GAAG;AAE9C,WAAO;KACL,MAAM;KACN,2BAAM,YAAY,qEAAQ,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE;KACrD,MAAM,YAAY;KAClB;KACD;;;EAEJ;;;;;;;;;;;;;;;;;;ACxBH,SAAgB,cAAc,EAC5B,MAAM,OACN,OAAO,QACP,UAAU,OACV,kBAAkB;CAChB;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACtD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACvD,KACuB,EAAE,EAA2B;AACrD,SAAQ,SAAS;AACf,QAAM,MAAM,SAAS,SAAS;AAC5B,OAAI,KAAK,SAAS,kBAAmB,QAAO;GAE5C,MAAM,QACJ,KAAK,MAAM,WAAW,MAAM,IAAI,KAAK,MAAM,WAAW,MAAM,GACxD,KAAK,QACL,eAAe,KAAK;GAE1B,MAAM,SAAS,cACb,MACA,CACE,GAAI,OAAO,YAAY,WACnB,CACE;IACE,MAAM;IACN,MAAM;IACN,OAAO,QAAQ;IAChB,EACD;IACE,MAAM;IACN,MAAM;IACN,OAAO;IACR,CACF,GACD,EAAE,EACN,sBAAsB,SAAS;IAC7B,MAAM;IACN,UAAU,gBAAgB,KAAK,EAAE,YAAY;KAC3C,MAAM;KACN,OAAO;KACR,EAAE;IACJ,CAAC,CACH,EACD,gBAAgB,KAAK,EAAE,SAAS,YAAY;IAC1C,MAAM;IACN,MAAM;IACN,YAAY,CAAC;KAAE,MAAM;KAAmB,MAAM;KAAS,OAAO;KAAM,CAAC;IACrE,UAAU,CACR;KACE,MAAM;KACN,MAAM;KACN,MAAM,KAAK;KACX,OAAO,QAAQ,MAAM;KACtB,CACF;IACF,EAAE,CACJ;AAED,UAAO,OAAO,MAAM,OAAO;IAC3B;;;;;;ACtGN,SAAgB,WAAW,SAEC;;CAC1B,MAAM,oFAAY,QAAS,4EAAa,EAAE;AAE1C;0CAAc,MAAM,MAAS;GAC3B,MAAM,EAAE,eAAe,OAAO;GAC9B,MAAMC,QAAyB,EAAE;AAEjC,SAAM,MAAM,sBAAsB,SAAS;AACzC,QAAI,KAAK,SAAS,OAAQ;AAE1B,SAAK,MAAM,QAAQ,KAAK,YAAY;;AAClC,SAAI,KAAK,SAAS,qBAAqB,KAAK,SAAS,KAAM;AAE3D,SAAI,CAAC,KAAK,SAAS,OAAO,KAAK,UAAU,YAAY,sBAAC,KAAK,MAAM,0EAAM,QAErE,QAAO;KAET,MAAM,KAAK,KAAK,KAAK,MAAM,KAAK,OAAO;KAEvC,MAAM,WAAW,IAAI,SAAS,GAAG,OAAO,KAAK,UAAU,EAAE,UAAU,GAAG,QAAQ,CAC5E,GAAG,OAAO,OAAO,UAAU,CAC5B;AAED,WAAM,oCACS;MACX,MAAM,QAAQ,OAAO,aAAa,mBAAmB,SAAS,KAAK,GAAG;AAEtE,aAAO,OAAO,MAAM;OAClB,MAAM;OACN,MAAM;OACN,YAAY,EAAE;OACd,UAAU,UAAU,OAAO,KAAK,WAAW,EAAE;OAC9C,CAAuB;SACtB,CACL;AAED,YAAO;;KAET;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBArCZ,IAAM"}

package/dist/remark-ts2js.d.ts

@@ -4,7 +4,7 @@ import { Transformer } from "unified";
 //#region src/remark-ts2js.d.ts
 interface TypeScriptToJavaScriptOptions {
   /**
-   * Persist Tab value (Fumadocs UI only)
+   * Persist Tab value (Hanzo Docs UI only)
    *
    * @defaultValue false
    */

package/dist/remark-ts2js.js.map

@@ -1 +1 @@
-{"version":3,"file":"remark-ts2js.js","names":["tasks: Promise<void>[]"],"sources":["../src/remark-ts2js.ts"],"sourcesContent":["import type { Transformer } from 'unified';\nimport type { Root } from 'mdast';\nimport { visit } from 'unist-util-visit';\nimport {\n  generateCodeBlockTabs,\n  parseCodeBlockAttributes,\n} from '@hanzo/docs-core/mdx-plugins/codeblock-utils';\n\nexport interface TypeScriptToJavaScriptOptions {\n  /**\n   * Persist Tab value (Fumadocs UI only)\n   *\n   * @defaultValue false\n   */\n  persist?:\n    | {\n        id: string;\n      }\n    | false;\n\n  defaultValue?: 'js' | 'ts';\n\n  /**\n   * Transform all TypeScript codeblocks by default, without a trigger\n   */\n  disableTrigger?: boolean;\n}\n\n/**\n * A remark plugin to transform TypeScript codeblocks into two tabs of codeblocks with its JS variant.\n *\n * Add `ts2js` to enable transformation:\n * ````md\n * ```tsx ts2js\n * import { ReactNode } from \"react\";\n *\n * export default function Layout({ children }: { children: ReactNode }) {\n *     return <div>{children}</div>\n * }\n * ```\n * ````\n */\nexport function remarkTypeScriptToJavaScript({\n  persist = false,\n  defaultValue = 'ts',\n  disableTrigger = false,\n}: TypeScriptToJavaScriptOptions = {}): Transformer<Root> {\n  return async (tree, file) => {\n    const oxc = await import('oxc-transform');\n    const tasks: Promise<void>[] = [];\n\n    visit(tree, 'code', (node) => {\n      const lang = node.lang;\n      if (lang !== 'ts' && lang !== 'tsx') return;\n\n      const meta = parseCodeBlockAttributes(node.meta ?? '', ['ts2js']);\n      if (!disableTrigger && !('ts2js' in meta.attributes)) return;\n\n      tasks.push(\n        (async () => {\n          const result = await oxc.transform(`${file.path ?? 'test'}.${lang}`, node.value, {\n            sourcemap: false,\n            jsx: 'preserve',\n          });\n\n          const replacement = generateCodeBlockTabs({\n            persist,\n            defaultValue,\n            triggers: [\n              {\n                value: 'ts',\n                children: [{ type: 'text', value: 'TypeScript' }],\n              },\n              {\n                value: 'js',\n                children: [{ type: 'text', value: 'JavaScript' }],\n              },\n            ],\n            tabs: [\n              {\n                value: 'ts',\n                children: [\n                  {\n                    type: 'code',\n                    lang: node.lang,\n                    meta: meta.rest,\n                    value: node.value,\n                  },\n                ],\n              },\n              {\n                value: 'js',\n                children: [\n                  {\n                    type: 'code',\n                    lang: lang === 'tsx' ? 'jsx' : 'js',\n                    meta: meta.attributes.ts2js ?? meta.rest,\n                    value: result.code,\n                  },\n                ],\n              },\n            ],\n          });\n\n          Object.assign(node, replacement);\n        })(),\n      );\n\n      return 'skip';\n    });\n\n    await Promise.all(tasks);\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA0CA,SAAgB,6BAA6B,EAC3C,UAAU,OACV,eAAe,MACf,iBAAiB,UACgB,EAAE,EAAqB;AACxD;0CAAc,MAAM,MAAS;GAC3B,MAAM,YAAY,OAAO;GACzB,MAAMA,QAAyB,EAAE;AAEjC,SAAM,MAAM,SAAS,SAAS;;IAC5B,MAAM,OAAO,KAAK;AAClB,QAAI,SAAS,QAAQ,SAAS,MAAO;IAErC,MAAM,OAAO,uCAAyB,KAAK,uDAAQ,IAAI,CAAC,QAAQ,CAAC;AACjE,QAAI,CAAC,kBAAkB,EAAE,WAAW,KAAK,YAAa;AAEtD,UAAM,oCACS;;KACX,MAAM,eAAe,IAAI,UAAU,iBAAG,KAAK,uDAAQ,OAAO,GAAG,QAAQ,KAAK,OAAO;MAC/E,WAAW;MACX,KAAK;MACN,CAAC;KAEF,MAAM,cAAc,sBAAsB;MACxC;MACA;MACA,UAAU,CACR;OACE,OAAO;OACP,UAAU,CAAC;QAAE,MAAM;QAAQ,OAAO;QAAc,CAAC;OAClD,EACD;OACE,OAAO;OACP,UAAU,CAAC;QAAE,MAAM;QAAQ,OAAO;QAAc,CAAC;OAClD,CACF;MACD,MAAM,CACJ;OACE,OAAO;OACP,UAAU,CACR;QACE,MAAM;QACN,MAAM,KAAK;QACX,MAAM,KAAK;QACX,OAAO,KAAK;QACb,CACF;OACF,EACD;OACE,OAAO;OACP,UAAU,CACR;QACE,MAAM;QACN,MAAM,SAAS,QAAQ,QAAQ;QAC/B,+BAAM,KAAK,WAAW,8EAAS,KAAK;QACpC,OAAO,OAAO;QACf,CACF;OACF,CACF;MACF,CAAC;AAEF,YAAO,OAAO,MAAM,YAAY;QAC9B,CACL;AAED,WAAO;KACP;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBAhEZ,IAAM"}
+{"version":3,"file":"remark-ts2js.js","names":["tasks: Promise<void>[]"],"sources":["../src/remark-ts2js.ts"],"sourcesContent":["import type { Transformer } from 'unified';\nimport type { Root } from 'mdast';\nimport { visit } from 'unist-util-visit';\nimport {\n  generateCodeBlockTabs,\n  parseCodeBlockAttributes,\n} from '@hanzo/docs-core/mdx-plugins/codeblock-utils';\n\nexport interface TypeScriptToJavaScriptOptions {\n  /**\n   * Persist Tab value (Hanzo Docs UI only)\n   *\n   * @defaultValue false\n   */\n  persist?:\n    | {\n        id: string;\n      }\n    | false;\n\n  defaultValue?: 'js' | 'ts';\n\n  /**\n   * Transform all TypeScript codeblocks by default, without a trigger\n   */\n  disableTrigger?: boolean;\n}\n\n/**\n * A remark plugin to transform TypeScript codeblocks into two tabs of codeblocks with its JS variant.\n *\n * Add `ts2js` to enable transformation:\n * ````md\n * ```tsx ts2js\n * import { ReactNode } from \"react\";\n *\n * export default function Layout({ children }: { children: ReactNode }) {\n *     return <div>{children}</div>\n * }\n * ```\n * ````\n */\nexport function remarkTypeScriptToJavaScript({\n  persist = false,\n  defaultValue = 'ts',\n  disableTrigger = false,\n}: TypeScriptToJavaScriptOptions = {}): Transformer<Root> {\n  return async (tree, file) => {\n    const oxc = await import('oxc-transform');\n    const tasks: Promise<void>[] = [];\n\n    visit(tree, 'code', (node) => {\n      const lang = node.lang;\n      if (lang !== 'ts' && lang !== 'tsx') return;\n\n      const meta = parseCodeBlockAttributes(node.meta ?? '', ['ts2js']);\n      if (!disableTrigger && !('ts2js' in meta.attributes)) return;\n\n      tasks.push(\n        (async () => {\n          const result = await oxc.transform(`${file.path ?? 'test'}.${lang}`, node.value, {\n            sourcemap: false,\n            jsx: 'preserve',\n          });\n\n          const replacement = generateCodeBlockTabs({\n            persist,\n            defaultValue,\n            triggers: [\n              {\n                value: 'ts',\n                children: [{ type: 'text', value: 'TypeScript' }],\n              },\n              {\n                value: 'js',\n                children: [{ type: 'text', value: 'JavaScript' }],\n              },\n            ],\n            tabs: [\n              {\n                value: 'ts',\n                children: [\n                  {\n                    type: 'code',\n                    lang: node.lang,\n                    meta: meta.rest,\n                    value: node.value,\n                  },\n                ],\n              },\n              {\n                value: 'js',\n                children: [\n                  {\n                    type: 'code',\n                    lang: lang === 'tsx' ? 'jsx' : 'js',\n                    meta: meta.attributes.ts2js ?? meta.rest,\n                    value: result.code,\n                  },\n                ],\n              },\n            ],\n          });\n\n          Object.assign(node, replacement);\n        })(),\n      );\n\n      return 'skip';\n    });\n\n    await Promise.all(tasks);\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA0CA,SAAgB,6BAA6B,EAC3C,UAAU,OACV,eAAe,MACf,iBAAiB,UACgB,EAAE,EAAqB;AACxD;0CAAc,MAAM,MAAS;GAC3B,MAAM,YAAY,OAAO;GACzB,MAAMA,QAAyB,EAAE;AAEjC,SAAM,MAAM,SAAS,SAAS;;IAC5B,MAAM,OAAO,KAAK;AAClB,QAAI,SAAS,QAAQ,SAAS,MAAO;IAErC,MAAM,OAAO,uCAAyB,KAAK,uDAAQ,IAAI,CAAC,QAAQ,CAAC;AACjE,QAAI,CAAC,kBAAkB,EAAE,WAAW,KAAK,YAAa;AAEtD,UAAM,oCACS;;KACX,MAAM,eAAe,IAAI,UAAU,iBAAG,KAAK,uDAAQ,OAAO,GAAG,QAAQ,KAAK,OAAO;MAC/E,WAAW;MACX,KAAK;MACN,CAAC;KAEF,MAAM,cAAc,sBAAsB;MACxC;MACA;MACA,UAAU,CACR;OACE,OAAO;OACP,UAAU,CAAC;QAAE,MAAM;QAAQ,OAAO;QAAc,CAAC;OAClD,EACD;OACE,OAAO;OACP,UAAU,CAAC;QAAE,MAAM;QAAQ,OAAO;QAAc,CAAC;OAClD,CACF;MACD,MAAM,CACJ;OACE,OAAO;OACP,UAAU,CACR;QACE,MAAM;QACN,MAAM,KAAK;QACX,MAAM,KAAK;QACX,OAAO,KAAK;QACb,CACF;OACF,EACD;OACE,OAAO;OACP,UAAU,CACR;QACE,MAAM;QACN,MAAM,SAAS,QAAQ,QAAQ;QAC/B,+BAAM,KAAK,WAAW,8EAAS,KAAK;QACpC,OAAO,OAAO;QACf,CACF;OACF,CACF;MACF,CAAC;AAEF,YAAO,OAAO,MAAM,YAAY;QAC9B,CACL;AAED,WAAO;KACP;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBAhEZ,IAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hanzo/docs-docgen",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "description": "Useful remark utilities and plugins for Hanzo Docs",
   "keywords": [
     "Docs",
@@ -31,6 +31,13 @@
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf dist",
+    "dev": "tsdown --watch",
+    "lint": "eslint .",
+    "types:check": "tsc --noEmit"
+  },
   "dependencies": {
     "estree-util-to-js": "^2.0.0",
     "estree-util-value-to-estree": "^3.5.0",
@@ -45,24 +52,17 @@
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.4",
     "@types/node": "24.10.2",
+    "eslint-config-custom": "workspace:*",
+    "@hanzo/docs-core": "workspace:*",
     "mdast-util-mdx-jsx": "^3.2.0",
     "remark": "^15.0.1",
+    "tsconfig": "workspace:*",
     "tsdown": "^0.18.3",
     "typescript": "^5.9.3",
     "unified": "^11.0.5",
-    "vfile": "^6.0.3",
-    "eslint-config-custom": "0.0.0",
-    "tsconfig": "0.0.0",
-    "@hanzo/docs-core": "16.4.3"
+    "vfile": "^6.0.3"
   },
   "peerDependencies": {
     "@hanzo/docs-core": "^15.7.2 || ^16.0.0"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "clean": "rimraf dist",
-    "dev": "tsdown --watch",
-    "lint": "eslint .",
-    "types:check": "tsc --noEmit"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Fuma
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.