ci: lint Markdown files with markdownlint instead of prettier#548
Open
mvadari wants to merge 12 commits into
Open
ci: lint Markdown files with markdownlint instead of prettier#548mvadari wants to merge 12 commits into
mvadari wants to merge 12 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repo’s Markdown linting approach by switching Markdown formatting/lint checks from Prettier to markdownlint-cli, adding the required configuration and CI wiring, and applying automated fixes across existing spec Markdown files to conform to the new rules.
Changes:
- Add
markdownlint-clito pre-commit and GitHub Actions, with repo-specific configuration/ignore files. - Stop running Prettier on
*.md(via pre-commit exclude and.prettierignore) and document local linting inCONTRIBUTING.md. - Apply markdownlint-driven formatting updates across many existing XLS Markdown documents (primarily table/list formatting).
Reviewed changes
Copilot reviewed 66 out of 73 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/lint.yml |
Adds a markdownlint job alongside existing Prettier checks. |
.markdownlint.yaml |
Adds repository markdownlint rule configuration. |
.markdownlintignore |
Adds ignore paths for markdownlint runs. |
.pre-commit-config.yaml |
Excludes Markdown from Prettier and adds a markdownlint pre-commit hook. |
.prettierignore |
Prevents Prettier from checking Markdown files. |
CONTRIBUTING.md |
Documents how to run linting locally via pre-commit. |
templates/AMENDMENT_TEMPLATE.md |
Reformats tables/quotes for markdownlint compliance. |
XLS-0001-xls-process/README.md |
Minor spacing/link formatting to satisfy markdownlint. |
XLS-0005-tagged-addresses/README.md |
Table formatting updates for markdownlint. |
XLS-0007-deletable-accounts/README.md |
Table formatting updates for markdownlint. |
XLS-0008-tickets/README.md |
Table formatting updates for markdownlint. |
XLS-0009-blinded-tags/README.md |
Table/heading punctuation formatting updates for markdownlint. |
XLS-0011-retiring-amendments/README.md |
Table formatting updates for markdownlint. |
XLS-0012-secret-numbers/README.md |
Table formatting updates for markdownlint. |
XLS-0013-tickets/README.md |
Table formatting updates for markdownlint. |
XLS-0015-concise-tx-id/README.md |
Table separator formatting updates for markdownlint. |
XLS-0017-xfl/README.md |
Table formatting updates for markdownlint. |
XLS-0021-asset-code-prefixes/README.md |
Table formatting updates for markdownlint. |
XLS-0023-lite-accounts/README.md |
Table formatting updates for markdownlint. |
XLS-0024-nft-metadata/README.md |
Heading punctuation and table formatting updates for markdownlint. |
XLS-0025-enhanced-secret-numbers/README.md |
Table formatting updates for markdownlint. |
XLS-0026-iou-token-metadata/README.md |
Table formatting updates for markdownlint. |
XLS-0032-tx-request-uri/README.md |
List indentation and formatting updates for markdownlint. |
XLS-0034-paychan-escrow-for-tokens/README.md |
Heading punctuation and table formatting updates for markdownlint. |
XLS-0035-uritoken/README.md |
Table formatting updates for markdownlint. |
XLS-0037-concise-transaction-identifier-ctid/README.md |
Table formatting updates for markdownlint. |
XLS-0037-concise-transaction-identifier-ctid/QUICKSTART.md |
Table formatting updates for markdownlint. |
XLS-0037-concise-transaction-identifier-ctid/ctid.py |
Removes trailing whitespace flagged by linting. |
XLS-0039-clawback/README.md |
Table formatting updates for markdownlint. |
XLS-0040-decentralized-identity/README.md |
Table/heading punctuation and JSON example indentation updates for markdownlint. |
XLS-0041-xpop/README.md |
Front-matter and JSON example indentation updates for markdownlint. |
XLS-0042-plugins/README.md |
Ordered list formatting updates for markdownlint. |
XLS-0045-prepublish-validator-lists/README.md |
Table formatting and heading punctuation updates for markdownlint. |
XLS-0046-dynamic-non-fungible-tokens/README.md |
List/table formatting updates for markdownlint. |
XLS-0047-PriceOracles/README.md |
Table/list formatting updates for markdownlint. |
XLS-0049-multiple-signer-lists/README.md |
Table formatting updates for markdownlint. |
XLS-0051-nftoken-escrow/README.md |
Table formatting updates for markdownlint. |
XLS-0052-NFTokenMintOffer/README.md |
Table formatting updates for markdownlint. |
XLS-0054-nftokenoffer-destination-tag/README.md |
Table formatting updates for markdownlint. |
XLS-0055-remit/README.md |
Converts an ad-hoc table into a proper Markdown table. |
XLS-0056-batch/README.md |
Table formatting updates for markdownlint. |
XLS-0061-cross-currency-nftokenacceptof/README.md |
Table formatting updates for markdownlint. |
XLS-0062-options/README.md |
Table formatting updates for markdownlint. |
XLS-0063-signin/README.md |
Table formatting updates for markdownlint. |
XLS-0064-pseudo-account/README.md |
Table formatting updates for markdownlint. |
XLS-0067-charge/README.md |
Table formatting updates for markdownlint. |
XLS-0069-simulate/README.md |
Table formatting updates for markdownlint. |
XLS-0070-credentials/README.md |
Table formatting updates for markdownlint (incl. new table delimiter row). |
XLS-0073-amm-clawback/README.md |
Table formatting updates for markdownlint. |
XLS-0074-account-permissions/README.md |
Table formatting updates for markdownlint. |
XLS-0075-permission-delegation/README.md |
Table formatting updates for markdownlint. |
XLS-0076-min-incoming-amount/README.md |
Table formatting updates for markdownlint. |
XLS-0077-deep-freeze/README.md |
Table formatting updates for markdownlint. |
XLS-0078-subscriptions/README.md |
Table formatting updates for markdownlint. |
XLS-0080-permissioned-domains/README.md |
Table formatting and minor wording/parentheses change for markdownlint. |
XLS-0085-token-escrow/README.md |
Table formatting updates and trims a stray space inside inline code. |
XLS-0086-firewall/README.md |
Table formatting updates for markdownlint. |
XLS-0089-multi-purpose-token-metadata-schema/README.md |
Table formatting updates for markdownlint. |
XLS-0094-dynamic-MPT/README.md |
Table formatting updates and removes trailing punctuation from a heading. |
XLS-0100-smart-escrows/README.md |
Large set of table formatting updates for markdownlint. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # MD028: Blank line inside blockquote | ||
| # Disabled: Multi-paragraph blockquotes are valid | ||
| # MD028: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
High Level Overview of Change
Context of Change
Type of Change