markdown-table-formatter
markdown-table-formatter detects wrongly formatted markdown tables and can automatically reformat them
markdown-table-formatter documentation
- Version in MegaLinter: 1.6.1
- 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 autofixes 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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter 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 filesEx: [".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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWN_TABLE_FORMATTER and its pre/post commands | 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 |
MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE | Override CLI executable | ['markdown-table-formatter'] |
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 | Info | |
---|---|---|---|---|
all | Default MegaLinter Flavor | 125 | ||
c_cpp | Optimized for pure C/C++ projects | 56 | ||
cupcake | MegaLinter for the most commonly used languages | 84 | ||
documentation | MegaLinter for documentation projects | 51 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 63 | ||
dotnetweb | Optimized for C, C++, C# or VB based projects with JS/TS | 72 | ||
formatters | Contains only formatters | 17 | ||
go | Optimized for GO based projects | 53 | ||
java | Optimized for JAVA based projects | 54 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 | ||
php | Optimized for PHP based projects | 56 | ||
python | Optimized for PYTHON based projects | 64 | ||
ruby | Optimized for RUBY based projects | 52 | ||
rust | Optimized for RUST based projects | 52 | ||
salesforce | Optimized for Salesforce based projects | 56 | ||
swift | Optimized for SWIFT based projects | 52 | ||
terraform | Optimized for TERRAFORM based projects | 56 |
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):