mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-01-26 19:09:52 +00:00

Files

Alexander Brown 1b83d6b5a6 Migration: pnpm (#5215 )

* migration: npm to pnpm
Step 1, package and lockfile

* migration: npm to pnpm
Step 2: docs / LLM instructions

* migration: npm to pnpm
Step 3: More documentation updates

* migration: npm to pnpm
Step 4: Even more documentation

* migration: npm to pnpm
Step 5: GitHub Actions

* migration: npm to pnpm
Step 6: PNPM installation in actions. This merge is going to be painful.

* migration: npm to pnpm
Unignore and add pnpm lockfile.

* migration: npm to pnpm
package-lock.json -> pnpm-lock.yaml

* migration: explicit @primeuix/styled, move glob to prod deps

* migration: more explicit deps required by the importmap plugin and vite

* fix: missed merge artifact

* fix: Make sure pnpm is available to install wrangler

* migration: pnpm for dev-release.yaml

* migration: new setup action version
Won't work until that is updated and a new release is cut.

* migration: Playwright needs uuid

* migration: Add explicit deps for lobehub

* chore(version-bump.yaml): change cache from npm to pnpm to optimize package management and improve build performance

* migration: install pnpm in version-bump action

---------

Co-authored-by: snomiao <snomiao@gmail.com>

2025-08-27 06:10:15 -07:00

1.7 KiB

Raw Blame History

ComfyUI Frontend Project Guidelines

Quick Commands

pnpm: See all available commands
pnpm typecheck: Type checking
pnpm lint: Linting
pnpm format: Prettier formatting
pnpm test:component: Run component tests with browser environment
pnpm test:unit: Run all unit tests
pnpm test:unit -- tests-ui/tests/example.test.ts: Run single test file

Development Workflow

Make code changes
Run tests (see subdirectory CLAUDE.md files)
Run typecheck, lint, format
Check README updates
Consider docs.comfy.org updates

Git Conventions

Use [prefix] format: [feat], [bugfix], [docs]
Add "Fixes #n" to PR descriptions
Never mention Claude/AI in commits

External Resources

PrimeVue docs: https://primevue.org
ComfyUI docs: https://docs.comfy.org
Electron: https://www.electronjs.org/docs/latest/
Wiki: https://deepwiki.com/Comfy-Org/ComfyUI_frontend/1-overview

Project Philosophy

Clean, stable public APIs
Domain-driven design
Thousands of users and extensions
Prioritize clean interfaces that restrict extension access

Check README files in key folders (tests-ui, browser_tests, composables, etc.)
Prefer running single tests for performance
Use --help for unfamiliar CLI tools

GitHub Integration

When referencing Comfy-Org repos:

Check for local copy
Use GitHub API for branches/PRs/metadata
Curl GitHub website if needed

Common Pitfalls

NEVER use any type - use proper TypeScript types
NEVER use as any type assertions - fix the underlying type issue
NEVER use --no-verify flag when committing
NEVER delete or disable tests to make them pass
NEVER circumvent quality checks

1.7 KiB Raw Blame History