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

MarkdownBear: use remark-lint to report meaningful messages #926

Closed
jayvdb opened this issue Oct 23, 2016 · 3 comments · Fixed by #1942
Closed

MarkdownBear: use remark-lint to report meaningful messages #926

jayvdb opened this issue Oct 23, 2016 · 3 comments · Fixed by #1942

Comments

@jayvdb
Copy link
Member

jayvdb commented Oct 23, 2016

Using the revised output of remark is helpful for tidying the markdown automatically, however that means there are no descriptions of the problems.

The remark-lint plugin reports error messages.

When in CI mode, and the tidying of the file is useless, and descriptive messages are critical.

e.g. https://github.com/imsky/PocketEuler/blob/master/.travis.yml

@jayvdb
Copy link
Member Author

jayvdb commented Dec 30, 2016

So, the introduction of remark-lint>=5.1.0 was done in #1204.

Rather urgently, we need to test what happens with remark reformats and remark-lint emits an error. I expect both will happen, resulting in duplication of sorts, which may be confusing.

@jayvdb jayvdb added this to the 0.10 milestone Dec 30, 2016
@Mixih Mixih modified the milestones: 0.10, 0.11 Feb 24, 2017
@jayvdb jayvdb modified the milestones: 0.11, 0.12 Apr 27, 2017
@yash-nisar
Copy link
Member

With reference to

Rather urgently, we need to test what happens with remark reformats and remark-lint emits an error. I expect both will happen, resulting in duplication of sorts, which may be confusing.

I've tested that both happen and there is a duplication. i.e. remark-lint emits an error even after the file is reformatted after the patch is applied.

@yash-nisar
Copy link
Member

One workaround can be to avoid using duplicated settings, i.e. higher preference should be given to code correcting capabilities instead of remark-lint plugins which only emit a message.

yash-nisar added a commit to yash-nisar/coala-bears that referenced this issue Jul 23, 2017
yash-nisar added a commit to yash-nisar/coala-bears that referenced this issue Jul 24, 2017
yash-nisar added a commit to yash-nisar/coala-bears that referenced this issue Jul 24, 2017
umeshksingla pushed a commit to umeshksingla/coala-bears that referenced this issue Sep 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment