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.

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

[DO NOT MERGE] feat(cli): add Markdown support for CLI #1356

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

jasminesun-lw
Copy link

@jasminesun-lw jasminesun-lw commented Aug 16, 2023

Summary

Enhance Lacework’s Timeline/commenting functionality to better support investigation workflows, specifically by including the ability to leverage Markdown.

How did you test this change?

Demo video:
https://github.com/lacework/go-sdk/assets/132718757/239261c3-6b0c-4af1-bd48-cf27a0efea38

Before:
Screenshot 2023-08-18 at 10 14 02 AM
After:
Screenshot 2023-08-22 at 1 18 35 PM

Issue

https://lacework.atlassian.net/browse/ANEP-2048

Less aggressive vertical padding for timeline boxes

ANEP-2048
@hazedav
Copy link
Collaborator

hazedav commented Aug 16, 2023

@jasminesun-lw , can we add some screenshots to the description with before+after side-by-side rendering of plaintext comments?

@hazedav
Copy link
Collaborator

hazedav commented Aug 16, 2023

@jasminesun-lw , we will want and need some updated automated testing for this using the -f flag...

@jasminesun-lw jasminesun-lw changed the title feat(ANEP-2048): add Markdown support for CLI feat(cli): add Markdown support for CLI Aug 17, 2023
@jasminesun-lw jasminesun-lw marked this pull request as ready for review August 22, 2023 20:34
@jasminesun-lw jasminesun-lw requested a review from a team as a code owner August 22, 2023 20:34
@@ -53,6 +53,8 @@ require (
)

require (
github.com/Delta456/box-cli-maker/v2 v2.3.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Are there packages cross platform compatible? Especially for windows?

Copy link
Collaborator

Choose a reason for hiding this comment

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

So box-cli-maker seems to render fine in windows command line. go-term-markdown is another story...

Copy link
Collaborator

Choose a reason for hiding this comment

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

For windows me might have to revert back to just showing a table (not sure how tables even look with really long comments today). I'm not aware of any go+markdown+windows-cli packages.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We can maybe look into this...https://github.com/charmbracelet/glow

@afiune
Copy link
Contributor

afiune commented Aug 22, 2023

Check windows 🪟

@afiune
Copy link
Contributor

afiune commented Aug 22, 2023

Also, this is exciting!!

@hazedav hazedav requested review from a team and kolbeinn August 25, 2023 17:43
@hazedav
Copy link
Collaborator

hazedav commented Aug 25, 2023

@jasminesun-lw , this looks good to me. I'll let the GROW team weigh in on this as well. Can we also create a GROW Jira ticket to look into windows markdown rendering support?

@hazedav hazedav requested review from afiune and hazedav August 25, 2023 17:44
@jasminesun-lw
Copy link
Author

@jasminesun-lw , this looks good to me. I'll let the GROW team weigh in on this as well. Can we also create a GROW Jira ticket to look into windows markdown rendering support?

Done! It's currently in backlog: https://lacework.atlassian.net/browse/GROW-2399

@hazedav
Copy link
Collaborator

hazedav commented Sep 29, 2023

Ping!

Copy link
Contributor

@afiune afiune left a comment

Choose a reason for hiding this comment

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

Tested locally! Works great on my Mac 🙌🏽

@hazedav hazedav changed the title feat(cli): add Markdown support for CLI [DO NOT MERGE] feat(cli): add Markdown support for CLI Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants