@xylabs/readme-gen 5.0.79 → 5.0.81

package/README.md

@@ -1,4 +1,4 @@
-# @xylabs/set
+# @xylabs/readme-gen
 
 [![logo][]](https://xylabs.com)
 
@@ -17,107 +17,29 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Reference
 
-**@xylabs/set**
+**@xylabs/readme-gen**
 
 ***
 
 ## Functions
 
-- [difference](#functions/difference)
-- [intersection](#functions/intersection)
-- [union](#functions/union)
+- [generateReadmeFiles](#functions/generateReadmeFiles)
 
 ### functions
 
-  ### <a id="difference"></a>difference
+  ### <a id="generateReadmeFiles"></a>generateReadmeFiles
 
-[**@xylabs/set**](#../README)
+[**@xylabs/readme-gen**](#../README)
 
 ***
 
 ```ts
-function difference<TKey>(a, b): Set<TKey>;
+function generateReadmeFiles(): Promise<void>;
 ```
 
-## Type Parameters
-
-### TKey
-
-`TKey`
-
-## Parameters
-
-### a
-
-`Set`\<`TKey`\>
-
-### b
-
-`Set`\<`TKey`\>
-
-## Returns
-
-`Set`\<`TKey`\>
-
-  ### <a id="intersection"></a>intersection
-
-[**@xylabs/set**](#../README)
-
-***
-
-```ts
-function intersection<TKey>(a, b): Set<TKey>;
-```
-
-## Type Parameters
-
-### TKey
-
-`TKey`
-
-## Parameters
-
-### a
-
-`Set`\<`TKey`\>
-
-### b
-
-`Set`\<`TKey`\>
-
-## Returns
-
-`Set`\<`TKey`\>
-
-  ### <a id="union"></a>union
-
-[**@xylabs/set**](#../README)
-
-***
-
-```ts
-function union<TKey>(a, b): Set<TKey>;
-```
-
-## Type Parameters
-
-### TKey
-
-`TKey`
-
-## Parameters
-
-### a
-
-`Set`\<`TKey`\>
-
-### b
-
-`Set`\<`TKey`\>
-
 ## Returns
 
-`Set`\<`TKey`\>
+`Promise`\<`void`\>
 
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
@@ -141,8 +63,8 @@ Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
 [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/set.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/set
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/readme-gen.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/readme-gen
 [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
 [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
 [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
@@ -150,11 +72,11 @@ Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
 [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/set
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/set
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/readme-gen
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/readme-gen
 
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/set/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/set
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/readme-gen/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/readme-gen
 
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/set
-[socket-link]: https://socket.dev/npm/package/@xylabs/set
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/readme-gen
+[socket-link]: https://socket.dev/npm/package/@xylabs/readme-gen

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/readme-gen",
-  "version": "5.0.79",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "readme",
@@ -31,28 +31,25 @@
   "exports": {
     ".": {
       "types": "./dist/node/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/node/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/node/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/node/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.3.2"
+    "@xylabs/ts-scripts-yarn3": "~7.4.11"
   },
   "devDependencies": {
-    "@xylabs/tsconfig": "~7.3.2",
+    "@xylabs/tsconfig": "~7.4.11",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.18"
+    "vitest": "^4.0.18"
   },
   "engines": {
     "node": ">=18"

package/src/generateReadmeFiles.ts

@@ -1,60 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable no-console */
-
-// generate-readmes.mjs
-import { readFile, writeFile } from 'node:fs/promises'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-import { yarnWorkspaces } from '@xylabs/ts-scripts-yarn3'
-
-import { generateTypeDoc } from './generateTypeDoc.ts'
-
-const dirName = () => path.dirname(fileURLToPath(import.meta.url))
-const templatePath = () => path.join(dirName(), 'README.template.md')
-
-function fillTemplate(template: string, data: { [key: string]: string }) {
-  const additionalData: { [key: string]: string } = { ...data, safeName: data.name.replaceAll('/', '__').replaceAll('@', '') }
-  return template.replaceAll(/{{(.*?)}}/g, (_, key) => additionalData[(key as string).trim()] ?? '')
-}
-
-async function tryLoadReadmeBody(location: string) {
-  try {
-    return await readFile(path.join(location, 'README.body.md'), 'utf8')
-  } catch {
-    return
-  }
-}
-
-async function tryLoadReadmeReference(location: string) {
-  try {
-    return await readFile(path.join(location, 'README.reference.md'), 'utf8')
-  } catch {
-    return
-  }
-}
-
-export async function generateReadmeFiles() {
-  const template = await readFile(templatePath(), 'utf8')
-  const pkgs = yarnWorkspaces()
-
-  for (const { location } of pkgs) {
-    try {
-      if (location.includes('wallet-chrome')) {
-        continue
-      }
-      const pkgJsonPath = path.join(location, 'package.json')
-      const pkg = JSON.parse(await readFile(pkgJsonPath, 'utf8'))
-      const body = await tryLoadReadmeBody(location) ?? ''
-      const reference = await tryLoadReadmeReference(location) ?? await generateTypeDoc(location, ['src/index*.ts'])
-      const readmeContent = fillTemplate(template, {
-        ...pkg, body, reference,
-      })
-      await writeFile(path.join(location, 'README.md'), readmeContent)
-      console.log(`✅ Created README.md for ${pkg.name}`)
-    } catch (ex) {
-      const error = ex as Error
-      console.warn(`⚠️ Skipped ${location}:`, error.message)
-    }
-  }
-}

package/src/generateTypeDoc.ts

@@ -1,174 +0,0 @@
-/* eslint-disable no-console */
-import { execSync } from 'node:child_process'
-import {
-  existsSync, mkdirSync, readdirSync,
-  readFileSync,
-} from 'node:fs'
-import { rm, writeFile } from 'node:fs/promises'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-/**
- * Generates inline TypeDoc markdown documentation
- * @param {string} packageLocation - The package location path
- * @param {string} sourceGlob - The glob pattern for source files
- * @returns {Promise<string>} A markdown string containing Reference
- */
-export async function generateTypeDoc(packageLocation: string, entryPoints: string[]) {
-  const __dirname = path.dirname(fileURLToPath(import.meta.url))
-  const tempDir = path.join(__dirname, '.temp-typedoc')
-
-  console.log(`Generating TypeDoc for package at: ${packageLocation}`)
-  for (const ep of entryPoints) {
-    console.log(`  - Entry point: ${path.resolve(packageLocation, ep)}`)
-  }
-
-  try {
-    // Create temp directory if it doesn't exist
-    if (!existsSync(tempDir)) {
-      mkdirSync(tempDir, { recursive: true })
-    }
-
-    // Create a minimal TypeDoc config for markdown generation
-    const typedocConfig = {
-      entryPoints: entryPoints.map(ep => path.resolve(packageLocation, ep)),
-      entryPointStrategy: 'expand',
-      out: tempDir,
-      plugin: ['typedoc-plugin-markdown'],
-      readme: 'none',
-      theme: 'markdown',
-      useCodeBlocks: true,
-      hidePageTitle: true,
-      githubPages: false,
-      hideGenerator: true,
-      hideBreadcrumbs: true,
-      disableSources: true,
-      skipErrorChecking: true,
-      excludeExternals: true,
-      excludeInternal: true,
-      excludePrivate: true,
-      sort: ['source-order'],
-    }
-
-    // Create temporary typedoc.json file
-    const typedocJsonPath = path.join(tempDir, 'typedoc.json')
-    await writeFile(typedocJsonPath, JSON.stringify(typedocConfig, null, 2))
-
-    // Run TypeDoc with the config
-    try {
-      console.log(`Generating docs for: ${packageLocation}`)
-      execSync(`npx typedoc --options ${typedocJsonPath}`, {
-        cwd: process.cwd(),
-        stdio: ['ignore', 'pipe', 'pipe'],
-      })
-    } catch (ex) {
-      const error = ex as Error
-      console.error(`TypeDoc error: ${error.message}`)
-      return '## Reference\n\nReference generation failed.'
-    }
-
-    // Combine all markdown files into a single document
-    return consolidateMarkdown(tempDir)
-  } catch (ex) {
-    const error = ex as Error
-    console.warn(`⚠️ Error generating TypeDoc for ${packageLocation}:`, error.message)
-    return '## Reference\n\nReference generation failed.'
-  } finally {
-    // Clean up the temp directory
-    try {
-      await rm(tempDir, { recursive: true, force: true })
-    } catch (ex) {
-      const error = ex as Error
-      console.warn('⚠️ Failed to clean up temp directory:', error.message)
-    }
-  }
-}
-
-/**
- * Consolidates all markdown files in the TypeDoc output directory into a single markdown string
- * @param {string} tempDir - The temporary directory containing TypeDoc output
- * @returns {string} - Consolidated markdown content
- */
-function consolidateMarkdown(tempDir: string) {
-  // Start with the main README content
-  let consolidated = '## Reference\n\n'
-
-  // Read main README.md first (if it exists)
-  const mainReadmePath = path.join(tempDir, 'README.md')
-  if (existsSync(mainReadmePath)) {
-    const mainContent = readFileSync(mainReadmePath, 'utf8')
-      .replace(/^---(.|\n)*?---\n/, '') // Remove front matter
-      .replace(/^# .+\n/, '') // Remove top-level header
-      .replaceAll(/\]\((.+?)\.md\)/g, '](#$1)') // Fix internal links to use anchors
-
-    consolidated += mainContent + '\n\n'
-  }
-
-  // Function to process a directory recursively
-  function processDirectory(dir: string, level = 0): string {
-    const indent = '  '.repeat(level)
-    let content = ''
-
-    try {
-      const items = readdirSync(dir, { withFileTypes: true })
-
-      // Process files first
-      for (const item of items) {
-        const itemPath = path.join(dir, item.name)
-
-        // Skip directories for now (process them later)
-        if (item.isDirectory()) continue
-
-        // Skip README.md (already processed) and files that aren't markdown
-        if (item.name === 'README.md' || !item.name.endsWith('.md')) continue
-
-        // Read file content
-        const fileContent = readFileSync(itemPath, 'utf8')
-          .replace(/^---(.|\n)*?---\n/, '') // Remove front matter
-
-        // Get the module name from filename (without extension)
-        const moduleName = item.name.replace('.md', '')
-
-        // Create a header with anchor
-        content += `\n\n${indent}### <a id="${moduleName}"></a>${moduleName}\n\n`
-
-        // Add file content with fixed links
-        content += fileContent
-          .replace(/^# .+\n/, '') // Remove top-level header
-          .replaceAll(/\]\((.+?)\.md\)/g, '](#$1)') // Fix internal links to use anchors
-      }
-
-      // Process subdirectories
-      for (const item of items) {
-        if (item.isDirectory()) {
-          const subDirPath = path.join(dir, item.name)
-          // Skip spec directories
-          if (item.name === 'spec' || item.name.includes('.spec')) continue
-
-          // Create a header for the directory
-          content += `\n\n${indent}### ${item.name}\n`
-
-          // Process the subdirectory
-          content += processDirectory(subDirPath, level + 1)
-        }
-      }
-    } catch (ex) {
-      const error = ex as Error
-      console.warn(`⚠️ Error processing directory ${dir}:`, error.message)
-    }
-
-    return content
-  }
-
-  // Process all files in the tempDir
-  consolidated += processDirectory(tempDir)
-
-  // Clean up the markdown (fix duplicate headers, etc.)
-  consolidated = consolidated
-    .replaceAll(/\n\n\n+/g, '\n\n') // Remove excess newlines
-    .replaceAll(/^#### /gm, '### ') // Adjust heading levels
-    .replaceAll(/^##### /gm, '#### ') // Adjust heading levels
-    .replaceAll(/^###### /gm, '##### ') // Adjust heading levels
-
-  return consolidated
-}

package/src/index.ts

@@ -1 +0,0 @@
-export * from './generateReadmeFiles.ts'