@vibecuting/component-project-helper 0.1.16 → 0.1.17

package/scripts/postinstall.mjs

@@ -1,112 +0,0 @@
-import fs from 'node:fs/promises'
-import path from 'node:path'
-
-import { discoverComponentProjectComponents } from './discover-components.mjs'
-import { ensureComponentProjectSkillsScript } from './package-json.mjs'
-import {
-  resolveComponentProjectGeneratedDocsDir,
-  resolveComponentProjectGeneratedManifestPath,
-  resolveComponentProjectInstallRoot,
-} from './runtime-root.mjs'
-import { renderComponentProjectMarkdown } from './render-markdown.mjs'
-import { ComponentProjectGeneratedManifestSchema } from './schemas.mjs'
-
-const supportsColor =
-  Boolean(process.stdout.isTTY) && process.env.NO_COLOR !== '1' && process.env.CI !== 'true'
-
-const color = {
-  cyan: (value) => (supportsColor ? `\u001b[36m${value}\u001b[0m` : value),
-  green: (value) => (supportsColor ? `\u001b[32m${value}\u001b[0m` : value),
-  yellow: (value) => (supportsColor ? `\u001b[33m${value}\u001b[0m` : value),
-  dim: (value) => (supportsColor ? `\u001b[2m${value}\u001b[0m` : value),
-}
-
-async function ensureDirectory(dir) {
-  await fs.mkdir(dir, { recursive: true })
-}
-
-async function removeStaleGeneratedFiles(manifestPath, nextFiles) {
-  try {
-    const previous = ComponentProjectGeneratedManifestSchema.parse(
-      JSON.parse(await fs.readFile(manifestPath, 'utf8')),
-    )
-    const staleFiles = previous.files.filter((filePath) => !nextFiles.includes(filePath))
-    await Promise.all(staleFiles.map((filePath) => fs.rm(filePath, { force: true })))
-  } catch (error) {
-    if (error?.code !== 'ENOENT') {
-      throw error
-    }
-  }
-}
-
-export async function runComponentProjectPostinstall(projectRoot = resolveComponentProjectInstallRoot()) {
-  const docsDir = resolveComponentProjectGeneratedDocsDir(projectRoot)
-  const manifestPath = resolveComponentProjectGeneratedManifestPath(projectRoot)
-  const components = await discoverComponentProjectComponents(projectRoot)
-
-  console.log(color.cyan('[component-project-helper] postinstall start'))
-  console.log(color.dim(`[component-project-helper] project root: ${projectRoot}`))
-  console.log(color.dim(`[component-project-helper] docs dir: ${docsDir}`))
-  console.log(color.dim(`[component-project-helper] manifest path: ${manifestPath}`))
-  console.log(
-    color.green(
-      `[component-project-helper] discovered ${components.length} component(s): ${
-      components.map((component) => component.name).join(', ') || '(none)'
-      }`,
-    ),
-  )
-
-  await ensureDirectory(docsDir)
-
-  const files = []
-  for (const component of components) {
-    const filePath = path.join(docsDir, `${component.name}.md`)
-    await fs.writeFile(filePath, renderComponentProjectMarkdown(component), 'utf8')
-    files.push(filePath)
-    console.log(
-      color.green(
-        `[component-project-helper] wrote ${path.relative(projectRoot, filePath)} <- ${component.sourceFile}`,
-      ),
-    )
-  }
-
-  console.log(
-    color.yellow(
-      `[component-project-helper] cleaning stale docs relative to manifest ${path.relative(
-      projectRoot,
-      manifestPath,
-      )}`,
-    ),
-  )
-  await removeStaleGeneratedFiles(manifestPath, files)
-  await ensureComponentProjectSkillsScript(projectRoot)
-  console.log(color.green('[component-project-helper] ensured update-component-skills script'))
-  console.log('[component-project-helper] ensured stale docs cleaned')
-
-  const manifest = ComponentProjectGeneratedManifestSchema.parse({
-    projectRoot,
-    generatedAt: new Date().toISOString(),
-    docsDir,
-    files,
-  })
-  await fs.writeFile(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`, 'utf8')
-  console.log(
-    color.cyan(
-      `[component-project-helper] postinstall complete, manifest files: ${files.length}`,
-    ),
-  )
-}
-
-async function isDirectRun() {
-  if (!process.argv[1]) {
-    return false
-  }
-
-  const entryPath = await fs.realpath(process.argv[1])
-  const currentPath = await fs.realpath(new URL(import.meta.url).pathname)
-  return entryPath === currentPath
-}
-
-if (await isDirectRun()) {
-  await runComponentProjectPostinstall()
-}

package/scripts/preuninstall.mjs

@@ -1,45 +0,0 @@
-import fs from 'node:fs/promises'
-import { fileURLToPath } from 'node:url'
-
-import { resolveComponentProjectGeneratedManifestPath } from './runtime-root.mjs'
-import { ComponentProjectGeneratedManifestSchema } from './schemas.mjs'
-import { removeComponentProjectSkillsScript } from './package-json.mjs'
-
-export async function runComponentProjectPreuninstall(
-  projectRoot = process.env.INIT_CWD ?? process.env.npm_config_local_prefix ?? process.cwd(),
-) {
-  const manifestPath = resolveComponentProjectGeneratedManifestPath(projectRoot)
-
-  try {
-    const manifest = ComponentProjectGeneratedManifestSchema.parse(
-      JSON.parse(await fs.readFile(manifestPath, 'utf8')),
-    )
-
-    for (const filePath of manifest.files) {
-      await fs.rm(filePath, { force: true })
-    }
-
-    await fs.rm(manifestPath, { force: true })
-    await fs.rm(manifest.docsDir, { recursive: true, force: true })
-  } catch (error) {
-    if (error?.code !== 'ENOENT') {
-      throw error
-    }
-  }
-
-  await removeComponentProjectSkillsScript(projectRoot)
-}
-
-async function isDirectRun() {
-  if (!process.argv[1]) {
-    return false
-  }
-
-  const entryPath = await fs.realpath(process.argv[1])
-  const currentPath = await fs.realpath(fileURLToPath(import.meta.url))
-  return entryPath === currentPath
-}
-
-if (await isDirectRun()) {
-  await runComponentProjectPreuninstall()
-}

package/scripts/render-markdown.mjs

@@ -1,36 +0,0 @@
-import { ComponentProjectComponentMetadataSchema } from './schemas.mjs'
-
-function escapeInline(value) {
-  return value.replaceAll('`', '\\`')
-}
-
-export function renderComponentProjectMarkdown(input) {
-  const metadata = ComponentProjectComponentMetadataSchema.parse(input)
-  const tags = metadata.tags.length > 0 ? metadata.tags : ['component']
-
-  return [
-    '---',
-    `name: ${metadata.name}`,
-    `description: ${metadata.description}`,
-    `sourceFile: ${metadata.sourceFile}`,
-    `aspectRatio: ${metadata.aspectRatio}`,
-    `sceneType: ${metadata.sceneType ?? ''}`,
-    `propsTypeName: ${metadata.propsTypeName ?? ''}`,
-    'tags:',
-    ...tags.map((tag) => `  - ${tag}`),
-    '---',
-    '',
-    `# ${metadata.name}`,
-    '',
-    metadata.description,
-    '',
-    '## Metadata',
-    '',
-    `- Source file: \`${escapeInline(metadata.sourceFile)}\``,
-    `- Aspect ratio: \`${escapeInline(metadata.aspectRatio)}\``,
-    `- Scene type: \`${escapeInline(metadata.sceneType ?? 'unknown')}\``,
-    `- Props type: \`${escapeInline(metadata.propsTypeName ?? 'unknown')}\``,
-    `- Tags: ${tags.map((tag) => `\`${escapeInline(tag)}\``).join(', ')}`,
-    '',
-  ].join('\n')
-}

package/src/lifecycle/package-json.ts

@@ -1,63 +0,0 @@
-import fs from 'node:fs/promises'
-import path from 'node:path'
-
-export const componentProjectSkillsScriptName = 'update-component-skills' as const
-export const componentProjectSkillsScriptCommand =
-  'node ./node_modules/@vibecuting/component-project-helper/scripts/postinstall.mjs' as const
-
-async function readPackageJson(projectRoot: string): Promise<Record<string, unknown>> {
-  const packageJsonPath = path.join(projectRoot, 'package.json')
-  try {
-    return JSON.parse(await fs.readFile(packageJsonPath, 'utf8'))
-  } catch (error) {
-    if ((error as NodeJS.ErrnoException).code === 'ENOENT') {
-      return undefined as never
-    }
-
-    throw error
-  }
-}
-
-async function writePackageJson(
-  projectRoot: string,
-  packageJson: Record<string, unknown>,
-): Promise<void> {
-  const packageJsonPath = path.join(projectRoot, 'package.json')
-  await fs.writeFile(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`, 'utf8')
-}
-
-export async function ensureComponentProjectSkillsScript(projectRoot: string): Promise<void> {
-  const packageJson = await readPackageJson(projectRoot)
-  if (!packageJson) {
-    return
-  }
-
-  const scripts = (packageJson.scripts as Record<string, string> | undefined) ?? {}
-
-  if (scripts[componentProjectSkillsScriptName] !== componentProjectSkillsScriptCommand) {
-    packageJson.scripts = {
-      ...scripts,
-      [componentProjectSkillsScriptName]: componentProjectSkillsScriptCommand,
-    }
-    await writePackageJson(projectRoot, packageJson)
-  }
-}
-
-export async function removeComponentProjectSkillsScript(projectRoot: string): Promise<void> {
-  const packageJson = await readPackageJson(projectRoot)
-  if (!packageJson) {
-    return
-  }
-
-  const scripts = (packageJson.scripts as Record<string, string> | undefined) ?? {}
-
-  if (scripts[componentProjectSkillsScriptName] !== componentProjectSkillsScriptCommand) {
-    return
-  }
-
-  const nextScripts = { ...scripts }
-  delete nextScripts[componentProjectSkillsScriptName]
-  packageJson.scripts = nextScripts
-
-  await writePackageJson(projectRoot, packageJson)
-}

