TT-7481 refactor(burrito): standardize flavorType naming in burrito transformation#384
Closed
gtryus wants to merge 1 commit into
Closed
TT-7481 refactor(burrito): standardize flavorType naming in burrito transformation#384gtryus wants to merge 1 commit into
gtryus wants to merge 1 commit into
Conversation
…ation - Updated the `flavorType.name` to 'scripture' across various components to ensure consistency in the burrito transformation process. - Adjusted related tests to reflect the new naming convention, enhancing clarity and maintainability. - Improved handling of legacy flavor names to accommodate existing data structures. - Add currentScope to the intellectualproperty custom burrito This commit improves compliance with the custom burrito standard
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes Scripture Burrito metadata so metadata.type.flavorType.name is consistently scripture, while custom burrito variants are expressed via metadata.type.flavorType.flavor.name (e.g., x-nav, x-apmdata, x-intellectualproperty, x-notes). It also extends the intellectual property burrito to include currentScope derived from the same project selection used for ApmData exports, and updates the migration importer to recognize legacy exports where custom flavors were stored in flavorType.name.
Changes:
- Standardize burrito
flavorType.nametoscriptureand move custom identifiers toflavorType.flavor.namein export hooks (audio, nav, ApmData, intellectual property). - Add
currentScopepopulation to the intellectual property burrito based on selected ApmData projects. - Update tests and the burrito→PTF migration script to support the new convention and legacy flavor naming.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/renderer/src/burrito/useCreateBurrito.ts | Passes selected ApmData projects into intellectual property export so currentScope can be derived consistently. |
| src/renderer/src/burrito/useCreateBurrito.test.ts | Updates test expectations/fixtures to reflect standardized scripture flavorType naming. |
| src/renderer/src/burrito/useBurritoNavigation.ts | Sets flavorType.name = scripture and assigns custom nav flavor via flavor.name = x-nav. |
| src/renderer/src/burrito/useBurritoNavigation.test.ts | Adapts tests for new flavor semantics and refactors module loading to dynamic import(). |
| src/renderer/src/burrito/useBurritoIntellectualProperty.ts | Adds currentScope merge (from selected projects) and standardizes flavor naming for intellectual property burrito. |
| src/renderer/src/burrito/useBurritoIntellectualProperty.test.ts | Adds mocks/expectations for currentScope generation and standardized flavor naming. |
| src/renderer/src/burrito/useBurritoAudio.ts | Keeps flavorType.name as scripture and uses flavor.name for custom exports like notes (x-notes). |
| src/renderer/src/burrito/useBurritoAudio.test.ts | Updates assertions to match scripture + flavor.name convention for notes export. |
| src/renderer/src/burrito/useBurritoApmData.ts | Populates currentScope via helper and standardizes ApmData flavor naming to scripture + x-apmdata. |
| src/renderer/src/burrito/useBurritoApmData.test.ts | Updates expectations for standardized ApmData flavorType.name. |
| src/renderer/src/burrito/akuoBookToUsfm.ts | Adds helpers to compute per-project and unioned currentScope entries for burrito exports. |
| migration/05-burrito-to-ptf.test.mjs | Updates migration fixtures to the standardized scripture flavorType name. |
| migration/05-burrito-to-ptf.js | Improves legacy handling by treating flavorType.name values starting with x- as legacy custom flavors. |
sarahentzel
approved these changes
Jul 1, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
flavorType.nameto 'scripture' across various components to ensure consistency in the burrito transformation process.This commit improves compliance with the custom burrito standard