markdown-table-formatter

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

markdown-table-formatter documentation

• Version in Mega-Linter: 1.2.0
• Visit Official Web Site

Configuration in Mega-Linter

• 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	{linter.cli_lint_mode}
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 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	94
	dart	Optimized for DART based projects	41
	documentation	Mega-Linter for documentation projects	40
	dotnet	Optimized for C, C++, C# or VB based projects	47
	go	Optimized for GO based projects	42
	java	Optimized for JAVA based projects	42
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	49
	php	Optimized for PHP based projects	44
	python	Optimized for PYTHON based projects	49
	ruby	Optimized for RUBY based projects	41
	rust	Optimized for RUST based projects	41
	salesforce	Optimized for Salesforce based projects	43
	scala	Optimized for SCALA based projects	41
	swift	Optimized for SWIFT based projects	41
	terraform	Optimized for TERRAFORM based projects	45

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

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

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