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

Reduce complexity by removing prettier formatting of outputted markdown #188

Merged
merged 1 commit into from
Oct 30, 2022

Conversation

bmish
Copy link
Owner

@bmish bmish commented Oct 30, 2022

This reduces unnecessary complexity of trying to format the outputted markdown with prettier which may or may not be installed in user's repository. Instead, the user can choose to run prettier on their own after running this tool if they'd like. This puts the user more in control and avoids potential issues.

  • Prettier hid potential markdown formatting issues
  • Prettier's API will change between v2 and v3 (Simpler string trimming after prettier format #186 (comment))
  • Even if prettier is installed, the user might not want to use it for markdown formatting
  • It was difficult to test different prettier setups
  • We recently added markdown-table to do the table formatting for us and it's very similar to prettier formatting

Fixes #185.
Fixes #88.

@bmish bmish added the bug Something isn't working label Oct 30, 2022
@bmish bmish merged commit a0c7bf3 into main Oct 30, 2022
@bmish bmish deleted the remove-prettier-formatting branch October 30, 2022 18:05
@bmish bmish added enhancement New feature or request and removed bug Something isn't working labels Oct 30, 2022
@bmish bmish changed the title Remove prettier formatting of outputted markdown Reduce complexity by removing prettier formatting of outputted markdown Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove prettier formatting of outputted markdown Figure out how to test when prettier is not installed
1 participant