Skip to content

Add option to preserve header - #58

Merged
bwplotka merged 3 commits into
bwplotka:mainfrom
saswatamcode:preserve-header
Jul 12, 2021
Merged

bwplotka merged 3 commits into
bwplotka:mainfrom
saswatamcode:preserve-header

Conversation

@saswatamcode

Copy link
Copy Markdown
Collaborator

This PR changes transform tranformation config to preserve markdown headers by default while transforming as discussed in 1:1. popHeader option may be added to enable removing header.

Note: Could not find a better explicit way of enabling remove header other than bool option in config (as was mentioned in 1:1). Would a flag instead be preferred?

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
@saswatamcode
saswatamcode requested a review from bwplotka July 5, 2021 05:18
@saswatamcode saswatamcode self-assigned this Jul 5, 2021

@bwplotka bwplotka left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Nice LGTM, just one idea: Wonder if we can global default popHeader on root file? 🤔

@saswatamcode

Copy link
Copy Markdown
Collaborator Author

Sure! Will try to implement this!

@saswatamcode

Copy link
Copy Markdown
Collaborator Author

Now, popHeader will be true by default for root files in input dir. This can be disabled by setting popHeader to false with glob matching root file. Also, all root files will have this as true by default, so would need to be configured separately if this behavior is not needed. Test case added in pkg/transform/testdata/mdox3.yaml where popHeader is not set for README.md but md header is still popped.

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
Comment thread pkg/transform/testdata/mdox1.yaml Outdated
transformations:
- glob: "README.md"
path: _index.md
popHeader: true

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

If popHeader is true on root, why we do this? 🤔

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Sorry, forgot to remove!

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

It's still there on all examples 🤔

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
@saswatamcode
saswatamcode requested a review from bwplotka July 10, 2021 11:38
@bwplotka
bwplotka merged commit f49414c into bwplotka:main Jul 12, 2021
@bwplotka

Copy link
Copy Markdown
Owner

Merging, LGTM thanks, but examples are still not perfect 🙈

@saswatamcode

Copy link
Copy Markdown
Collaborator Author

I've missed some. Will raise PR to fix them! 🙂

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.

2 participants

⌂ 换网址