@vibecuting/component-project-helper 0.1.12 → 0.1.14

package/README.md

@@ -10,7 +10,7 @@ NPM 地址：
 
 - 作为可发布的 npm 包承载组件工程辅助逻辑。
 - 提供组件注解、schema、发现器、Markdown 生成和安装期生命周期逻辑。
-- 安装时扫描 `src/components/**/*.tsx`、`src/video/chapters/**/*.tsx` 以及 `node_modules/@vibecuting/*/src/**/*.tsx`，把组件元数据生成到 `.agents/skills/project-allow-component/components/`。
+- 安装时会优先把当前工程识别为包含 `src/components` 或 `src/video/chapters` 的独立项目，再扫描 `src/components/**/*.tsx`、`src/video/chapters/**/*.tsx` 以及 `node_modules/@vibecuting/*/src/**/*.tsx`，把组件元数据生成到 `.agents/skills/project-allow-component/components/`。
 - 通过 `postinstall` / `preuninstall` 维护生成文件和清理清单。
 - 安装时会给宿主工程的 `package.json` 补上 `update-component-skills`，它会调用同一套 `postinstall` 逻辑。
 - 宿主工程也可以直接运行 `pnpm update-component-skills` 手动刷新同一套生成结果。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibecuting/component-project-helper",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
   "main": "./src/index.ts",

package/scripts/discover-components.mjs

@@ -85,6 +85,10 @@ async function collectComponentSourceFiles(directory) {
       continue
     }
 
+    if (entry.name.includes('.test.') || entry.name.includes('.spec.')) {
+      continue
+    }
+
     if (entry.name.endsWith('.d.ts')) {
       continue
     }

package/scripts/postinstall.mjs

@@ -11,6 +11,16 @@ import {
 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 })
 }
@@ -34,14 +44,16 @@ export async function runComponentProjectPostinstall(projectRoot = resolveCompon
   const manifestPath = resolveComponentProjectGeneratedManifestPath(projectRoot)
   const components = await discoverComponentProjectComponents(projectRoot)
 
-  console.log('[component-project-helper] postinstall start')
-  console.log(`[component-project-helper] project root: ${projectRoot}`)
-  console.log(`[component-project-helper] docs dir: ${docsDir}`)
-  console.log(`[component-project-helper] manifest path: ${manifestPath}`)
+  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(
-    `[component-project-helper] discovered ${components.length} component(s): ${
+    color.green(
+      `[component-project-helper] discovered ${components.length} component(s): ${
       components.map((component) => component.name).join(', ') || '(none)'
-    }`,
+      }`,
+    ),
   )
 
   await ensureDirectory(docsDir)
@@ -52,19 +64,23 @@ export async function runComponentProjectPostinstall(projectRoot = resolveCompon
     await fs.writeFile(filePath, renderComponentProjectMarkdown(component), 'utf8')
     files.push(filePath)
     console.log(
-      `[component-project-helper] wrote ${path.relative(projectRoot, filePath)} <- ${component.sourceFile}`,
+      color.green(
+        `[component-project-helper] wrote ${path.relative(projectRoot, filePath)} <- ${component.sourceFile}`,
+      ),
     )
   }
 
   console.log(
-    `[component-project-helper] cleaning stale docs relative to manifest ${path.relative(
+    color.yellow(
+      `[component-project-helper] cleaning stale docs relative to manifest ${path.relative(
       projectRoot,
       manifestPath,
-    )}`,
+      )}`,
+    ),
   )
   await removeStaleGeneratedFiles(manifestPath, files)
   await ensureComponentProjectSkillsScript(projectRoot)
