Skip to content
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.

Sign up for GitHub

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

Jump to bottom

devex: Add frontend code snippet & update dev docs #2494

Merged
merged 5 commits into from
Mar 19, 2025
Merged

devex: Add frontend code snippet & update dev docs #2494

merged 5 commits into from
Mar 19, 2025
+117 −16

Conversation

SuaYoo
Copy link
Member

@SuaYoo SuaYoo commented Mar 19, 2025 •
edited
Loading

Changes

  • Adds VSCode file template for component unit testing.
  • Updates development docs with details on UI dev

Manual testing

To test snippet:

  1. Create file named <component>.test.ts
  2. Type in test (or describe) and then choose Btrix Component Test
  3. Type in component class name. Verify file does not show any linting errors

To view docs changes:

  1. Go to frontend/docs
  2. Run mkdocs serve
  3. Go to "Development" -> "UI Development"

Screenshots

Screenshot 2025-03-19 at 11 17 39 AM

SuaYoo added 3 commits March 19, 2025 09:44
@SuaYoo
add snippet
Loading
Loading status checks…
70e474a
@SuaYoo
update snippet

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
Loading
Loading status checks…
7016338
@SuaYoo
udpate docs
Loading
Loading status checks…
e6d6c0c
@SuaYoo SuaYoo changed the title devex: Add code snippet for component tests devex: Update UI development docs Mar 19, 2025
@SuaYoo SuaYoo changed the title devex: Update UI development docs devex: Update UI development docs, add code snippet Mar 19, 2025
@SuaYoo SuaYoo changed the title devex: Update UI development docs, add code snippet devex: Add frontend code snippet & update dev docs Mar 19, 2025
@SuaYoo SuaYoo marked this pull request as ready for review March 19, 2025 18:20
@SuaYoo
fix periods
Loading
Loading status checks…
7ecd24a
tw4l
tw4l approved these changes Mar 19, 2025
View reviewed changes
Copy link
Member

@tw4l tw4l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll leave it to others to test the VS Code snippet but the docs additions are great, thank you!

emma-sg
emma-sg approved these changes Mar 19, 2025
View reviewed changes
Copy link
Member

@emma-sg emma-sg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, ty!

@SuaYoo
document component types
Loading
Loading status checks…
7a2b541
@SuaYoo
Copy link
Member Author

SuaYoo commented Mar 19, 2025

Added:

Screenshot 2025-03-19 at 12 35 41 PM

@SuaYoo SuaYoo merged commit 0bc210d into main Mar 19, 2025
27 checks passed
@SuaYoo SuaYoo deleted the frontend-test-code-snippet branch March 19, 2025 21:22
@SuaYoo SuaYoo requested a review from Shrinks99 March 19, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emma-sg emma-sg

@tw4l tw4l

@ikreymer ikreymer

@DaleLore DaleLore

@Shrinks99 Shrinks99

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@SuaYoo @emma-sg @tw4l