-
Notifications
You must be signed in to change notification settings - Fork 56
fix(jsx-email): clean check output + add --use-preview-props #378
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
charliecreates
wants to merge
1
commit into
next/v3
from
ai-371-charlie-fix-email-check-output-add-use-prev
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| import { mkdtemp, rm, writeFile } from 'node:fs/promises'; | ||
| import os from 'node:os'; | ||
| import { join } from 'node:path'; | ||
|
|
||
| import stripAnsi from 'strip-ansi'; | ||
|
|
||
| import { build } from '../../src/cli/commands/build.js'; | ||
| import { command, formatIssue, formatNotes, help } from '../../src/cli/commands/check.js'; | ||
|
|
||
| vi.mock('caniemail', () => ({ | ||
| caniemail: vi.fn(() => ({ success: true, issues: {} })), | ||
| groupIssues: vi.fn(() => []), | ||
| sortIssues: vi.fn(() => []) | ||
| })); | ||
|
|
||
| vi.mock('../../src/cli/commands/build.js', async () => { | ||
| const actual = (await vi.importActual('../../src/cli/commands/build.js')) as Record< | ||
| string, | ||
| unknown | ||
| >; | ||
|
|
||
| return { | ||
| ...actual, | ||
| buildTemplates: vi.fn(async ({ targetPath, buildOptions }: any) => [ | ||
| { | ||
| fileName: targetPath, | ||
| html: '<html></html>' | ||
| } | ||
| ]) | ||
| }; | ||
| }); | ||
|
|
||
| describe('email check', async () => { | ||
| test('help includes --use-preview-props', async () => { | ||
| expect(stripAnsi(help)).toContain('--use-preview-props'); | ||
| }); | ||
|
|
||
| test('formats notes and issues without placeholder/debug output', async () => { | ||
| const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {}); | ||
|
|
||
| const notesText = stripAnsi(formatNotes(['1. First', '2. Second'], ' ')); | ||
| expect(notesText).toContain('Notes:'); | ||
| expect(notesText).toContain('1. First'); | ||
| expect(notesText).toContain('2. Second'); | ||
| expect(notesText).not.toContain('asshole'); | ||
| expect(logSpy).not.toHaveBeenCalled(); | ||
|
|
||
| const formatted = stripAnsi( | ||
| formatIssue({ | ||
| issue: { | ||
| notes: ['First', 'Second'], | ||
| position: { start: { line: 3, column: 5 } }, | ||
| support: 'partial', | ||
| title: 'Some issue' | ||
| }, | ||
| clients: ['gmail.ios', 'outlook.windows'] | ||
| } as any) | ||
| ); | ||
|
|
||
| expect(formatted).toContain('warn'); | ||
| expect(formatted).toContain('3:5'); | ||
| expect(formatted).toContain('Some issue:'); | ||
| expect(formatted).toContain('Notes:'); | ||
| expect(formatted).toContain('1. First'); | ||
| expect(formatted).toContain('2. Second'); | ||
| expect(formatted).toContain('gmail.ios'); | ||
| expect(formatted).toContain('outlook.windows'); | ||
|
|
||
| logSpy.mockRestore(); | ||
| }); | ||
|
|
||
| test('passes --use-preview-props through to buildTemplates', async () => { | ||
| const dir = await mkdtemp(join(os.tmpdir(), 'jsx-email-check-')); | ||
| const templatePath = join(dir, 'template.tsx'); | ||
| await writeFile(templatePath, 'export const Template = () => null;', 'utf8'); | ||
|
|
||
| const { buildTemplates } = await import('../../src/cli/commands/build.js'); | ||
|
|
||
| await command({ usePreviewProps: true } as any, [templatePath]); | ||
|
|
||
| expect(buildTemplates).toHaveBeenCalledWith({ | ||
| buildOptions: { showStats: false, usePreviewProps: true, writeToFile: false }, | ||
| targetPath: templatePath | ||
| }); | ||
| }); | ||
|
|
||
| test('build uses previewProps when usePreviewProps is enabled', async () => { | ||
| const dir = await mkdtemp(join(process.cwd(), '.tmp-jsx-email-preview-props-')); | ||
| const out = join(dir, 'out'); | ||
| const modulePath = join(dir, 'template.mjs'); | ||
|
|
||
| await writeFile( | ||
| modulePath, | ||
| [ | ||
| "import React from 'react';", | ||
| "export const previewProps = { name: 'Bruce' };", | ||
| "export const Template = (props) => React.createElement('p', null, props.name ?? 'missing');", | ||
| '' | ||
| ].join('\n'), | ||
| 'utf8' | ||
| ); | ||
|
|
||
| const withPreviewProps = await build({ | ||
| argv: { out, usePreviewProps: true, writeToFile: false } as any, | ||
| path: modulePath, | ||
| sourceFile: modulePath | ||
| }); | ||
|
|
||
| const withoutPreviewProps = await build({ | ||
| argv: { out, props: '{"name":"Clark"}', writeToFile: false } as any, | ||
| path: modulePath, | ||
| sourceFile: modulePath | ||
| }); | ||
|
|
||
| expect(withPreviewProps.html).toContain('Bruce'); | ||
| expect(withoutPreviewProps.html).toContain('Clark'); | ||
|
|
||
| await rm(dir, { force: true, recursive: true }); | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new test suite creates temp directories, but cleanup is not guaranteed if an assertion fails (or if
build()throws). This can leave.tmp-jsx-email-preview-props-*directories behind in local runs/CI workspaces.Also, this test mixes
os.tmpdir()(good) andprocess.cwd()(riskier) for temp dirs; prefer one consistent approach (ideallyos.tmpdir()).Suggestion
Wrap temp-dir lifecycle in
try/finally(or useafterEach) and useos.tmpdir()consistently.Reply with "@CharlieHelps yes please" if you'd like me to add a commit with this change.