markdownlint-cli2 0.9.2 → 0.10.0

package/CHANGELOG.md

@@ -0,0 +1,155 @@
+# Changelog
+
+## 0.10.0
+
+- Add `showFound` configuration option
+- Add `.markdownlint-cli2.jsonc` config schema
+- Update dependencies (including `markdownlint`)
+
+## 0.9.2
+
+- Remove `npm-shrinkwrap.json` entirely to avoid `npm` failures
+
+## 0.9.1
+
+- Remove `devDependencies` from `npm-shrinkwrap.json` to avoid `npm` failures
+
+## 0.9.0
+
+- Add support for Node.js's `package.json` as a configuration file source
+- Add output formatter for Static Analysis Results Interchange Format/SARIF
+- Bundle `npm-shrinkwrap.json` for reproducible/faster installs
+- Update dependencies (including `markdownlint`)
+
+## 0.8.1
+
+- Handle `--config` edge case
+
+## 0.8.0
+
+- Add support for `--config` and `--fix` parameters
+- Update dependencies (including `markdownlint`)
+- Remove support for end-of-life Node 14
+
+## 0.7.1
+
+- Update dependencies (including `markdownlint`)
+
+## 0.7.0
+
+- Add support for `extends` in `config` property of `.markdownlint-cli2.*` files
+- Build and publish `davidanson/markdownlint-cli2-rules` Docker container image
+- Update dependencies (including `markdownlint`)
+
+## 0.6.0
+
+- Update dependencies (including `markdownlint`)
+
+## 0.5.1
+
+- Update dependencies
+
+## 0.5.0
+
+- New rules
+- Support modules (MJS) everywhere
+- Include dotfiles
+
+## 0.4.0
+
+- New rules
+- Async custom rules
+- Explicit config
+- CJS (breaking)
+
+## 0.3.2
+
+- Extensibility/Windows/consistency improvements
+
+## 0.3.1
+
+- Extensibility tweaks
+
+## 0.3.0
+
+- Add Docker container
+- Update dependencies
+
+## 0.2.0
+
+- Improve handling of Windows paths using backslash
+
+## 0.1.3
+
+- Support rule collections
+
+## 0.1.2
+
+- Update use of `require` to be more flexible
+
+## 0.1.1
+
+- Restore previous use of `require`
+
+## 0.1.0
+
+- Simplify use of `require`
+- Increment minor version
+
+## 0.0.15
+
+- Improve extensibility
+
+## 0.0.14
+
+- Update dependencies (including `markdownlint`)
+
+## 0.0.13
+
+- Add `markdownlint-cli2-fix` command
+
+## 0.0.12
+
+- Update dependencies (including `markdownlint`)
+
+## 0.0.11
+
+- Improve performance of `fix`
+- Update banner
+
+## 0.0.10
+
+- Improve performance and configuration
+
+## 0.0.9
+
+- Improve configuration file handling
+
+## 0.0.8
+
+- Support `.markdownlint-cli2.yaml`
+- Add progress
+
+## 0.0.7
+
+- Support `.markdownlint-cli2.js` and `.markdownlint.js`
+
+## 0.0.6
+
+- Improve handling of very large directory trees
+
+## 0.0.5
+
+- Improve support for ignoring files
+
+## 0.0.4
+
+- Support output formatters and `markdown-it` plugins
+
+## 0.0.3
+
+- Feature parity with `markdownlint-cli`
+
+## 0.0.2
+
+- Initial release

package/README.md

@@ -167,7 +167,7 @@ A container image [`davidanson/markdownlint-cli2`][docker-hub-markdownlint-cli2]
 can also be used (e.g., as part of a CI pipeline):
 
 ```bash
-docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.9.2 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.10.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -184,7 +184,7 @@ Notes:
   - A custom working directory can be specified with Docker's `-w` flag:
 
     ```bash
-    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.9.2 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.10.0 "**/*.md" "#node_modules"
     ```
 
 > **Deprecated**
@@ -193,7 +193,7 @@ Notes:
 > instead, use Docker's `--entrypoint` flag:
 >
 > ```bash
-> docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.9.2 "**/*.md" "#node_modules"
+> docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.10.0 "**/*.md" "#node_modules"
 > ```
 
 For convenience, the container image
@@ -320,6 +320,9 @@ of the rules within.
     - This top-level setting is valid **only** in the directory from which
       `markdownlint-cli2` is run
     - Search [`markdownlint-cli2-formatter` on npm][markdownlint-cli2-formatter]
+  - `showFound`: `Boolean` value to display the list of found files on `stdout`
+    - This top-level setting is valid **only** in the directory from which
+      `markdownlint-cli2` is run and **only** when `noProgress` has not been set
 - When referencing a module via the `customRules`, `markdownItPlugins`, or
   `outputFormatters` properties, each `String` identifier is passed to Node's
   [`require` function][nodejs-require] then (if that failed) its
@@ -412,7 +415,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 ```yaml
 - repo: https://github.com/DavidAnson/markdownlint-cli2
-  rev: v0.9.2
+  rev: v0.10.0
   hooks:
   - id: markdownlint-cli2
 ```

package/markdownlint-cli2.js

@@ -26,7 +26,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.9.2";
+const packageVersion = "0.10.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -950,9 +950,15 @@ const main = async (params) => {
     );
   // Output linting status
   if (showProgress) {
-    let fileCount = 0;
-    for (const dirInfo of dirInfos) {
-      fileCount += dirInfo.files.length;
+    const fileNames = dirInfos.flatMap((dirInfo) => {
+      const { files } = dirInfo;
+      return files.map((file) => pathPosix.relative(baseDir, file));
+    });
+    const fileCount = fileNames.length;
+    if (baseMarkdownlintOptions.showFound) {
+      fileNames.push("");
+      fileNames.sort();
+      logMessage(`Found:${fileNames.join("\n ")}`);
     }
     logMessage(`Linting: ${fileCount} file(s)`);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -22,25 +22,27 @@
   "homepage": "https://github.com/DavidAnson/markdownlint-cli2",
   "repository": {
     "type": "git",
-    "url": "https://github.com/DavidAnson/markdownlint-cli2.git"
+    "url": "git+https://github.com/DavidAnson/markdownlint-cli2.git"
   },
   "bugs": "https://github.com/DavidAnson/markdownlint-cli2/issues",
   "scripts": {
     "build-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker build -t davidanson/markdownlint-cli2:v$VERSION -f docker/Dockerfile --label org.opencontainers.image.version=v$VERSION .",
     "build-docker-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker build -t davidanson/markdownlint-cli2-rules:v$VERSION -f docker/Dockerfile-rules --build-arg VERSION=v$VERSION --label org.opencontainers.image.version=v$VERSION .",
-    "ci": "npm-run-all --continue-on-error --parallel test-cover lint",
+    "ci": "npm-run-all --continue-on-error --parallel test-cover lint schema",
     "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm install",
     "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm run upgrade",
     "lint": "eslint --max-warnings 0 --no-eslintrc --config .eslintrc.json .",
     "lint-dockerfile": "docker run --rm -i hadolint/hadolint:latest-alpine < docker/Dockerfile",
     "lint-watch": "git ls-files | entr npm run lint",
     "publish-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker buildx build --platform linux/arm64,linux/amd64 -t davidanson/markdownlint-cli2:v$VERSION -t davidanson/markdownlint-cli2:latest -f docker/Dockerfile --push .",
+    "schema": "cpy ./node_modules/markdownlint/schema/markdownlint-config-schema.json ./schema --flat",
     "test": "ava --timeout=1m test/append-to-array-test.js test/fs-mock-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
-    "test-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\"",
-    "test-docker-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:v$VERSION \"*.md\"",
+    "test-cover": "c8 --100 npm test -- --concurrency=1",
     "test-docker-hub-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2:v$VERSION davidanson/markdownlint-cli2:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:latest \"*.md\"",
     "test-docker-hub-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2-rules:v$VERSION davidanson/markdownlint-cli2-rules:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:v$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:latest \"*.md\"",
-    "test-cover": "c8 --100 npm test -- --concurrency=1",
+    "test-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\"",
+    "test-docker-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:v$VERSION \"*.md\"",
+    "test-invoke-as-cli": "markdownlint-cli2 CHANGELOG.md",
     "test-watch": "git ls-files | entr npm run test",
     "update-snapshots": "ava --timeout=1m --update-snapshots test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js",
     "upgrade": "npx --yes npm-check-updates --upgrade",
@@ -52,30 +54,36 @@
   },
   "files": [
     "append-to-array.js",
+    "CHANGELOG.md",
     "export-markdownlint.js",
     "export-markdownlint-helpers.js",
+    "LICENSE",
     "markdownlint-cli2.js",
     "markdownlint-cli2-config.js",
     "markdownlint-cli2-fix.js",
     "merge-options.js",
-    "resolve-and-require.js"
+    "README.md",
+    "resolve-and-require.js",
+    "schema/markdownlint-cli2-config-schema.json",
+    "schema/markdownlint-config-schema.json"
   ],
   "dependencies": {
     "globby": "13.2.2",
-    "markdownlint": "0.30.0",
+    "markdownlint": "0.31.1",
     "markdownlint-cli2-formatter-default": "0.0.4",
     "micromatch": "4.0.5",
     "strip-json-comments": "5.0.1",
-    "yaml": "2.3.1"
+    "yaml": "2.3.2"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
     "ava": "5.3.1",
     "c8": "8.0.1",
     "cpy": "10.1.0",
-    "del": "7.0.0",
-    "eslint": "8.47.0",
-    "eslint-plugin-n": "16.0.2",
+    "cpy-cli": "5.0.0",
+    "del": "7.1.0",
+    "eslint": "8.49.0",
+    "eslint-plugin-n": "16.1.0",
     "eslint-plugin-unicorn": "48.0.1",
     "execa": "8.0.1",
     "markdown-it-emoji": "2.0.2",
@@ -87,7 +95,8 @@
     "markdownlint-cli2-formatter-sarif": "0.0.1",
     "markdownlint-cli2-formatter-summarize": "0.0.6",
     "markdownlint-rule-titlecase": "0.1.0",
-    "npm-run-all": "4.1.5"
+    "npm-run-all": "4.1.5",
+    "tv4": "1.3.0"
   },
   "keywords": [
     "markdown",

package/schema/markdownlint-cli2-config-schema.json

@@ -0,0 +1,114 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "markdownlint-cli2 configuration schema",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema URI (used by some editors)",
+      "type": "string",
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json"
+    },
+    "config": {
+      "description": "markdownlint-cli2 configuration schema",
+      "$ref": "./markdownlint-config-schema.json",
+      "default": {}
+    },
+    "customRules": {
+      "description": "Module names or paths of custom rules to load and use when linting",
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "Module name or path of a custom rule",
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "fix": {
+      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information",
+      "type": "boolean",
+      "default": false
+    },
+    "frontMatter": {
+      "description": "Regular expression used to match and ignore any front matter at the beginning of a document",
+      "type": "string",
+      "minLength": 1,
+      "default": ""
+    },
+    "globs": {
+      "description": "Glob expressions to include when linting (only valid at the root)",
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "Glob expression of files to lint",
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "ignores": {
+      "description": "Glob expressions to ignore when linting",
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "Glob expression of files to ignore",
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "markdownItPlugins": {
+      "description": "markdown-it plugins to load and use when linting",
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "Name or path of a markdown-it plugin followed by parameters",
+        "type": "array",
+        "items": [
+          {
+            "description": "Name or path of a markdown-it plugin",
+            "type": "string",
+            "minLength": 1
+          },
+          {
+            "description": "Parameter(s) to pass to the markdown-it plugin"
+          }
+        ],
+        "minItems": 1
+      }
+    },
+    "noInlineConfig": {
+      "description": "Whether to disable support of HTML comments within Markdown content",
+      "type": "boolean",
+      "default": false
+    },
+    "noProgress": {
+      "description": "Whether to disable the display of progress on stdout (only valid at the root)",
+      "type": "boolean",
+      "default": false
+    },
+    "outputFormatters": {
+      "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root)",
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "Name or path of an output formatter followed by parameters",
+        "type": "array",
+        "items": [
+          {
+            "description": "Name or path of an output formatter",
+            "type": "string",
+            "minLength": 1
+          },
+          {
+            "description": "Parameter(s) to pass to the output formatter"
+          }
+        ],
+        "minItems": 1
+      }
+    },
+    "showFound": {
+      "description": "Whether to show the list of found files on stdout (only valid at the root)",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "additionalProperties": false
+}