markdown-table-formatter

markdown-table-formatter detects wrongly formatted markdown tables and can automatically reformat them

markdown-table-formatter documentation

Version in MegaLinter: 1.4.0
Visit Official Web Site

Configuration in MegaLinter

Enable markdown-table-formatter by adding MARKDOWN_MARKDOWN_TABLE_FORMATTER in ENABLE_LINTERS variable
Disable markdown-table-formatter by adding MARKDOWN_MARKDOWN_TABLE_FORMATTER in DISABLE_LINTERS variable

Enable auto-fixes by adding MARKDOWN_MARKDOWN_TABLE_FORMATTER in APPLY_FIXES variable

Variable	Description	Default value
MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `list_of_files`: Call the linter with the list of files as argument - `project`: Call the linter from the root of the project	`list_of_files`
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".md"]`
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]`	Include every file
MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS	List of bash commands to run before the linter	None
MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS	List of bash commands to run after the linter	None
MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS	Run linter but consider errors as warnings	`true`
MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`

IDE Integration

Use markdown-table-formatter in your favorite IDE to catch errors before MegaLinter !

	IDE	Extension Name	Install
	Visual Studio Code	Markdown Table Prettify Extension	Visit Web Site

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	114
cupcake	MegaLinter for the most commonly used languages	82
documentation	MegaLinter for documentation projects	48
dotnet	Optimized for C, C++, C# or VB based projects	60
go	Optimized for GO based projects	50
java	Optimized for JAVA based projects	51
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	57
php	Optimized for PHP based projects	51
python	Optimized for PYTHON based projects	59
ruby	Optimized for RUBY based projects	48
rust	Optimized for RUST based projects	48
salesforce	Optimized for Salesforce based projects	51
swift	Optimized for SWIFT based projects	48
terraform	Optimized for TERRAFORM based projects	53

Behind the scenes

How are identified applicable files

File extensions: .md

How the linting is performed

markdown-table-formatter is called once with the list of files as arguments (list_of_files CLI lint mode)

Example calls

markdown-table-formatter --check myfile.md

markdown-table-formatter myfile.md

markdown-table-formatter myfile.md myfile2.md myfile3.md

Help content

markdown-table-formatter [options]

  -c, --check              Check only (exits 1 if wrongly formatted markdown tables are found)
  -p, --columnpadding Int  Override table columns padding number of spaces
  -h, --help               Show help
  -v, --version            Show version
  -z, --verbose            Verbose mode

Installation on mega-linter Docker image

NPM packages (node.js):
- markdown-table-formatter