WEBDEV-8506: Add conventions for non-component modules#50
Open
jbuckner wants to merge 2 commits into
Open
Conversation
Establishes directory layout, exports map, and test conventions for services, parsers, models, and type utilities ahead of consolidating metadata-service and its dependency tree into elements. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #50 +/- ##
=======================================
Coverage 78.75% 78.75%
=======================================
Files 16 16
Lines 645 645
Branches 168 168
=======================================
Hits 508 508
Misses 95 95
Partials 42 42 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This was referenced May 27, 2026
9f11786 to
bc483df
Compare
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.
Summary
Establishes the directory layout,
package.jsonexports patterns, and test conventions for non-component modules (services, parsers, models, type utilities) ahead of consolidatingmetadata-serviceand its dependency tree intoelements.No code is moved in this PR — it's documentation + the routing rules that future migration PRs will fill in.
Changes
README.md— new "Adding a Service or Library Module" section parallel to "Adding a Component", documenting the new top-level directories (src/services,src/parsers,src/models,src/types), their purposes, structure, exports, and test patterns.package.json— adds subpath exports for the four new module directories. Patterns mirror the existing./labs/*pattern.Why a separate ticket?
The next four tickets (WEBDEV-8507, WEBDEV-8508, WEBDEV-8509, WEBDEV-8510) each move a single repo into
elements/src/. Landing the conventions first means each migration PR is straightforward "move code into the agreed location" without re-litigating layout.Test plan
npm run buildpassesQA waived — docs + config only, no runtime artifact.
qa-waivedlabel applied at Code Review transition.🤖 Generated with Claude Code