nvuillam / markdown-table-formatter Goto Github PK

View Code? Open in Web Editor NEW

19.0 3.0 2.0 721 KB

Check markdown tables formatting and apply fixes

License: MIT License

JavaScript 100.00%

formatter markdown markdown-table megalinter prettier prettify table

markdown-table-formatter's Introduction

Markdown table formatter

Format markdown tables in files, using embedded markdown-table-prettify

Installation
- Local
- Global
Usage
- Options
Examples
Continuous Integration
Ignoring Code Blocks
Contribute
Release notes

Installation

Local

npm install markdown-table-formatter --save

Global

npm install markdown-table-formatter -g

Usage

markdown-table-formatter [OPTIONS] (file(s) or glob expression)

Options

Parameter	Description	Default value
-c --check	Check only, does not update files	`false`
-p --columnpadding	Override column padding number of spaces
-h --help	Displays help
-v --version	Displays version

Examples

Format all markdown files found within current directory

markdown-table-formatter

Format all markdown files found with a glob expression

markdown-table-formatter **/docs/*.md

Format markdown tables in a single file

markdown-table-formatter myfile.md

Format markdown tables in a multiple file

markdown-table-formatter myfile.md anotherFile.md andAnotherFile.md

Check if markdown table formatting is necessary in a single file

markdown-table-formatter --check myfile.md

Check if markdown table formatting is necessary in a multiple files

markdown-table-formatter --check myfile.md anotherFile.md andAnotherFile.md

You can see more examples in test methods

Continuous Integration

You can automatically check markdown tables formatting and fix it using MegaLinter, that embeds markdown-table-formatter out of the box

Ignoring Code Blocks

You may wish to ignore specific markdown content, especially when using with Megalinter or terraform-docs

To achieve this, place tags  and  around the content you want markdown-table-formatter to ignore.

Contribute

Contributions are very welcome !

Please follow Contribution instructions

Release Notes

See complete CHANGELOG

markdown-table-formatter's People

Contributors

Stargazers

Watchers

Forkers

ddffttd rolfmoleman

markdown-table-formatter's Issues

tables not starting with | are ignored

Label | Label
-|-
Row | Row

Is not recognized, but rendered correctly in visual studio code preview. I think it should at least warn the user about formatting this table.

Config option for spacing

The formatter currently expects this:

| First Header | Second Header |
|--------------|---------------|
| Content Cell | Content Cell  |
| Content Cell | Content Cell  |

but should have the option to allow this:

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

Support for ignoring specific doc sections

The maintainer of the MarkdownTablePrettify extension was kind enough to add my requested support for ignoring blocks via code comments in release v3.4.0.

How difficult would it be to upgrade this tool to use the new package version so this functionality can be used via the Mega Linter? Happy to provide a PR if that helps.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Update peter-evans/create-pull-request action to v6

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions

.github/workflows/deploy-PROD.yml

actions/checkout v4

actions/setup-node v4.0.2

.github/workflows/deploy-RELEASE.yml

actions/checkout v4

actions/setup-node v4.0.2

.github/workflows/github-dependents-info.yml

actions/checkout v4

peter-evans/create-pull-request v5

.github/workflows/mega-linter.yml

actions/checkout v4

oxsecurity/megalinter v7

actions/upload-artifact v4

peter-evans/create-pull-request v5

stefanzweifel/git-auto-commit-action v5

.github/workflows/test.yml

actions/checkout v4

actions/setup-node v4.0.2

actions/checkout v4

actions/setup-node v4.0.2

actions/checkout v4

actions/setup-node v4.0.2

npm

package.json

debug ^4.3.4

find-package-json ^1.2.0

fs-extra ^11.1.1

glob ^10.3.10

markdown-table-prettify ^3.6.0

optionator ^0.9.3

@babel/eslint-parser ^7.23.3

eslint ^8.54.0

mega-linter-runner ^7.6.0

mocha ^10.2.0

nyc ^15.1.0

which ^4.0.0

node >=18.0.0

Check this box to trigger a request for Renovate to run again on this repository

[💡 idea: ] ability to ignore sections of markdown akin to markdownlint

I really like the formatter. Howeverm, it can cause a continuous PR loop which consumes excessive action minutes, when used with tools such as terraform-docs.

Why

Terraform docs gnerates terrform documentation into markdown, but then when using megalinter the markdown-table-formatter picks up that the table is incorrectly formatted and attempts to reformat it. which then on our rlelease pieplien causes terraform-docs to run afgain, createing a fresh (or reopening) a pr from megalinter where the only changes are from this.

What

would it be possible to implement markdown comment blocks where this ignores the code between them akin to  and  in markdownlint or  and  in prettier

Missing carriage return in log

cf oxsecurity/megalinter#665