Separate the recipe format from app features in packages/core
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- backend
Research direction
Start by reading the listed modules in packages/core and tracing how the API and web import them. Separate the format modules from feature modules, then check that the format package has no feature dependencies and API and web use only its package entry point. Run the existing tests and verify round-trip tests live with the format.
Written by the indexing model from the issue text.
Description
Summary
Part of the OpenRecipe format extraction (tracking: #101). Not urgent.
packages/core currently mixes two things: the recipe format (what a recipe document is) and features built on top of it. Before the format can stand alone, separate them inside this monorepo.
Proposed split
Format (moves to e.g. packages/format):
schema.ts,types.ts,SCHEMA_VERSIONduration.ts,units.ts(the syntax and vocabulary a document may use)parse.ts,serialize.ts,body.ts,errors.tslicense.ts
Features (stay with OpenSkillet, possibly a separate library later):
diff.ts,merge.ts,ancestry.ts,describe-change.tsscale.ts,convert.ts,shopping.ts,timers.ts,steps.tshash.ts(revisit: content hashing may belong to the format if other tools should agree on it)
Acceptance criteria
- Format package has no dependency on the feature modules.
- API and web import the format through its package entry point only.
- Existing tests pass; round-trip tests live with the format.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- Avg merge
- 10h 51m
- Merged PRs (30d)
- 48
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dnerever/OpenRecipe
-
UI/UX improvementsOpenenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
dnerever/OpenRecipe#73 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
dnerever/OpenRecipe#101 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
dnerever/OpenRecipe#100 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 45/100
dnerever/OpenRecipe#99 ·
Maintainers usually reply within 1 day
-
documentation enhancement
Difficulty 5/5 Over a week Newbie friendliness 45/100
dnerever/OpenRecipe#98 ·
Maintainers usually reply within 1 day
All issues in dnerever/OpenRecipe
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
keptinventory/kept#336 ·
Maintainers usually reply within 1 day
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
hemi-earn
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
vetro-protocol/vetro-monorepo#1013 ·
Maintainers usually reply within 1 day