-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[PM-16788] revise generator metadata #12757
Open
audreyality
wants to merge
9
commits into
main
Choose a base branch
from
tools/pm-16788/revise-generator-metadata
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains 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
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
prograhamming
previously approved these changes
Jan 13, 2025
prograhamming
previously approved these changes
Jan 15, 2025
prograhamming
previously approved these changes
Jan 15, 2025
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.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-16788
📔 Objective
Refactor generator metadata (
data
andtype
folders in@bitwarden/generator-core
) to improve code clarity and make the dependencies easier to follow.Note: this logic is part of a larger work and split out for more efficient review. The logic that cuts over from the existing code to the new code will land at the end of these PRs.
🦖 System Evolution
The refactoring builds from "core" logic up to "domain" logic.
The core logic resides in several files:
metadata/data.ts
- these are enum-alike data structures used to derive and conveniently access type informationmetadata/type.ts
- root data structures used to identify extensions and interact with extension dataDomain metadata then build on top of this:
At present there isn't a system managing this data; it's all hard-coded in
email
,password
, andusername
subfolders. Management systems will be introduced in afollowup PR.
🦮 Reviewer guidelines
:+1:
) or similar for great changes:memo:
) or ℹ️ (:information_source:
) for notes or general info:question:
) for questions:thinking:
) or 💭 (:thought_balloon:
) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:
) for suggestions / improvements:x:
) or:warning:
) for more significant problems or concerns needing attention:seedling:
) or ♻️ (:recycle:
) for future improvements or indications of technical debt:pick:
) for minor or nitpick changes