package/src/lifecycle/postinstall.test.ts

@@ -1,114 +0,0 @@
-import fs from 'node:fs/promises'
-import path from 'node:path'
-import { tmpdir } from 'node:os'
-
-import { expect, test } from 'vitest'
-
-import { runComponentProjectPostinstall } from './postinstall'
-import { runComponentProjectPreuninstall } from './preuninstall'
-
-async function createFixtureProjectRoot(): Promise<string> {
-  const projectRoot = await fs.mkdtemp(path.join(tmpdir(), 'component-project-helper-'))
-  await fs.mkdir(path.join(projectRoot, 'src', 'components', 'nested'), { recursive: true })
-  await fs.writeFile(
-    path.join(projectRoot, 'package.json'),
-    JSON.stringify(
-      {
-        name: 'component-project-fixture',
-        private: true,
-        scripts: {
-          build: 'echo build',
-        },
-      },
-      null,
-      2,
-    ),
-    'utf8',
-  )
-
-  await fs.writeFile(
-    path.join(projectRoot, 'src', 'components', 'SceneFrame.tsx'),
-    `
-      @VideoComponent({
-        name: 'SceneFrame',
-        description: 'Wraps the scene content in a consistent frame',
-        sourceFile: 'src/components/SceneFrame.tsx',
-        aspectRatio: '16:9',
-        sceneType: 'scene',
-        tags: ['layout', 'frame'],
-        propsTypeName: 'SceneFrameProps',
-      })
-      export const SceneFrame = () => null
-`,
-    'utf8',
-  )
-
-  await fs.writeFile(
-    path.join(projectRoot, 'src', 'components', 'nested', 'SceneTitle.tsx'),
-    `
-      @VideoComponent({
-        name: 'SceneTitle',
-        description: 'Renders the title block for scene hero content',
-        sourceFile: 'src/components/nested/SceneTitle.tsx',
-        aspectRatio: '9:16',
-        sceneType: 'intro',
-        tags: ['title'],
-        propsTypeName: 'SceneTitleProps',
-      })
-      export const SceneTitle = () => null
-`,
-    'utf8',
-  )
-
-  return projectRoot
-}
-
-test('postinstall generates markdown and preuninstall removes it', async () => {
-  const projectRoot = await createFixtureProjectRoot()
-  const docsDir = path.join(
-    projectRoot,
-    '.agents',
-    'skills',
-    'project-allow-component',
-    'components',
-  )
-  const manifestPath = path.join(
-    projectRoot,
-    '.agents',
-    'skills',
-    'project-allow-component',
-    'component-project-helper.manifest.json',
-  )
-
-  await runComponentProjectPostinstall(projectRoot)
-
-  await expect(fs.stat(path.join(docsDir, 'SceneFrame.md'))).resolves.toBeDefined()
-  await expect(fs.stat(path.join(docsDir, 'SceneTitle.md'))).resolves.toBeDefined()
-  await expect(fs.stat(manifestPath)).resolves.toBeDefined()
-  await expect(await fs.readFile(path.join(docsDir, 'SceneTitle.md'), 'utf8')).toContain(
-    'src/components/nested/SceneTitle.tsx',
-  )
-  await expect(await fs.readFile(path.join(docsDir, 'SceneTitle.md'), 'utf8')).toContain(
-    '9:16',
-  )
-  await expect(
-    JSON.parse(await fs.readFile(path.join(projectRoot, 'package.json'), 'utf8')).scripts[
-      'update-component-skills'
-    ],
-  ).toBe('node ./node_modules/@vibecuting/component-project-helper/scripts/postinstall.mjs')
-
-  await runComponentProjectPreuninstall(projectRoot)
-
-  await expect(fs.stat(path.join(docsDir, 'SceneFrame.md'))).rejects.toMatchObject({
-    code: 'ENOENT',
-  })
-  await expect(fs.stat(path.join(docsDir, 'SceneTitle.md'))).rejects.toMatchObject({
-    code: 'ENOENT',
-  })
-  await expect(fs.stat(manifestPath)).rejects.toMatchObject({ code: 'ENOENT' })
-  await expect(
-    JSON.parse(await fs.readFile(path.join(projectRoot, 'package.json'), 'utf8')).scripts[
-      'update-component-skills'
-    ],
-  ).toBeUndefined()
-})

