react-lib-tools 0.0.2 → 0.0.4

package/lib/types.ts

@@ -0,0 +1,35 @@
+export type Intent = "danger" | "none" | "primary" | "success" | "warning";
+
+export type Section = {
+  content: string;
+  intent?: Intent | undefined;
+};
+
+export type ComponentPropMetadata = {
+  description: Section[];
+  html: string;
+  name: string;
+  required: boolean;
+};
+
+export type ComponentMetadata = {
+  description: Section[];
+  filePath: string;
+  name: string;
+  props: {
+    [name: string]: ComponentPropMetadata;
+  };
+};
+
+export type ImperativeHandleMethodMetadata = {
+  description: Section[];
+  html: string;
+  name: string;
+};
+
+export type ImperativeHandleMetadata = {
+  description: Section[];
+  filePath: string;
+  name: string;
+  methods: ImperativeHandleMethodMetadata[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-lib-tools",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "author": "Brian Vaughn <brian.david.vaughn@gmail.com> (https://github.com/bvaughn/)",
   "contributors": [
@@ -16,6 +16,7 @@
   "types": "dist/react-lib-tools.d.ts",
   "files": [
     "dist",
+    "lib/types.ts",
     "scripts",
     "styles.css"
   ],

package/scripts/compile-docs.ts

@@ -1,21 +1,26 @@
 import { compileComponents } from "./utils/docs/compileComponents.ts";
 import { compileImperativeHandles } from "./utils/docs/compileImperativeHandles.ts";
+import type { CompilerOptions } from "typescript";
 
 export async function compileDocs({
+  compilerOptions = {},
   componentNames,
   imperativeHandleNames,
   outputDirName = "docs"
 }: {
+  compilerOptions: Partial<CompilerOptions>;
   componentNames: string[];
   imperativeHandleNames: string[];
   outputDirName?: string | undefined;
 }) {
   await compileComponents({
+    compilerOptions,
     componentNames,
     outputDirName
   });
 
   await compileImperativeHandles({
+    compilerOptions,
     names: imperativeHandleNames,
     outputDirName
   });

package/scripts/utils/assert.ts

@@ -0,0 +1,10 @@
+export function assert(
+  expectedCondition: unknown,
+  message: string = "Assertion error"
+): asserts expectedCondition {
+  if (!expectedCondition) {
+    console.error(message);
+
+    throw Error(message);
+  }
+}

package/scripts/utils/docs/compileComponent.ts

@@ -2,8 +2,8 @@ import { writeFile } from "node:fs/promises";
 import { join, relative } from "node:path";
 import { cwd } from "node:process";
 import { type FileParser, type PropItem } from "react-docgen-typescript";
-import type { ComponentMetadata } from "react-lib-tools";
-import { assert } from "../../../lib/utils/assert.ts";
+import type { ComponentMetadata } from "../../../lib/types.ts";
+import { assert } from "../assert.ts";
 import { syntaxHighlight } from "../syntax-highlight.ts";
 import { getPropTypeText } from "./getPropTypeText.ts";
 import { parseDescription } from "./parseDescription.ts";

package/scripts/utils/docs/compileComponents.ts

@@ -1,19 +1,22 @@
 import { readFile, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import { cwd } from "node:process";
-import { withCustomConfig } from "react-docgen-typescript";
+import { withCompilerOptions } from "react-docgen-typescript";
+import type { CompilerOptions } from "typescript";
 import { initialize } from "../initialize.ts";
 import { compileComponent } from "./compileComponent.ts";
 import { insertPropsMarkdown } from "./insertPropsMarkdown.ts";
 
 export async function compileComponents({
+  compilerOptions,
   componentNames,
   outputDirName
 }: {
+  compilerOptions: Partial<CompilerOptions>;
   componentNames: string[];
   outputDirName: string;
 }) {
-  const parser = withCustomConfig("./tsconfig.json", {
+  const parser = withCompilerOptions(compilerOptions, {
     savePropValueAsString: true,
     shouldExtractLiteralValuesFromEnum: true,
     shouldExtractValuesFromUnion: true,

package/scripts/utils/docs/compileImperativeHandle.ts

@@ -2,7 +2,7 @@ import type { InterfaceNode } from "@ts-ast-parser/core";
 import assert from "node:assert";
 import { writeFile } from "node:fs/promises";
 import { join } from "path";
-import type { ImperativeHandleMetadata } from "react-lib-tools";
+import type { ImperativeHandleMetadata } from "../../../lib/types.ts";
 import { syntaxHighlight } from "../syntax-highlight.ts";
 import { parseDescription } from "./parseDescription.ts";
 

package/scripts/utils/docs/compileImperativeHandles.ts

@@ -1,19 +1,21 @@
 import { parseFromProject, type InterfaceNode } from "@ts-ast-parser/core";
-import tsConfig from "../../../tsconfig.json" with { type: "json" };
-import { compileImperativeHandle } from "./compileImperativeHandle.ts";
 import { join } from "node:path";
 import { cwd } from "node:process";
+import type { CompilerOptions } from "typescript";
+import { compileImperativeHandle } from "./compileImperativeHandle.ts";
 
 export async function compileImperativeHandles({
+  compilerOptions,
   names,
   outputDirName
 }: {
+  compilerOptions: Partial<CompilerOptions>;
   names: string[];
   outputDirName: string;
 }) {
   const outputDir = join(cwd(), "public", "generated", outputDirName);
 
-  const result = await parseFromProject(tsConfig);
+  const result = await parseFromProject({ compilerOptions });
   const reflectedModules = result.project?.getModules() ?? [];
 
   const nodes: {
@@ -25,10 +27,13 @@ export async function compileImperativeHandles({
     reflectedModules.forEach((reflectedModule) => {
       const node = reflectedModule.getDeclarationByName(name);
       if (node) {
-        nodes.push({
-          filePath: reflectedModule.getSourcePath(),
-          node: node as unknown as InterfaceNode
-        });
+        const filePath = reflectedModule.getSourcePath();
+        if (filePath.startsWith("lib/")) {
+          nodes.push({
+            filePath,
+            node: node as unknown as InterfaceNode
+          });
+        }
       }
     });
   });

package/scripts/utils/docs/parseDescription.ts

@@ -1,4 +1,4 @@
-import type { Intent, Section } from "react-lib-tools";
+import type { Intent, Section } from "../../../lib/types.ts";
 import { syntaxHighlight, type Language } from "../syntax-highlight.ts";
 import { formatDescriptionText } from "./formatDescriptionText.ts";