Skip to content

Commit 8cb8f0e

Browse files
committed
Setup markdownlint and fix markdown lint violations
1 parent 2b340d0 commit 8cb8f0e

6 files changed

Lines changed: 952 additions & 6 deletions

File tree

.github/workflows/lint-and-format.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,20 @@ jobs:
2626
node-version-file: '.node-version'
2727

2828
- name: Lint and Format - Install node dependencies for all workspaces
29-
run: npm ci --workspaces
29+
run: npm ci
3030

3131
- name: Lint and Format - Run eslint
3232
run: npm run lint
3333

3434
- name: Lint and Format - Run prettier format check
3535
run: npm run format:check
3636

37+
- name: Lint and Format - Run markdownlint
38+
run: npm run lint:md
39+
3740
- name: Lint and Format - Summary
3841
run: |
3942
echo "## Lint and Format Check Summary" >> $GITHUB_STEP_SUMMARY
4043
echo "✅ ESLint checks completed on all workspaces" >> $GITHUB_STEP_SUMMARY
4144
echo "✅ Prettier format checks completed" >> $GITHUB_STEP_SUMMARY
45+
echo "✅ Markdownlint checks completed" >> $GITHUB_STEP_SUMMARY

.markdownlint.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# markdownlint configuration
2+
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
3+
#
4+
# This config is consumed by:
5+
# 1. The repo-maintained `npm run lint:md` script (markdownlint-cli)
6+
# 2. The org-required `markdown-lint.yml` workflow (markdownlint-cli)
7+
8+
# MD013 - Line length: disabled (handled by prettier)
9+
MD013: false
10+
11+
# MD024 - Multiple headings with the same content: allow across sections
12+
# Changelogs and release notes intentionally repeat headings like
13+
# "### Added", "### Changed", "#### MCP Server Tools" under each version.
14+
MD024:
15+
siblings_only: true

.markdownlintignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
node_modules
2+
**/node_modules
3+
server/dist
4+
coverage
5+
server/coverage
6+
extensions/vscode/coverage
7+
extensions/vscode/.vscode-test
8+
extensions/vscode/test/fixtures
9+
server/ql/*/tools/test/*
10+
server/src/prompts/
11+
server/src/resources/
12+
workshops
13+
**/*.testproj
14+
client/**/after/
15+
client/**/before/
16+
query-results*

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ _Changes on `main` since the latest tagged release that have not yet been includ
215215

216216
### New Contributors
217217

218-
- [@dependabot](https://github.com/dependabot)[bot] made their first contribution in [#49](https://github.com/advanced-security/codeql-development-mcp-server/pull/49)
218+
- @dependabot\[bot\] made their first contribution in [#49](https://github.com/advanced-security/codeql-development-mcp-server/pull/49)
219219
- [@MichaelRFairhurst](https://github.com/MichaelRFairhurst) made their first contribution in [#70](https://github.com/advanced-security/codeql-development-mcp-server/pull/70)
220220
- @github-actions[bot] made their first contribution in [#65](https://github.com/advanced-security/codeql-development-mcp-server/pull/65)
221221

0 commit comments

Comments
 (0)