-  console.log('[component-project-helper] ensured update-component-skills script')
+  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({
@@ -75,7 +91,9 @@ export async function runComponentProjectPostinstall(projectRoot = resolveCompon
   })
   await fs.writeFile(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`, 'utf8')
   console.log(
-    `[component-project-helper] postinstall complete, manifest files: ${files.length}`,
+    color.cyan(
+      `[component-project-helper] postinstall complete, manifest files: ${files.length}`,
+    ),
   )
 }
 

package/scripts/runtime-root.mjs

@@ -3,7 +3,10 @@ import fs from 'node:fs'
 import process from 'node:process'
 
 function hasComponentProjectSourceDir(directory) {
-  return fs.existsSync(path.join(directory, 'src', 'components'))
+  return (
+    fs.existsSync(path.join(directory, 'src', 'components')) ||
+    fs.existsSync(path.join(directory, 'src', 'video', 'chapters'))
+  )
 }
 
 function findComponentProjectInstallRoot(startDirectory) {

package/src/discovery/index.test.ts

@@ -151,3 +151,36 @@ test('discovers decorated components from installed video-project-core', async (
     },
   ])
 })
+
+test('ignores test files from installed packages', async () => {
+  const projectRoot = await fs.mkdtemp(path.join(tmpdir(), 'component-project-helper-tests-'))
+  const packageTestDir = path.join(
+    projectRoot,
+    'node_modules',
+    '@vibecuting',
+    'video-project-helper',
+    'src',
+  )
+  await fs.mkdir(packageTestDir, { recursive: true })
+
+  await fs.writeFile(
+    path.join(packageTestDir, 'index.test.ts'),
+    `
+      @VideoComponent({
+        name: 'ShouldBeIgnored',
+        description: 'This fixture lives in a test file and must not be discovered',
+        sourceFile: 'node_modules/@vibecuting/video-project-helper/src/index.test.ts',
+        aspectRatio: '16:9',
+        sceneType: 'scene',
+        tags: ['test'],
+        propsTypeName: 'ShouldBeIgnoredProps',
+      })
+      export const ShouldBeIgnored = () => null
+    `,
+    'utf8',
+  )
+
+  const discovered = await discoverComponentProjectComponents(projectRoot)
+
+  expect(discovered).toEqual([])
+})

package/src/discovery/index.ts

@@ -32,6 +32,10 @@ async function collectComponentSourceFiles(directory: string): Promise<string[]>
       continue
     }
 
+    if (entry.name.includes('.test.') || entry.name.includes('.spec.')) {
+      continue
+    }
+
     if (entry.name.endsWith('.d.ts')) {
       continue
     }

package/src/lifecycle/postinstall.ts

@@ -12,6 +12,16 @@ import {
 } 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 })
 }
@@ -40,14 +50,16 @@ export async function runComponentProjectPostinstall(
   const manifestPath = resolveComponentProjectGeneratedManifestPath(projectRoot)
   const components = await discoverComponentProjectComponents(projectRoot)
 
-  console.log('[component-project-helper] postinstall start')
-  console.log(`[component-project-helper] project root: ${projectRoot}`)
-  console.log(`[component-project-helper] docs dir: ${docsDir}`)
-  console.log(`[component-project-helper] manifest path: ${manifestPath}`)
+  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(
-    `[component-project-helper] discovered ${components.length} component(s): ${
+    color.green(
+      `[component-project-helper] discovered ${components.length} component(s): ${
       components.map((component) => component.name).join(', ') || '(none)'
-    }`,
+      }`,
+    ),
   )
 
   await ensureDirectory(docsDir)
@@ -60,19 +72,23 @@ export async function runComponentProjectPostinstall(
     await fs.writeFile(filePath, markdown, 'utf8')
     files.push(filePath)
     console.log(
-      `[component-project-helper] wrote ${path.relative(projectRoot, filePath)} <- ${component.sourceFile}`,
+      color.green(
+        `[component-project-helper] wrote ${path.relative(projectRoot, filePath)} <- ${component.sourceFile}`,
+      ),
     )
   }
 
   console.log(
-    `[component-project-helper] cleaning stale docs relative to manifest ${path.relative(
+    color.yellow(
+      `[component-project-helper] cleaning stale docs relative to manifest ${path.relative(
       projectRoot,
       manifestPath,
-    )}`,
+      )}`,
+    ),
   )
   await removeStaleGeneratedFiles(manifestPath, files)
   await ensureComponentProjectSkillsScript(projectRoot)
-  console.log('[component-project-helper] ensured update-component-skills script')
+  console.log(color.green('[component-project-helper] ensured update-component-skills script'))
 
   const manifest = ComponentProjectGeneratedManifestSchema.parse({
     projectRoot,
@@ -83,7 +99,9 @@ export async function runComponentProjectPostinstall(
 
   await fs.writeFile(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`, 'utf8')
   console.log(
-    `[component-project-helper] postinstall complete, manifest files: ${files.length}`,
+    color.cyan(
+      `[component-project-helper] postinstall complete, manifest files: ${files.length}`,
+    ),
   )
 }
 

package/src/runtime/index.test.ts

@@ -0,0 +1,26 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { tmpdir } from 'node:os'
+import { afterEach, expect, test, vi } from 'vitest'
+
+import { resolveComponentProjectInstallRoot } from './index'
+
+afterEach(() => {
+  vi.unstubAllEnvs()
+  vi.restoreAllMocks()
+})
+
+test('resolves a video project template root before a parent monorepo root', async () => {
+  const workspaceRoot = await fs.mkdtemp(path.join(tmpdir(), 'component-project-helper-runtime-'))
+  const monorepoRoot = path.join(workspaceRoot, 'repo')
+  const videoProjectRoot = path.join(monorepoRoot, 'project-templates', 'video-project')
+
+  await fs.mkdir(path.join(monorepoRoot, 'src', 'components'), { recursive: true })
+  await fs.mkdir(path.join(videoProjectRoot, 'src', 'video', 'chapters'), { recursive: true })
+
+  vi.stubEnv('INIT_CWD', path.join(videoProjectRoot, 'src', 'video'))
+  vi.stubEnv('npm_config_local_prefix', '')
+  vi.spyOn(process, 'cwd').mockReturnValue(path.join(videoProjectRoot, 'src', 'video'))
+
+  expect(resolveComponentProjectInstallRoot()).toBe(videoProjectRoot)
+})

package/src/runtime/index.ts

@@ -3,7 +3,10 @@ import fs from 'node:fs'
 import process from 'node:process'
 
 function hasComponentProjectSourceDir(directory: string): boolean {
-  return fs.existsSync(path.join(directory, 'src', 'components'))
+  return (
+    fs.existsSync(path.join(directory, 'src', 'components')) ||
+    fs.existsSync(path.join(directory, 'src', 'video', 'chapters'))
+  )
 }
 
 function findComponentProjectInstallRoot(startDirectory: string): string | undefined {