mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-05-04 05:02:17 +00:00

Files

Comfy Org PR Bot bf23384de0 docs: Weekly Documentation Update (#10029 )

# Documentation Audit - File Path Updates

## Summary

Conducted a comprehensive audit of all documentation files across the
repository to ensure 100% accuracy of file paths, code references, and
technical information. Fixed outdated file path references that resulted
from codebase restructuring.

## Changes Made

### File Path Corrections

**docs/SETTINGS.md**
- Updated `src/constants/coreSettings.ts` →
`src/platform/settings/constants/coreSettings.ts` (3 occurrences)
- Updated `src/stores/settingStore.ts` →
`src/platform/settings/settingStore.ts` (2 occurrences)
- Updated `src/services/newUserService.ts` →
`src/services/useNewUserService.ts` (1 occurrence)

**src/locales/CONTRIBUTING.md**
- Updated `src/constants/coreSettings.ts` →
`src/platform/settings/constants/coreSettings.ts` (1 occurrence)

**docs/testing/unit-testing.md**
- Updated `@/domains/workflow/validation/schemas/workflowSchema` →
`@/platform/workflow/validation/schemas/workflowSchema` (1 occurrence)

## Audit Results

### Files Audited (✅ All Pass)
- ✅ Core documentation: README.md, CONTRIBUTING.md, CLAUDE.md, AGENTS.md
- ✅ Docs directory: 27 files in docs/**/*.md
- ✅ Claude commands: 7 files in .claude/commands/*.md
- ✅ Locales documentation: src/locales/CONTRIBUTING.md
- ✅ Package.json scripts: All documented commands verified against
actual scripts

### Accuracy Statistics
- **Total file path references audited:** 50+
- **Broken references found:** 5
- **Broken references fixed:** 5
- **Documentation files scanned:** 31
- **Final accuracy rate:** 100%

### Verified as Accurate
- ✅ All package.json script references in AGENTS.md match actual scripts
- ✅ All configuration file references (.vscode/extensions.json,
vite.config.mts, etc.) point to existing files
- ✅ All code examples reference actual existing files
- ✅ All ADR (Architecture Decision Records) dates and references are
correct
- ✅ Extension API examples match current implementation
- ✅ Feature flag system documentation aligns with actual code
- ✅ Settings system documentation reflects current architecture
- ✅ Testing guides reference correct test file locations
- ✅ Vue component conventions match actual patterns
- ✅ TypeScript conventions align with codebase standards

## Review Notes

This audit was triggered by a codebase restructuring where
settings-related files were moved from `src/constants/` and
`src/stores/` to a new platform-based organization under
`src/platform/settings/`. Additionally, some service files were renamed
to follow the `use*` composable naming convention.

All documentation now accurately reflects the current codebase
structure. No functionality changes were made - only documentation
updates to maintain accuracy.

### Files with Intentionally Deleted References (No Fix Needed)
- `build/plugins/generateImportMapPlugin.ts` - Documented as removed in
ADR-0005, reference is intentionally showing historical context

## Testing
- Verified all updated file paths exist in the codebase
- Confirmed all code examples still compile with updated import paths
- Validated no broken internal documentation links

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-10029-docs-Weekly-Documentation-Update-3256d73d36508177b363d4160085bbe9)
by [Unito](https://www.unito.io)

Co-authored-by: christian-byrne <72887196+christian-byrne@users.noreply.github.com>

2026-03-16 07:13:32 -07:00

component-testing.md

Chore: Oxfmt formatting pass (#8341 )

2026-01-27 17:59:19 -08:00

README.md

Chore: Oxfmt formatting pass (#8341 )

2026-01-27 17:59:19 -08:00

store-testing.md

test: use createTestingPinia instead of createPinia (#8376 )

2026-01-28 22:21:38 -08:00

unit-testing.md

docs: Weekly Documentation Update (#10029 )

2026-03-16 07:13:32 -07:00

vitest-patterns.md

Chore: Oxfmt formatting pass (#8341 )

2026-01-27 17:59:19 -08:00

README.md

ComfyUI Frontend Testing Guide

This guide provides an overview of testing approaches used in the ComfyUI Frontend codebase. These guides are meant to document any particularities or nuances of writing tests in this codebase, rather than being a comprehensive guide to testing in general. By reading these guides first, you may save yourself some time when encountering issues.

Testing Documentation

Documentation for unit tests is organized into three guides:

Component Testing - How to test Vue components
Unit Testing - How to test utility functions, composables, and other non-component code
Store Testing - How to test Pinia stores specifically

Testing Structure

The ComfyUI Frontend project uses colocated tests - test files are placed alongside their source files:

Component Tests: Located directly alongside their components (e.g., MyComponent.test.ts next to MyComponent.vue)
Unit Tests: Located alongside their source files (e.g., myUtil.test.ts next to myUtil.ts)
Store Tests: Located in src/stores/ alongside their store files
Browser Tests: Located in the browser_tests/ directory (see dedicated README there)

Test File Naming

Use .test.ts extension for test files
Name tests after their source file: sourceFile.test.ts

Test Frameworks and Libraries

Our tests use the following frameworks and libraries:

Vitest - Test runner and assertion library
@vue/test-utils - Vue component testing utilities
Pinia - For store testing

Getting Started

To run the tests locally:

# Run unit tests
pnpm test:unit

# Run a specific test file
pnpm test:unit -- src/path/to/file.test.ts

# Run unit tests in watch mode
pnpm test:unit -- --watch

Refer to the specific guides for more detailed information on each testing type.