Skip to content

markdown-table-formatter

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

markdown-table-formatter documentation

markdown-table-formatter - GitHub

Configuration in Mega-Linter

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_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_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 Mega-Linter !

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

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 84 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 38 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 37 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 43 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 39 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 38 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 46 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 41 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 44 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 38 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 38 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 38 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 38 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 38 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 40 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .md

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)
  -h, --help     Show help
  -v, --version  Show version

Installation on mega-linter Docker image