DX: Introduce Markdownlint #7534
Conversation
UPGRADE-v3.md
Outdated
There was a problem hiding this comment.
Tables may look more complex at first sight, but in fact these are more readable with proper spacing. PHPStorm has great markdown support and automatically aligns cells when editing, so it's easy to modify (no need to fill spaces manually in non-modified rows etc.).
| all | ||
|
|
||
| # Override rules' config | ||
| rule 'MD026', :punctuation => '.,;:' |
There was a problem hiding this comment.
The difference from default config is that ! and ? are allowed (see first header of CONTRIBUTING.md).
It's mounted under `/fixer` because this image already has `/app` with important stuff and overwriting it makes `mdl` unavailable.
Wirone
force-pushed
the
codito/lint-markdown
branch
from
6c034fc
to
114dce1
Compare
|
I'm confused , why is a markdown Linter in php-cs-fixer ? |
|
Because we have markdown files in our repo and we want to keep quality there too 🤷♂️? As you can see in the PR's diff, there were violations that were found and fixed, now we will check it in every pipeline. |
|
Oh its internal for the pipeline of cs-fixer! No, that makes perfect sense!
I read it as an addition of a markdown Linter inside of php-cs 🙈
…On Sat, Dec 9, 2023, 15:57 Greg Korba ***@***.***> wrote:
Because we have markdown files in our repo and we want to keep quality
there too 🤷♂️? As you can see in the PR's diff, there were violations
that were found and fixed, now we will check it in every pipeline.
—
Reply to this email directly, view it on GitHub
<#7534 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ALMD2DRWWXNSYXRD77MUGT3YIR37PAVCNFSM6AAAAABANKBPEKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNBYGQZTCOBRHA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
| markdown-lint: | ||
| image: registry.gitlab.com/pipeline-components/markdownlint:latest | ||
| command: mdl --git-recurse . | ||
| working_dir: /fixer |
There was a problem hiding this comment.
why not /app, like everywhere else?
There was a problem hiding this comment.
Info in the commit message 😉.
There was a problem hiding this comment.
John Doe, few months from now, will not have this detail available, and it's not intuitive when looking at code only
There was a problem hiding this comment.
I still forget that commits are squashed 🤷♂️. I rather work with full history. Maybe it would be better to change all volumes to /fixer and then it does not matter why it's like this?
There was a problem hiding this comment.
myself i would go this path (/fixer)
but anything that is not confusing end user will work for me
The goal of this PR is to introduce standardised way of ensuring quality in Markdown files using
markdownlinttool.docker compose run markdown-lint