markdown-table-formatter 1.4.0 → 1.5.0

package/README.md

@@ -16,6 +16,19 @@ Format markdown tables in files, using embedded [markdown-table-prettify](https:
 
 [![Banner](https://raw.githubusercontent.com/nvuillam/markdown-table-formatter/master/docs/assets/images/banner.jpg)](https://github.com/nvuillam/markdown-table-formatter#readme)
 
+## Table of contents
+
+- [Installation](#installation)
+  - [Local](#local)
+  - [Global](#global)
+- [Usage](#usage)
+  - [Options](#options)
+- [Examples](#examples)
+- [Continuous Integration](#continuous-integration)
+- [Ignoring Code Blocks](#ignoring-code-blocks)
+- [Contribute](#contribute)
+- [Release notes](#release-notes)
+
 ## Installation
 
 ### Local
@@ -87,28 +100,20 @@ You can see **more examples in** [**test methods**](https://github.com/nvuillam/
 
 ## Continuous Integration
 
-You can automatically check markdown tables formatting and fix it using [Mega-Linter](https://github.com/nvuillam/mega-linter/), that embeds markdown-table-formatter out of the box
-
-## CONTRIBUTE
+You can automatically check markdown tables formatting and fix it using [MegaLinter](https://github.com/oxsecurity/megalinter/), that embeds markdown-table-formatter out of the box
 
-Contributions are very welcome !
-
-Please follow [Contribution instructions](https://github.com/nvuillam/markdown-table-formatter/blob/master/CONTRIBUTING.md)
+## Ignoring Code Blocks
 
-## RELEASE NOTES
+You may wish to ignore specific markdown content, especially when using with [Megalinter](https://github.com/oxsecurity/megalinter) or [terraform-docs](https://github.com/terraform-docs/terraform-docs)
 
-## [1.0.2] 2021-01-19
+To achieve this, place tags `<!-- markdown-table-prettify-ignore-start -->` and `<!-- markdown-table-prettify-ignore-end -->` around the content you want markdown-table-formatter to ignore.
 
-- Fix code coverage
+## Contribute
 
-## [1.0.1] 2021-01-13
-
-- First working version :)
-
-## [0.0.1] 2021-01-13
+Contributions are very welcome !
 
-- Initial version
+Please follow [Contribution instructions](https://github.com/nvuillam/markdown-table-formatter/blob/master/CONTRIBUTING.md)
 
-____
+## Release Notes
 
 See complete [CHANGELOG](https://github.com/nvuillam/markdown-table-formatter/blob/master/CHANGELOG.md)

package/lib/cli.js

@@ -33,7 +33,7 @@ class MarkdownTableFormatterCli {
       let helpContent = "";
       if (this.options._.length) {
         helpContent = optionsDefinition.generateHelpForOption(
-          this.options._[0]
+          this.options._[0],
         );
       } else {
         helpContent = optionsDefinition.generateHelp();
@@ -60,13 +60,13 @@ class MarkdownTableFormatterCli {
       console.log(
         `Formatted markdown tables in ${
           updates.length
-        } files:\n- ${updates.join("\n- ")}`
+        } files:\n- ${updates.join("\n- ")}`,
       );
     } else if (status === 1) {
       console.log(
         `${
           updates.length
-        } files contain markdown tables to format:\n- ${updates.join("\n- ")}`
+        } files contain markdown tables to format:\n- ${updates.join("\n- ")}`,
       );
     }
     process.exitCode = status;

package/lib/markdown-table-formatter.js

@@ -44,7 +44,7 @@ class MarkdownTableFormatter {
       }
       const markdownStringPrettified = CliPrettify.prettify(
         markdownString,
-        prettifyOptions
+        prettifyOptions,
       );
       const updated = markdownStringPrettified !== markdownString;
       // Update file if necessary

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-table-formatter",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Format markdown tables in files",
   "main": "./lib/index.js",
   "files": [
@@ -33,23 +33,23 @@
   },
   "homepage": "https://github.com/nvuillam/markdown-table-formatter#readme",
   "dependencies": {
-    "debug": "^4.1.1",
+    "debug": "^4.3.4",
     "find-package-json": "^1.2.0",
-    "fs-extra": "^9.0.1",
-    "glob": "^7.1.6",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.10",
     "markdown-table-prettify": "^3.6.0",
-    "optionator": "^0.9.1"
+    "optionator": "^0.9.3"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.16.5",
-    "eslint": "^7.6.0",
-    "mega-linter-runner": "^4.23.1",
-    "mocha": "^8.1.1",
+    "@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": "^2.0.2"
+    "which": "^4.0.0"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0"
   },
   "mocha": {
     "require": [

package/CHANGELOG.md

@@ -1,34 +0,0 @@
-# Changelog
-
-## [1.4.0] 2022-07-25
-
-- Add --verbose mode
-- Dependencies: run `npm audit fix` to secure dependencies
-- CI: Upgrade [MegaLinter](https://oxsecurity.github.io/megalinter/latest/) to v6
-
-## [1.3.0] 2022-01-31
-
-- Allow to override the table columns padding number of spaces using argument **--columnpadding**
-- CI: Upgrade MegaLinter to v5 + fix CI tests on Windows & Mac
-
-## [1.2.0] 2021-08-20
-
-- Allow to call markdown-table-formatter with a glob parameter to find files to format
-- Allow to call markdown-table-formatter without arguments (**/*.md will be used by default to collect files)
-- Fix logs format
-
-## [1.1.0] 2021-04-05
-
-- Upgrade markdown-table-prettify to 3.4.0 so it can take in account inline disable comments
-
-## [1.0.2] 2021-01-19
-
-- Fix code coverage
-
-## [1.0.1] 2021-01-14
-
-- First working version :)
-
-## [0.0.1] 2021-01-13
-
-- Initial version