refactor: ignore non-ticket MD files

Author: AlecRust

knip.config.ts

@@ -9,8 +9,6 @@ const config: KnipConfig = {
 	ignoreBinaries: [
 		// Used for GitHub operations
 		'gh',
-		// Self-reference used in E2E tests
-		'branchpilot',
 	],
 }
 

src/utils/tickets.test.ts

@@ -101,6 +101,28 @@ This is a draft PR`)
 			expect(tickets[1]?.error).toContain('Missing required fields: branch')
 		})
 
+		it('skips non-ticket markdown files and unrelated frontmatter', async () => {
+			mockReaddir(['note.md', 'ticket.md', 'just-frontmatter.md'])
+			vi.mocked(fs.readFile)
+				// note.md: no frontmatter -> should be ignored
+				.mockResolvedValueOnce('This is a plain markdown note without frontmatter')
+				// ticket.md: valid ticket -> should be included
+				.mockResolvedValueOnce(`---\nbranch: feature/ok\nwhen: "2024-01-01T00:00:00"\n---\nBody`)
+				// just-frontmatter.md: has frontmatter but neither branch nor when -> should be ignored
+				.mockResolvedValueOnce(`---\ntitle: Just a document\nauthor: Someone\n---\nSome content`)
+
+			vi.mocked(git.getGitRoot).mockResolvedValue('/repo')
+			vi.mocked(config.loadRepoConfig).mockResolvedValue({})
+			vi.mocked(github.gh).mockResolvedValue('[]')
+			vi.mocked(github.getDefaultBranch).mockResolvedValue('main')
+			vi.mocked(git.hasUnmergedCommits).mockResolvedValue(true)
+
+			const tickets = await loadAllTickets(['/test/dir'], {}, logger)
+			expect(tickets).toHaveLength(1)
+			expect(tickets[0]?.branch).toBe('feature/ok')
+			expect(tickets[0]?.status === 'ready' || tickets[0]?.status === 'pending').toBe(true)
+		})
+
 		it('handles tickets without title and body', async () => {
 			mockReaddir(['minimal.md'])
 			vi.mocked(fs.readFile).mockResolvedValueOnce(`---

src/utils/tickets.ts

@@ -150,13 +150,20 @@ async function loadTicketsFromDirectory(dir: string, baseDir: string, logger: Lo
 
 			try {
 				const raw = await fs.readFile(file, 'utf8')
+				const hasFrontmatter = raw.trimStart().startsWith('---')
+				if (!hasFrontmatter) {
+					continue
+				}
 				const parsed = matter(raw)
+				const data = parsed.data || {}
+				if (!data.branch && !data.when) {
+					continue
+				}
+
 				const fm = TicketFrontSchema.safeParse(parsed.data)
 
 				if (!fm.success) {
 					const missingFields: string[] = []
-					const data = parsed.data || {}
-
 					if (!data.branch) missingFields.push('branch')
 					if (!data.when) missingFields.push('when')
 

tests/e2e/cli.test.ts

@@ -1,5 +1,5 @@
 import { spawn } from 'node:child_process'
-import { existsSync } from 'node:fs'
+import fsp from 'node:fs/promises'
 import os from 'node:os'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
@@ -8,10 +8,21 @@ import { beforeAll, describe, expect, it } from 'vitest'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const cliPath = path.join(__dirname, '../../dist/cli.mjs')
+let tarballPath: string | null = null
+let packTmpDir: string | null = null
 
 beforeAll(async () => {
-	if (!existsSync(cliPath)) {
-		await execa('npm', ['run', 'build'], { cwd: path.join(__dirname, '../..') })
+	await execa('npm', ['run', 'build'], { cwd: path.join(__dirname, '../..') })
+	packTmpDir = await fsp.mkdtemp(path.join(os.tmpdir(), 'branchpilot-pack-'))
+	const { stdout: packOut } = await execa('npm', ['pack', '--silent', path.join(__dirname, '../..')], {
+		cwd: packTmpDir,
+	})
+	tarballPath = path.join(packTmpDir, packOut.trim())
+})
+
+afterAll(async () => {
+	if (packTmpDir) {
+		await fsp.rm(packTmpDir, { recursive: true, force: true })
 	}
 })
 
@@ -136,7 +147,8 @@ describe('CLI', () => {
 
 	describe('npx execution', () => {
 		it('works with npx for version command', async () => {
-			const { stdout, exitCode } = await execa('npx', ['--yes', 'branchpilot', '--version'], {
+			const pkgArg = tarballPath ?? 'branchpilot'
+			const { stdout, exitCode } = await execa('npx', ['--yes', '--package', pkgArg, 'branchpilot', '--version'], {
 				env: { ...process.env, NODE_ENV: 'test' },
 			})
 			expect(exitCode).toBe(0)
@@ -145,9 +157,14 @@ describe('CLI', () => {
 
 		it('works with npx for list command', async () => {
 			const tempDir = os.tmpdir()
-			const { stdout, exitCode } = await execa('npx', ['--yes', 'branchpilot', 'list', '--dir', tempDir], {
-				env: { ...process.env, NODE_ENV: 'test' },
-			})
+			const pkgArg = tarballPath ?? 'branchpilot'
+			const { stdout, exitCode } = await execa(
+				'npx',
+				['--yes', '--package', pkgArg, 'branchpilot', 'list', '--dir', tempDir],
+				{
+					env: { ...process.env, NODE_ENV: 'test' },
+				},
+			)
 			expect(exitCode).toBe(0)
 			expect(stdout).toContain('No tickets found')
 		}, 20000)