[PR #1762] [CLOSED] Scenario chunks #3534

New issue

Closed

opened 2026-03-07 20:14:14 +03:00 by kerem · 0 comments

kerem commented

2026-03-07 20:14:14 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/DavidAnson/markdownlint/pull/1762
Author: @rodway93
Created: 9/18/2025
Status: ❌ Closed

Base: scenario-chunks ← Head: scenario-chunks

📝 Commits (10+)

41357b5 Bump eslint-plugin-jsdoc from 50.6.8 to 50.6.9
61fab7b Bump @eslint/js from 9.22.0 to 9.23.0
32d660c Bump eslint from 9.22.0 to 9.23.0
c4a6ef4 Bump eslint-plugin-unicorn from 57.0.0 to 58.0.0
918f159 Update test repo snapshots.
465fc44 Bump eslint-plugin-n from 17.16.2 to 17.17.0
b4204f1 Add npm script "update-test-repos" to recreate the test-repos directory and freshen the corresponding snapshots.
a9417fd Update MD036/no-emphasis-as-heading to ignore HTML comments at the beginning or ending of the emphasised heading (fixes #1267).
a84f7c5 Add mention of using "extends" in .markdownlint.json to reference installed packages (closes #1555).
3145b68 Update test repo snapshots.

📊 Changes

124 files changed (+76812 additions, -1448 deletions)

View changed files

📝 .github/dictionary.txt (+1 -0)
➕ .github/instructions/codacy.instructions.md (+65 -0)
📝 .github/workflows/checkers.yml (+3 -4)
📝 .github/workflows/ci.yml (+6 -6)
📝 .github/workflows/codeql-analysis.yml (+1 -1)
📝 .github/workflows/test-repos.yml (+3 -3)
➕ .github/workflows/update-test-repos.yml (+41 -0)
📝 .gitignore (+4 -0)
📝 CHANGELOG.md (+10 -0)
📝 README.md (+32 -59)
📝 demo/browser-exports.mjs (+1 -0)
📝 demo/default.css (+4 -1)
📝 demo/default.js (+39 -20)
📝 doc-build/build-rules.mjs (+3 -3)
📝 doc-build/md001.md (+9 -0)
📝 doc-build/md010.md (+6 -0)
📝 doc-build/md033.md (+5 -1)
📝 doc-build/md045.md (+9 -1)
📝 doc-build/md051.md (+7 -0)
📝 doc-build/md052.md (+11 -0)

...and 80 more files

📄 Description

This pull request introduces several improvements and updates to the project's workflows, documentation, and demo code. The main changes include upgrading GitHub Actions to newer versions, adding a new workflow for updating test repositories, documenting a new rule, updating Node.js support, and refining the demo's error highlighting and Markdown rendering.

Workflow and CI/CD updates:

Upgraded all usages of actions/checkout and actions/setup-node to version 5 across multiple workflow files (ci.yml, checkers.yml, test-repos.yml, codeql-analysis.yml, and the new update-test-repos.yml), ensuring compatibility and leveraging the latest features and security patches. [1] [2] [3] [4] [5]
Added a new workflow file .github/workflows/update-test-repos.yml to automate updating test repository snapshots, including scheduled and manual triggers, branch management, and pull request creation.

Documentation and changelog:

Updated README.md to document the new MD060/table-column-style rule and reflect its inclusion in the table rules group, clarified configuration extension via extends, and improved usage examples to show more detailed result objects and modern usage patterns. [1] [2] [3] [4] [5] [6] [7] [8] [9]
Added a new entry for encodings in .github/dictionary.txt to support spellchecking.
Updated CHANGELOG.md for version 0.38.0, summarizing major changes such as the new rule, parser dependency updates, Node version deprecation, and performance improvements.

Node.js and dependency management:

Removed support for Node.js version 18 in CI matrix and updated dependencies, reflecting the project's move to support newer Node versions only. [1] [2]

Demo and browser improvements:

Enhanced the demo by exporting frontMatterRe from markdownlint/helpers in browser-exports.mjs, stripping front matter before rendering Markdown, and adding robust error highlighting for lines and character ranges in the rendered output. Also improved CSS for error and highlight classes. [1] [2] [3] [4] [5]

Codacy integration instructions:

Added .github/instructions/codacy.instructions.md with detailed guidelines for interacting with Codacy's MCP Server, including mandatory analysis steps after file edits and dependency changes, troubleshooting, and security check requirements.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/DavidAnson/markdownlint/pull/1762 **Author:** [@rodway93](https://github.com/rodway93) **Created:** 9/18/2025 **Status:** ❌ Closed **Base:** `scenario-chunks` ← **Head:** `scenario-chunks` --- ### 📝 Commits (10+) - [`41357b5`](https://github.com/DavidAnson/markdownlint/commit/41357b551f781f8f9741d8228e63161cb799ec23) Bump eslint-plugin-jsdoc from 50.6.8 to 50.6.9 - [`61fab7b`](https://github.com/DavidAnson/markdownlint/commit/61fab7ba24304fd3bad5ed6ff0be78dea1529f39) Bump @eslint/js from 9.22.0 to 9.23.0 - [`32d660c`](https://github.com/DavidAnson/markdownlint/commit/32d660c34b5bce11e6d4a14557d3a237f936e8fb) Bump eslint from 9.22.0 to 9.23.0 - [`c4a6ef4`](https://github.com/DavidAnson/markdownlint/commit/c4a6ef42a6890f05c9042fbbe91051e3b72e7c0c) Bump eslint-plugin-unicorn from 57.0.0 to 58.0.0 - [`918f159`](https://github.com/DavidAnson/markdownlint/commit/918f15945b774e256723a98a7e7b590b8f3e22ee) Update test repo snapshots. - [`465fc44`](https://github.com/DavidAnson/markdownlint/commit/465fc448eb799fc7e6dfa57b155636c558d37e35) Bump eslint-plugin-n from 17.16.2 to 17.17.0 - [`b4204f1`](https://github.com/DavidAnson/markdownlint/commit/b4204f197efeaa290fca5685f8579d517b627013) Add npm script "update-test-repos" to recreate the test-repos directory and freshen the corresponding snapshots. - [`a9417fd`](https://github.com/DavidAnson/markdownlint/commit/a9417fdf673a52bd9a644f26db2803ada43a274e) Update MD036/no-emphasis-as-heading to ignore HTML comments at the beginning or ending of the emphasised heading (fixes #1267). - [`a84f7c5`](https://github.com/DavidAnson/markdownlint/commit/a84f7c5b18e23e2a2e51b6911ddcf30884145cf4) Add mention of using "extends" in .markdownlint.json to reference installed packages (closes #1555). - [`3145b68`](https://github.com/DavidAnson/markdownlint/commit/3145b68bedb6be7f00aff08dd8c338c518dd36e3) Update test repo snapshots. ### 📊 Changes **124 files changed** (+76812 additions, -1448 deletions) <details> <summary>View changed files</summary> 📝 `.github/dictionary.txt` (+1 -0) ➕ `.github/instructions/codacy.instructions.md` (+65 -0) 📝 `.github/workflows/checkers.yml` (+3 -4) 📝 `.github/workflows/ci.yml` (+6 -6) 📝 `.github/workflows/codeql-analysis.yml` (+1 -1) 📝 `.github/workflows/test-repos.yml` (+3 -3) ➕ `.github/workflows/update-test-repos.yml` (+41 -0) 📝 `.gitignore` (+4 -0) 📝 `CHANGELOG.md` (+10 -0) 📝 `README.md` (+32 -59) 📝 `demo/browser-exports.mjs` (+1 -0) 📝 `demo/default.css` (+4 -1) 📝 `demo/default.js` (+39 -20) 📝 `doc-build/build-rules.mjs` (+3 -3) 📝 `doc-build/md001.md` (+9 -0) 📝 `doc-build/md010.md` (+6 -0) 📝 `doc-build/md033.md` (+5 -1) 📝 `doc-build/md045.md` (+9 -1) 📝 `doc-build/md051.md` (+7 -0) 📝 `doc-build/md052.md` (+11 -0) _...and 80 more files_ </details> ### 📄 Description This pull request introduces several improvements and updates to the project's workflows, documentation, and demo code. The main changes include upgrading GitHub Actions to newer versions, adding a new workflow for updating test repositories, documenting a new rule, updating Node.js support, and refining the demo's error highlighting and Markdown rendering. **Workflow and CI/CD updates:** * Upgraded all usages of `actions/checkout` and `actions/setup-node` to version 5 across multiple workflow files (`ci.yml`, `checkers.yml`, `test-repos.yml`, `codeql-analysis.yml`, and the new `update-test-repos.yml`), ensuring compatibility and leveraging the latest features and security patches. [[1]](diffhunk://#diff-b803fcb7f17ed9235f1e5cb1fcd2f5d3b2838429d4368ae4c57ce4436577f03fL20-R43) [[2]](diffhunk://#diff-75ce2c11fc176663baa945e4eb1ccea1722308ad0d643eedca9902b98b5d4e2dL15-R24) [[3]](diffhunk://#diff-59522457c1791b743d2bf5225385ac23cc7e7a1d6f27653815a16634d1d23077L21-R27) [[4]](diffhunk://#diff-63bd641104d10e25f141d518a16b22a151d125e12701df2f9e79734b23b90188L24-R24) [[5]](diffhunk://#diff-f5f6e3cd2268b85bf05533b209bfd92325fc8c72fbb0534b72925ebf27880eccR1-R41) * Added a new workflow file `.github/workflows/update-test-repos.yml` to automate updating test repository snapshots, including scheduled and manual triggers, branch management, and pull request creation. **Documentation and changelog:** * Updated `README.md` to document the new `MD060/table-column-style` rule and reflect its inclusion in the `table` rules group, clarified configuration extension via `extends`, and improved usage examples to show more detailed result objects and modern usage patterns. [[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R152) [[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L193-R194) [[3]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L424-R427) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L674-R671) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L852-R840) [[6]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L867-R869) [[7]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L903-R878) [[8]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L915-L946) [[9]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L972-R945) * Added a new entry for `encodings` in `.github/dictionary.txt` to support spellchecking. * Updated `CHANGELOG.md` for version 0.38.0, summarizing major changes such as the new rule, parser dependency updates, Node version deprecation, and performance improvements. **Node.js and dependency management:** * Removed support for Node.js version 18 in CI matrix and updated dependencies, reflecting the project's move to support newer Node versions only. [[1]](diffhunk://#diff-b803fcb7f17ed9235f1e5cb1fcd2f5d3b2838429d4368ae4c57ce4436577f03fL20-R43) [[2]](diffhunk://#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR3-R12) **Demo and browser improvements:** * Enhanced the demo by exporting `frontMatterRe` from `markdownlint/helpers` in `browser-exports.mjs`, stripping front matter before rendering Markdown, and adding robust error highlighting for lines and character ranges in the rendered output. Also improved CSS for error and highlight classes. [[1]](diffhunk://#diff-3b49c3559c5cd0519ca76de869a7e1334e79e2f9421f964ad2795f0901af7791R5) [[2]](diffhunk://#diff-8e6fd88219737db8786c5ad2289c4fb20bdc5a0749dac041324dfbb971f38bdaR52) [[3]](diffhunk://#diff-8e6fd88219737db8786c5ad2289c4fb20bdc5a0749dac041324dfbb971f38bdaR89-R104) [[4]](diffhunk://#diff-3978e3a8807fa8e5d83c46ec2c37d9a9903478c285802c9049a5e64dec8ec625R50-R52) [[5]](diffhunk://#diff-3978e3a8807fa8e5d83c46ec2c37d9a9903478c285802c9049a5e64dec8ec625L67-R70) **Codacy integration instructions:** * Added `.github/instructions/codacy.instructions.md` with detailed guidelines for interacting with Codacy's MCP Server, including mandatory analysis steps after file edits and dependency changes, troubleshooting, and security check requirements. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>