mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-03 06:47:33 +00:00
9f5245dc80
## Summary Split mask editor structure into smaller files ## Changes This PR is a prerequisite step for [the issue - refactoring the mask editor using Vue](https://github.com/Comfy-Org/ComfyUI_frontend/issues/5956). It splits the current monolithic maskeditor.ts (about 5700 lines) into separate files; otherwise, the original single file would be very difficult to analyze or maintain. This PR itself does not introduce any Vue, nor should it have any functional changes or modifications. It's purely a code-level split, with all related files placed in the maskeditor folder. The original maskeditor.ts has been renamed to maskeditor.ts.backup for future reference. ## Review Focus Since this PR is only for splitting purposes, all logic remains consistent with the original. Therefore, for any reviewer: any code logic improvements should happen in the subsequent Vue-based refactoring, not in this PR. Following this PR, I will perform a Vue-based refactoring of the mask editor to align with the frontend's overall Vue architecture and provide better cloud-related support. ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6308-refactor-Split-mask-editor-into-smaller-files-2986d73d36508131937dd43e465a47bd) by [Unito](https://www.unito.io)
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 a mixed approach to unit test organization:
- Component Tests: Located directly alongside their components with a
.spec.tsextension - Unit Tests: Located in the
tests-ui/tests/directory - Store Tests: Located in the
tests-ui/tests/store/directory - Browser Tests: These are located in the
browser_tests/directory. There is a dedicated README in thebrowser_tests/directory, so it will not be covered here.
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 unit tests in watch mode
pnpm test:unit:dev
Refer to the specific guides for more detailed information on each testing type.