Skip to content

Have vs code markdownlint extension use config file #4755

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Have vs code markdownlint extension use config file #4755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,5 @@ internal/tools/bin
node_modules/
package-lock.json

# Visual Studio Code
.vscode

# Visual Studio
.vs
5 changes: 5 additions & 0 deletions .vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"davidanson.vscode-markdownlint"
Copy link
Member

@trask trask Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea, but looks like this extension is based on markdownlint-cli2, and so flags a lot of things that our existing configuration (based on older version) doesn't

I'd suggest updating the repo to markdownlint-cli2 first and updating configuration to match current repo practices and then come back to this

Copy link
Contributor Author

@thompson-tomo thompson-tomo Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took a look at this and it appears that the first issue is that markdownlint-cli has not been updated.

It is however now pending in the Dashboard #4507

The marketplace listing mentions it supports both. I have also confirmed that is the case. I will submit seperate PR to update rules which will enable update to be merged.

Copy link
Contributor Author

@thompson-tomo thompson-tomo Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pr which applies the latest linting rules is ready as #4756 in that pr when I disabled a rule the violations updated in vs code.

]
}
16 changes: 1 addition & 15 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,4 @@
{
"rewrap.wrappingColumn": 80,
"editor.rulers": [80],
"markdownlint.config": {
"MD004": false,
"MD013": false,
"MD024": {"allow_different_nesting": true},
"MD029": {"style": "ordered"},
"MD033": false,
"MD040": false,
},
"yaml.schemas": {
"https://raw.githubusercontent.com/open-telemetry/build-tools/v0.17.0/semantic-conventions/semconv.schema.json": [
"semantic_conventions/**/*.yaml"
]
},
"json.schemaDownload.enable": true
"markdownlint.configFile": ".markdownlint.yaml"
}
Loading