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

fix: do not try to format tables found in code blocks #145

Merged
merged 4 commits into from
Feb 15, 2022

Conversation

beark
Copy link
Contributor

@beark beark commented Feb 10, 2022

Change also introduces new option, jsdocPreferCodeFences, which will
format code blocks using fences (```) instead of indentation.

Fixes #144

Change also introduces new option, jsdocPreferCodeFences, which will
format code blocks using fences (```) instead of indentation.

issue: hosseinmd#144
@beark
Copy link
Contributor Author

beark commented Feb 10, 2022

Not sure how you'd prefer the title and message to read, since there's both a "fix:" and a "feat:". I could split it up into two PRs if you want?

@hosseinmd
Copy link
Owner

Hi dear,
Great work,
LGTM
I think we should always Prefer Code Fences. No need of an option to enable them. Or At least we could set default to true.

@hosseinmd
Copy link
Owner

My suggestion is removing jsdocPreferCodeFences

@beark beark changed the title Do not try to format "tables" found in code blocks fix: do not try to format tables found in code blocks Feb 11, 2022
@beark
Copy link
Contributor Author

beark commented Feb 11, 2022

As suggested, I removed the new option and instead default to always fence code blocks!

@hosseinmd
Copy link
Owner

hosseinmd commented Feb 12, 2022

I am not sour about this change, this is a breaking change. This need more discussion.

@hosseinmd
Copy link
Owner

@beark
Copy link
Contributor Author

beark commented Feb 12, 2022

I'm happy to put the option to toggle whether fences or indentation are preferred back in, which would make it non-breaking.

@danielpza
Copy link
Collaborator

I'm happy to put the option to toggle whether fences or indentation are preferred back in, which would make it non-breaking.

👍 for making it opt in if we don't want to worry about breaking changes. We should mention the option in the readme though.

@danielpza
Copy link
Collaborator

I like the code fence by default but it is a breaking change, we would need to bump the major version to not break the users workflow. This is something we can do later if we decide this is the default we really want. There's no rush to change the default right now, introducing this change under the flag sounds good to me

@hosseinmd
Copy link
Owner

All right. That was my mistake. @beark please add it to option again.

Thank you.

@hosseinmd hosseinmd merged commit dd9e1dc into hosseinmd:master Feb 15, 2022
@beark beark deleted the dont-format-code-blocks branch February 16, 2022 01:05
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.

Unspecified or unrecognized code blocks should be left as they are
3 participants