mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-28 06:22:45 -08:00
1.7 KiB
1.7 KiB
id, title, status, assignee, created_date, labels, dependencies, references, priority
| id | title | status | assignee | created_date | labels | dependencies | references | priority | |
|---|---|---|---|---|---|---|---|---|---|
| TASK-55 | Normalize service naming conventions across core/services | To Do | 2026-02-16 04:47 |
|
low |
Description
The core/services directory has inconsistent naming patterns that create confusion:
- Some files use
*Service.tssuffix (e.g.,mpv-service.ts,tokenizer-service.ts) - Others use
*RuntimeService.tsor just descriptive names (e.g.,overlay-visibility-service.tsexports functions with 'Service' in name) - Some functions in files have 'Service' suffix, others don't
This inconsistency makes it hard to predict file/function names and creates cognitive overhead.
Standardize on:
- File names:
kebab-case.tswithout 'service' suffix (e.g.,mpv.ts,tokenizer.ts) - Function names: descriptive verbs without 'Service' suffix (e.g.,
createMpvClient(),tokenizeSubtitle()) - Barrel exports: clean, predictable names
Files needing audit (47 services):
- All files in src/core/services/ need review
Note: This is a large-scale refactor that should be done carefully to avoid breaking changes.
Acceptance Criteria
- #1 Establish naming convention rules (document in code or docs)
- #2 Audit all service files for naming inconsistencies
- #3 Rename files to follow convention (kebab-case, no 'service' suffix)
- #4 Rename exported functions to remove 'Service' suffix where present
- #5 Update all imports across the entire codebase
- #6 Update barrel exports
- #7 Run full test suite
- #8 Update any documentation referencing old names