Add configPointer input, examples for package.json/pyproject.toml.

Author: DavidAnson

.github/dictionary.txt

@@ -1,5 +1,7 @@
 CommonMark
 config
+configPointer
+JSON
 LLMs
 markdownlint-cli2-action
 npm

.github/workflows/test.yml

@@ -96,6 +96,36 @@ jobs:
       id: test
     - run: exit 1
       if: steps.test.outcome != 'failure'
+  package-json:
+    name: package.json (test/errors.md, 2 errors)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - run: rm .markdownlint.json
+    - uses: ./
+      with:
+        config: 'config/package.json'
+        configPointer: '/markdownlint-cli2'
+        globs: 'test/*.md'
+      continue-on-error: true
+      id: test
+    - run: exit 1
+      if: steps.test.outcome != 'failure'
+  pyproject-toml:
+    name: pyproject.toml (test/errors.md, 2 errors)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - run: rm .markdownlint.json
+    - uses: ./
+      with:
+        config: 'config/pyproject.toml'
+        configPointer: '/tool/markdownlint-cli2'
+        globs: 'test/*.md'
+      continue-on-error: true
+      id: test
+    - run: exit 1
+      if: steps.test.outcome != 'failure'
   fix:
     name: fix (test/errors.md, 0 errors)
     runs-on: ubuntu-latest

README.md

@@ -20,6 +20,14 @@ Path of a file to use for the base configuration object (defaults to none)
 Equivalent to using the `--config` [command-line option][command-line] and
 passing the specified configuration file.
 
+### configPointer (optional)
+
+[JSON Pointer][json-pointer] to a configuration object within the `--config`
+file (defaults to none)
+
+Equivalent to using the `--configPointer` [command-line option][command-line]
+and passing the specified JSON Pointer.
+
 ### fix (optional)
 
 Whether to fix supported issues automatically (any truthy value enables)
@@ -100,6 +108,26 @@ To specify a custom configuration file:
     globs: '**/*.md'
 ```
 
+To specify an embedded object in `package.json`:
+
+```yaml
+- uses: DavidAnson/markdownlint-cli2-action@v22
+  with:
+    config: 'package.json'
+    configPointer: '/markdownlint-cli2'
+    globs: '**/*.md'
+```
+
+To specify an embedded object in `pyproject.toml`:
+
+```yaml
+- uses: DavidAnson/markdownlint-cli2-action@v22
+  with:
+    config: 'pyproject.toml'
+    configPointer: '/tool/markdownlint-cli2'
+    globs: '**/*.md'
+```
+
 To prevent linting issues from failing the workflow run:
 
 ```yaml
@@ -119,6 +147,7 @@ and/or gradually introducing linting rules to a new repository).
 [commonmark]: https://commonmark.org/
 [example-yml]: .github/workflows/example.yml
 [glob-syntax]: https://github.com/DavidAnson/markdownlint-cli2#use
+[json-pointer]: https://datatracker.ietf.org/doc/html/rfc6901
 [markdown]: https://wikipedia.org/wiki/Markdown
 [markdownlint]: https://github.com/DavidAnson/markdownlint
 [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2

action.yml

@@ -9,6 +9,10 @@ inputs:
     description: Path of a file to use for the base configuration object (defaults to none)
     default: ''
     required: false
+  configPointer:
+    description: JSON Pointer to a configuration object within the --config file (defaults to none)
+    default: ''
+    required: false
   fix:
     description: Whether to fix supported issues automatically (any truthy value enables)
     default: ''

config/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+
+  "markdownlint-cli2": {
+    "config": {
+      "single-trailing-newline": false
+    }
+  }
+}

config/pyproject.toml

@@ -0,0 +1,5 @@
+[project]
+name = "my-project"
+
+[tool.markdownlint-cli2.config]
+single-trailing-newline = false