Replace dprint with rumdl for MD #1680
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # rumdl configuration file | ||
|
|
||
| [global] | ||
| # disable = ["MD013", "MD033"] | ||
|
|
||
| # List of rules to enable exclusively (replaces defaults; only these rules will run) | ||
| # enable = ["MD001", "MD003", "MD004"] | ||
|
|
||
| # Additional rules to enable on top of defaults (additive, does not replace) | ||
| extend-enable = ["MD060", "MD063", "MD070", "MD073"] | ||
|
|
||
| # Additional rules to disable on top of the disable list (additive) | ||
| # extend-disable = ["MD041"] | ||
|
|
||
| # List of file/directory patterns to include for linting (if provided, only these will be linted) | ||
| # include = [ | ||
| # "docs/*.md", | ||
| # "src/**/*.md", | ||
| # "README.md" | ||
| # ] | ||
|
|
||
| # List of file/directory patterns to exclude from linting | ||
| exclude = [ | ||
| ".git", | ||
| ".github", | ||
| "CHANGELOG.md", | ||
| "documentation", | ||
| "examples", | ||
| "shared", | ||
| "text-runner-cli", | ||
| "text-runner-engine", | ||
| "text-runner-features", | ||
| "textrun-action", | ||
| "textrun-extension", | ||
| "textrun-javascript", | ||
| "textrun-make", | ||
| "textrun-npm", | ||
| "textrun-repo", | ||
| "textrun-shell", | ||
| "textrun-workspace" | ||
| ] | ||
|
|
||
| # Respect .gitignore files when scanning directories (default: true) | ||
| respect-gitignore = true | ||
|
|
||
| # Markdown flavor/dialect (uncomment to enable) | ||
| # Options: standard (default), gfm, commonmark, mkdocs, mdx, quarto | ||
| flavor = "gfm" | ||
|
|
||
| # Rule-specific configurations (uncomment and modify as needed) | ||
|
|
||
| # text-wrap | ||
| [MD013] | ||
| line-length = 80 | ||
| reflow = true # Enable automatic text reflow/wrapping | ||
| reflow-mode = "semantic-line-breaks" # Reflow mode: "default", "normalize", "sentence-per-line", or "semantic-line-breaks" (default: "default") | ||
| length-mode = "visual" # How to count line length: "visual", "chars", or "bytes" (default: "visual") | ||
| code-blocks = false # Exclude code blocks from line length check | ||
| tables = false # Exclude tables from line length check | ||
| # headings = true # Include headings in line length check | ||
|
|
||
| [MD044] | ||
| names = ["rumdl", "Markdown"] # Proper names that should be capitalized correctly | ||
| # code-blocks = false # Check code blocks for proper names (default: false, skips code blocks) | ||
|
|
||
| # format tables | ||
| [MD060] | ||
| enabled = true | ||
| style = "aligned-no-space" | ||
|
|
||
| # Case style for headings | ||
| [MD063] | ||
| enabled = true | ||
| style = "sentence-case" | ||
| ignore-words = ["iPhone", "macOS", "GitHub", "JavaScript", "TypeScript"] | ||
| preserve-cased-words = true |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,11 @@ | ||
| # Contributing to Text-Runner | ||
|
|
||
| First and foremost, thank you! | ||
| We appreciate every contribution no matter how big or small. | ||
| Your time is valuable and your support means a lot to us. | ||
|
|
||
| If you have a question, want to share an idea, | ||
| or report a problem please | ||
| [open an issue](https://github.com/kevgo/text-runner/issues/new). | ||
| To get started coding, please see our | ||
| [developer guide](documentation/DEVELOPMENT.md). |
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| This folder contains workspaces for end-to-end tests. | ||
| The current ESM implementation requires `text-runner` | ||
| and `typescript` installed into a `node_modules` folder. | ||
| Since it takes too much time to `yarn install` this for every end-to-end test, | ||
| the workspaces in which tests happen are now part of the Yarn multi-workspace | ||
| setup in this monorepo. |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Root-level YAML formatting lost after replacing dprint command
Medium Severity
The
fixtarget replaceddprint fmtentirely withrumdl fmt ., butdprint fmtwas responsible for both Markdown and YAML formatting. Now only Markdown formatting runs viarumdl. The rootdprint.jsonstill contains the YAML plugin and config, butdprint fmtis never invoked from the root Makefile, so YAML files (e.g., under.github/workflows/) silently stop being formatted. Adprint fmtcall likely needs to remain alongsiderumdl fmt ..Additional Locations (1)
dprint.json#L10-L12