package/src/lifecycle/postinstall.ts

@@ -1,127 +0,0 @@
-import fs from 'node:fs/promises'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-import { ComponentProjectGeneratedManifestSchema } from '../schemas'
-import { discoverComponentProjectComponents } from '../discovery'
-import { renderComponentProjectMarkdown } from '../markdown'
-import {
-  resolveComponentProjectGeneratedDocsDir,
-  resolveComponentProjectGeneratedManifestPath,
-  resolveComponentProjectInstallRoot,
-} from '../runtime'
-import { ensureComponentProjectSkillsScript } from './package-json'
-
-const supportsColor =
-  Boolean(process.stdout.isTTY) && process.env.NO_COLOR !== '1' && process.env.CI !== 'true'
-
-const color = {
-  cyan: (value: string): string => (supportsColor ? `\u001b[36m${value}\u001b[0m` : value),
-  green: (value: string): string => (supportsColor ? `\u001b[32m${value}\u001b[0m` : value),
-  yellow: (value: string): string => (supportsColor ? `\u001b[33m${value}\u001b[0m` : value),
-  dim: (value: string): string => (supportsColor ? `\u001b[2m${value}\u001b[0m` : value),
-}
-
-async function ensureDirectory(dir: string): Promise<void> {
-  await fs.mkdir(dir, { recursive: true })
-}
-
-async function removeStaleGeneratedFiles(
-  manifestPath: string,
-  nextFiles: string[],
-): Promise<void> {
-  try {
-    const previous = ComponentProjectGeneratedManifestSchema.parse(
-      JSON.parse(await fs.readFile(manifestPath, 'utf8')),
-    )
-    const staleFiles = previous.files.filter((filePath) => !nextFiles.includes(filePath))
-    await Promise.all(staleFiles.map((filePath) => fs.rm(filePath, { force: true })))
-  } catch (error) {
-    if ((error as NodeJS.ErrnoException).code !== 'ENOENT') {
-      throw error
-    }
-  }
-}
-
-export async function runComponentProjectPostinstall(
-  projectRoot = resolveComponentProjectInstallRoot(),
-): Promise<void> {
-  const docsDir = resolveComponentProjectGeneratedDocsDir(projectRoot)
-  const manifestPath = resolveComponentProjectGeneratedManifestPath(projectRoot)
-  const components = await discoverComponentProjectComponents(projectRoot)
-
-  console.log(color.cyan('[component-project-helper] postinstall start'))
-  console.log(color.dim(`[component-project-helper] project root: ${projectRoot}`))
-  console.log(color.dim(`[component-project-helper] docs dir: ${docsDir}`))
-  console.log(color.dim(`[component-project-helper] manifest path: ${manifestPath}`))
-  console.log(
-    color.green(
-      `[component-project-helper] discovered ${components.length} component(s): ${
-      components.map((component) => component.name).join(', ') || '(none)'
-      }`,
-    ),
-  )
-
-  await ensureDirectory(docsDir)
-
-  const files: string[] = []
-
-  for (const component of components) {
-    const filePath = path.join(docsDir, `${component.name}.md`)
-    const markdown = renderComponentProjectMarkdown(component)
-    await fs.writeFile(filePath, markdown, 'utf8')
-    files.push(filePath)
-    console.log(
-      color.green(
-        `[component-project-helper] wrote ${path.relative(projectRoot, filePath)} <- ${component.sourceFile}`,
-      ),
-    )
-  }
-
-  console.log(
-    color.yellow(
-      `[component-project-helper] cleaning stale docs relative to manifest ${path.relative(
-      projectRoot,
-      manifestPath,
-      )}`,
-    ),
-  )
-  await removeStaleGeneratedFiles(manifestPath, files)
-  await ensureComponentProjectSkillsScript(projectRoot)
-  console.log(color.green('[component-project-helper] ensured update-component-skills script'))
-
-  const manifest = ComponentProjectGeneratedManifestSchema.parse({
-    projectRoot,
-    generatedAt: new Date().toISOString(),
-    docsDir,
-    files,
-  })
-
-  await fs.writeFile(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`, 'utf8')
-  console.log(
-    color.cyan(
-      `[component-project-helper] postinstall complete, manifest files: ${files.length}`,
-    ),
-  )
-}
-
-async function isDirectRun(): Promise<boolean> {
-  if (!process.argv[1]) {
-    return false
-  }
-
-  const [entryPath, currentPath] = await Promise.all([
-    fs.realpath(process.argv[1]),
-    fs.realpath(fileURLToPath(import.meta.url)),
-  ])
-
-  return entryPath === currentPath
-}
-
-async function main(): Promise<void> {
-  await runComponentProjectPostinstall()
-}
-
-if (await isDirectRun()) {
-  await main()
-}

package/src/lifecycle/preuninstall.ts

@@ -1,54 +0,0 @@
-import fs from 'node:fs/promises'
-import { fileURLToPath } from 'node:url'
-
-import { ComponentProjectGeneratedManifestSchema } from '../schemas'
-import { resolveComponentProjectGeneratedManifestPath } from '../runtime'
-import { removeComponentProjectSkillsScript } from './package-json'
-
-export async function runComponentProjectPreuninstall(
-  projectRoot = process.env.INIT_CWD ??
-    process.env.npm_config_local_prefix ??
-    process.cwd(),
-): Promise<void> {
-  const manifestPath = resolveComponentProjectGeneratedManifestPath(projectRoot)
-
-  try {
-    const manifest = ComponentProjectGeneratedManifestSchema.parse(
-      JSON.parse(await fs.readFile(manifestPath, 'utf8')),
-    )
-
-    for (const filePath of manifest.files) {
-      await fs.rm(filePath, { force: true })
-    }
-
-    await fs.rm(manifestPath, { force: true })
-    await fs.rm(manifest.docsDir, { recursive: true, force: true })
-  } catch (error) {
-    if ((error as NodeJS.ErrnoException).code !== 'ENOENT') {
-      throw error
-    }
-  }
-
-  await removeComponentProjectSkillsScript(projectRoot)
-}
-
-async function main(): Promise<void> {
-  await runComponentProjectPreuninstall()
-}
-
-async function isDirectRun(): Promise<boolean> {
-  if (!process.argv[1]) {
-    return false
-  }
-
-  const [entryPath, currentPath] = await Promise.all([
-    fs.realpath(process.argv[1]),
-    fs.realpath(fileURLToPath(import.meta.url)),
-  ])
-
-  return entryPath === currentPath
-}
-
-if (await isDirectRun()) {
-  await main()
-}

package/src/markdown/index.test.ts

@@ -1,20 +0,0 @@
-import { expect, test } from 'vitest'
-
-import { renderComponentProjectMarkdown } from './index'
-
-test('renders markdown with metadata fields', () => {
-  const markdown = renderComponentProjectMarkdown({
-    name: 'SceneFrame',
-    description: 'Wraps the scene content in a consistent frame',
-    sourceFile: 'src/components/SceneFrame.tsx',
-    aspectRatio: '16:9',
-    sceneType: 'scene',
-    tags: ['layout', 'frame'],
-    propsTypeName: 'SceneFrameProps',
-  })
-
-  expect(markdown).toContain('# SceneFrame')
-  expect(markdown).toContain('SceneFrameProps')
-  expect(markdown).toContain('src/components/SceneFrame.tsx')
-  expect(markdown).toContain('16:9')
-})

package/src/markdown/index.ts

@@ -1,43 +0,0 @@
-import {
-  ComponentProjectComponentMetadataSchema,
-  type ComponentProjectComponentMetadata,
-} from '../schemas'
-
-export type ComponentProjectMarkdownDocument = ComponentProjectComponentMetadata
-
-function escapeInline(value: string): string {
-  return value.replaceAll('`', '\\`')
-}
-
-export function renderComponentProjectMarkdown(
-  input: ComponentProjectMarkdownDocument,
-): string {
-  const metadata = ComponentProjectComponentMetadataSchema.parse(input)
-  const tags = metadata.tags.length > 0 ? metadata.tags : ['component']
-
-  return [
-    '---',
-    `name: ${metadata.name}`,
-    `description: ${metadata.description}`,
-    `sourceFile: ${metadata.sourceFile}`,
-    `aspectRatio: ${metadata.aspectRatio}`,
-    `sceneType: ${metadata.sceneType ?? ''}`,
-    `propsTypeName: ${metadata.propsTypeName ?? ''}`,
-    'tags:',
-    ...tags.map((tag) => `  - ${tag}`),
-    '---',
-    '',
-    `# ${metadata.name}`,
-    '',
-    metadata.description,
-    '',
-    '## Metadata',
-    '',
-    `- Source file: \`${escapeInline(metadata.sourceFile)}\``,
-    `- Aspect ratio: \`${escapeInline(metadata.aspectRatio)}\``,
-    `- Scene type: \`${escapeInline(metadata.sceneType ?? 'unknown')}\``,
-    `- Props type: \`${escapeInline(metadata.propsTypeName ?? 'unknown')}\``,
-    `- Tags: ${tags.map((tag) => `\`${escapeInline(tag)}\``).join(', ')}`,
-    '',
-  ].join('\n')
-}