[L2Ork-dev] side-quest: enforce 80-character line-width on README.md

[Jonathan Wilkes]

On Sat, Apr 10, 2021 at 3:15 PM Rukshan J. Senanayaka
<rjsenanayaka at gmail.com> wrote:
>
> I'm still learning this. Maybe we can integrate https://github.com/markdownlint/markdownlint into the CI/CD flow?

That's one option.

However, if I make a change to `.gitlab-ci.yml` with a syntax error in
it, IIRC gitlab will show me an error next to the file. If I click it,
I can view the specific error or errors. That happens somehow in
Gitlab itself and doesn't rely on CI at all.

Is there a way to add markdown lint rules somewhere in Gitlab that
have the same UX?

-Jonathan

>
> On Sat, Apr 10, 2021 at 11:50 PM Jonathan Wilkes <jon.w.wilkes at gmail.com> wrote:
>>
>> Hi list,
>>
>> Can someone figure out for me how to make an automated markdown linter
>> in Gitlab that enforces an 80-character line-width rule for README.md
>> (and all other *.md for that matter)?
>>
>> I just pushed changes to the README.md that get it back to the
>> 80-character line-width requirement that I want to enforce.
>>
>> People make changes to that README.md with long paragraphs, as if they
>> are writing an email like this one and just letting the editor auto
>> wrap the lines.
>>
>> The problem with that is when someone makes a simple diff-- like
>> changing "foobar" to "foo-bar", the diff will show the *entire*
>> paragraph. Then I must fish around to figure out what exactly the
>> change was in that sea of text.
>>
>> Anyway, I want Gitlab to bark at people when they exceed that limit.
>>
>> Best,
>> Jonathan
>> _______________________________________________
>> L2Ork-dev mailing list
>> L2Ork-dev at disis.music.vt.edu
>> https://disis.music.vt.edu/listinfo/l2ork-dev
>
> _______________________________________________
> L2Ork-dev mailing list
> L2Ork-dev at disis.music.vt.edu
> https://disis.music.vt.edu/listinfo/l2ork-dev