[GH-ISSUE #219] Extends does not work for subfolders (possible CLI issue) #188

New issue

Closed

opened 2026-03-03 01:24:31 +03:00 by kerem · 15 comments

kerem commented 2026-03-03 01:24:31 +03:00

Owner

Copy link

Originally created by @TheJaredWilcurt on GitHub (Aug 28, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/219

YAML configs

✔️ YAML next to file works

extends: file.yml

✔️ JSON next to file works

extends: file.json

❌ ./ subfolder YAML does not work

extends: ./node_modules/folder/file.yml

❌ ./ subfolder JSON does not work

extends: ./node_modules/folder/file.json

❌ Relative subfolder YAML does not work

extends: node_modules/folder/file.yml

❌ Relative subfolder JSON does not work

extends: node_modules/folder/file.json

JSON configs

✔️ YAML next to file works

{
  "extends": "file.yml"
}

✔️ JSON next to file works

{
  "extends": "file.json"
}

❌ ./ subfolder YAML does not work

{
  "extends": "./node_modules/folder/file.yml"
}

❌ ./ subfolder JSON does not work

{
  "extends": "./node_modules/folder/file.json"
}

❌ Relative subfolder YAML does not work

{
  "extends": "node_modules/folder/file.yml"
}

❌ Relative subfolder JSON does not work

{
  "extends": "node_modules/folder/file.json"
}

Originally created by @TheJaredWilcurt on GitHub (Aug 28, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/219 # YAML configs ✔️ YAML next to file works ```yml extends: file.yml ``` ✔️ JSON next to file works ```yml extends: file.json ``` ❌ `./` subfolder YAML does not work ```yml extends: ./node_modules/folder/file.yml ``` ❌ `./` subfolder JSON does not work ```yml extends: ./node_modules/folder/file.json ``` ❌ Relative subfolder YAML does not work ```yml extends: node_modules/folder/file.yml ``` ❌ Relative subfolder JSON does not work ```yml extends: node_modules/folder/file.json ``` # JSON configs ✔️ YAML next to file works ```json { "extends": "file.yml" } ``` ✔️ JSON next to file works ```json { "extends": "file.json" } ``` ❌ `./` subfolder YAML does not work ```json { "extends": "./node_modules/folder/file.yml" } ``` ❌ `./` subfolder JSON does not work ```json { "extends": "./node_modules/folder/file.json" } ``` ❌ Relative subfolder YAML does not work ```json { "extends": "node_modules/folder/file.yml" } ``` ❌ Relative subfolder JSON does not work ```json { "extends": "node_modules/folder/file.json" } ```

kerem 2026-03-03 01:24:31 +03:00

• closed this issue
• added the
  question
  label

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 28, 2019):

There are tests for relative and absolute path handling for this scenario, so I hope it is not as broken as the above seems to suggest. I believe paths are resolved relative to the working directory rather than the input file. Is there a chance that’s responsible for the behavior above? If not, I will need to try to reproduce this myself.

<!-- gh-comment-id:525818634 --> @DavidAnson commented on GitHub (Aug 28, 2019): There are tests for relative and absolute path handling for this scenario, so I hope it is not as broken as the above seems to suggest. I believe paths are resolved relative to the working directory rather than the input file. Is there a chance that’s responsible for the behavior above? If not, I will need to try to reproduce this myself.

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 28, 2019):

To be clear, I think the extends path is relative to the working directory when specified in the options object, and relative to the config file when specified inside a config file. I’m not entirely sure of the structure you have above.

<!-- gh-comment-id:525823945 --> @DavidAnson commented on GitHub (Aug 28, 2019): To be clear, I think the extends path is relative to the working directory when specified in the options object, and relative to the config file when specified inside a config file. I’m not entirely sure of the structure you have above.

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@TheJaredWilcurt commented on GitHub (Aug 28, 2019):

CWD is C:\project

C:\project> npm run lint
markdownlint -i './node_modules/**/*' --config ./markdownlint.yml ./docs/**/*.md

---
extends: ./node_modules/tjw-markdown-lint-rules/tjwmarkdownlint.yml
proper-names:
  names:
    - Project Name

Folder structure for C:\project

C:\project>
docs\
node_modules\
markdownlint.yml
package.json
README.md

This has a few problems:

1. The extends doesn't work unless I put the tjwmarkdownlint.yml next to the markdownlint.yml
   • And change markdownlint.yml extend to extends: tjwmarkdownlint.yml
2. The -i './node_modules/**/*' doesn't seem to actually ignore
3. I can't target multiple inputs, like './README.md, ./docs/**/*.md'
4. So I'm stuck just targeting ./docs/**/*.md to avoid linting node_modules. Where as I would prefer to just ignore node_modules and target ./**/*.md. But I know most of these problems are probably for the markdownlint-cli repo.

<!-- gh-comment-id:525852264 --> @TheJaredWilcurt commented on GitHub (Aug 28, 2019): CWD is `C:\project` ``` C:\project> npm run lint markdownlint -i './node_modules/**/*' --config ./markdownlint.yml ./docs/**/*.md ``` ```yml --- extends: ./node_modules/tjw-markdown-lint-rules/tjwmarkdownlint.yml proper-names: names: - Project Name ``` Folder structure for `C:\project` ``` C:\project> docs\ node_modules\ markdownlint.yml package.json README.md ``` This has a few problems: 1. The extends doesn't work unless I put the `tjwmarkdownlint.yml` next to the `markdownlint.yml` * And change `markdownlint.yml` extend to `extends: tjwmarkdownlint.yml` 1. The `-i './node_modules/**/*'` doesn't seem to actually ignore 1. I can't target multiple inputs, like `'./README.md, ./docs/**/*.md'` 1. So I'm stuck just targeting `./docs/**/*.md` to avoid linting `node_modules`. Where as I would prefer to just ignore `node_modules` and target `./**/*.md`. But I know most of these problems are probably for the `markdownlint-cli` repo.

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@TheJaredWilcurt commented on GitHub (Aug 28, 2019):

For clarification, running npm run lint above will still run and lint, it just won't use any of the rules set by the file I am extending (unless it is moved to the same directory level)

<!-- gh-comment-id:525869107 --> @TheJaredWilcurt commented on GitHub (Aug 28, 2019): For clarification, running `npm run lint` above will still run and lint, it just won't use any of the rules set by the file I am extending (unless it is moved to the same directory level)

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 28, 2019):

If you have a repo that shows the problem, please provide a link. You are right that some of this may be CLI behavior. It’s curious you find that ignore does not work - could you please look at this exchange and the example I created for that scenario? https://github.com/igorshubovych/markdownlint-cli/issues/62

<!-- gh-comment-id:525874934 --> @DavidAnson commented on GitHub (Aug 28, 2019): If you have a repo that shows the problem, please provide a link. You are right that some of this may be CLI behavior. It’s curious you find that ignore does not work - could you please look at this exchange and the example I created for that scenario? https://github.com/igorshubovych/markdownlint-cli/issues/62

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 28, 2019):

Your 1 definitely seems like a problem. I’ll need to debug to determine where, though.

<!-- gh-comment-id:525876538 --> @DavidAnson commented on GitHub (Aug 28, 2019): Your 1 definitely seems like a problem. I’ll need to debug to determine where, though.

kerem commented 2026-03-03 01:24:32 +03:00

Author

Owner

Copy link

@TheJaredWilcurt commented on GitHub (Aug 28, 2019):

@DavidAnson I'm working on this:

• https://github.com/tjw-lint/tjw-markdownlint-rules

Currently in Windows. Will try Ubuntu VM to see if issue occurs in other OS's.

<!-- gh-comment-id:525876937 --> @TheJaredWilcurt commented on GitHub (Aug 28, 2019): @DavidAnson I'm working on this: * https://github.com/tjw-lint/tjw-markdownlint-rules Currently in Windows. Will try Ubuntu VM to see if issue occurs in other OS's.

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@TheJaredWilcurt commented on GitHub (Aug 28, 2019):

On Ubuntu VM:

Following instructions from:

• https://github.com/tjw-lint/tjw-markdownlint-rules#how-to-use-this

Using this repo for testing

1. "Extends" won't work unless in the same directory
2. The ignore works (Making the "ignore" issue a Windows specific bug, probably for CLI)
3. I still can't target multiple inputs, like './README.md, ./content/**/*.md', happening on Win and Lin, likely CLI related.

<!-- gh-comment-id:525884257 --> @TheJaredWilcurt commented on GitHub (Aug 28, 2019): On Ubuntu VM: Following instructions from: * https://github.com/tjw-lint/tjw-markdownlint-rules#how-to-use-this Using [this repo](https://github.com/TheJaredWilcurt/cole-cat) for testing 1. "Extends" won't work unless in the same directory 1. The ignore works (Making the "ignore" issue a Windows specific bug, probably for CLI) 1. I still can't target multiple inputs, like `'./README.md, ./content/**/*.md'`, happening on Win and Lin, likely CLI related.

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 28, 2019):

Quoting multiple inputs is not supported by the CLI as far as I know. I will look into the path issue with extends. But I do almost all of my ignore testing on Windows, so it’s odd that you are seeing something I am not. I will try with your repository when I look into this. However, I am in the middle of a sizable change, so won’t be able to do that immediately.

<!-- gh-comment-id:525885601 --> @DavidAnson commented on GitHub (Aug 28, 2019): Quoting multiple inputs is not supported by the CLI as far as I know. I will look into the path issue with extends. But I do almost all of my ignore testing on Windows, so it’s odd that you are seeing something I am not. I will try with your repository when I look into this. However, I am in the middle of a sizable change, so won’t be able to do that immediately.

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 28, 2019):

BTW, glob and ignore are CLI features - the library just takes a list of file names and lints them.

<!-- gh-comment-id:525886496 --> @DavidAnson commented on GitHub (Aug 28, 2019): BTW, glob and ignore are CLI features - the library just takes a list of file names and lints them.

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@TheJaredWilcurt commented on GitHub (Aug 29, 2019):

I updated this repo:

• https://github.com/TheJaredWilcurt/cole-cat

So you just need to do

1. git clone https://github.com/TheJaredWilcurt/cole-cat.git
2. cd cole-cat
3. npm install
4. npm run markdown-lint

Should be able to see it not ignoring node_modules, and not extending the rules.

<!-- gh-comment-id:526272118 --> @TheJaredWilcurt commented on GitHub (Aug 29, 2019): I updated this repo: * https://github.com/TheJaredWilcurt/cole-cat So you just need to do 1. `git clone https://github.com/TheJaredWilcurt/cole-cat.git` 1. `cd cole-cat` 1. `npm install` 1. `npm run markdown-lint` Should be able to see it not ignoring `node_modules`, and not extending the rules.

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Aug 29, 2019):

Thank you!

<!-- gh-comment-id:526323883 --> @DavidAnson commented on GitHub (Aug 29, 2019): Thank you!

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Sep 3, 2019):

@TheJaredWilcurt:

• The problem of the CLI not ignoring node_modules is because of the single quotes around the path which get interpreted as part of the path. Removing them gives the expected behavior.
• The problem of the CLI not extending the rules is due to a typo in the file path of the root config file. Fixing that gives the expected behavior.
  • It's possible that's what was responsible for the original "extends doesn't work" issue as well - please double-check?

Here's a diff with the two change I made to the above repo on Windows to get this working:

diff --git a/.markdown-lint.yml b/.markdown-lint.yml
index 930040d..eb86918 100644
--- a/.markdown-lint.yml
+++ b/.markdown-lint.yml
@@ -1,5 +1,5 @@
 ---
-extends: ./node_modules/tjw-markdown-lint-rules/tjwmarkdownlint.yml
+extends: ./node_modules/tjw-markdownlint-rules/tjwmarkdownlint.yml
 # Override the proper-names rule to enforce capitalization of your project's name and other proper nouns
 proper-names:
   names:
diff --git a/package.json b/package.json
index d1285b4..e19a19c 100644
--- a/package.json
+++ b/package.json
@@ -7,7 +7,7 @@
     "start": "node node_modules/npm-free-server/dist/server.js",
     "lint": "eslint components/**/*.vue",
     "fix": "npm run lint -- --fix",
-    "markdown-lint": "markdownlint -i './node_modules/**/*' --config ./.markdown-lint.yml ./**/*.md"
+    "markdown-lint": "markdownlint -i ./node_modules/**/* --config ./.markdown-lint.yml ./**/*.md"
   },
   "license": "MIT",
   "devDependencies": {

<!-- gh-comment-id:527293505 --> @DavidAnson commented on GitHub (Sep 3, 2019): @TheJaredWilcurt: - The problem of the CLI not ignoring `node_modules` is because of the single quotes around the path which get interpreted as part of the path. Removing them gives the expected behavior. - The problem of the CLI not extending the rules is due to a typo in the file path of the root config file. Fixing that gives the expected behavior. - It's possible that's what was responsible for the original "extends doesn't work" issue as well - please double-check? Here's a diff with the two change I made to the above repo on Windows to get this working: ```diff diff --git a/.markdown-lint.yml b/.markdown-lint.yml index 930040d..eb86918 100644 --- a/.markdown-lint.yml +++ b/.markdown-lint.yml @@ -1,5 +1,5 @@ --- -extends: ./node_modules/tjw-markdown-lint-rules/tjwmarkdownlint.yml +extends: ./node_modules/tjw-markdownlint-rules/tjwmarkdownlint.yml # Override the proper-names rule to enforce capitalization of your project's name and other proper nouns proper-names: names: diff --git a/package.json b/package.json index d1285b4..e19a19c 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "start": "node node_modules/npm-free-server/dist/server.js", "lint": "eslint components/**/*.vue", "fix": "npm run lint -- --fix", - "markdown-lint": "markdownlint -i './node_modules/**/*' --config ./.markdown-lint.yml ./**/*.md" + "markdown-lint": "markdownlint -i ./node_modules/**/* --config ./.markdown-lint.yml ./**/*.md" }, "license": "MIT", "devDependencies": { ```

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@TheJaredWilcurt commented on GitHub (Sep 3, 2019):

The ignore being double quotes was really dumb and I should have caught. I originally had no quotes, then it wouldn't work in Linux, so I added single quotes and it worked in linux but not Windows. Anyways, double quotes works for that!

And yeah, the typo thing is really dumb too. Thanks for catching that.

<!-- gh-comment-id:527560956 --> @TheJaredWilcurt commented on GitHub (Sep 3, 2019): The ignore being double quotes was really dumb and I should have caught. I originally had no quotes, then it wouldn't work in Linux, so I added single quotes and it worked in linux but not Windows. Anyways, double quotes works for that! And yeah, the typo thing is really dumb too. Thanks for catching that.

kerem commented 2026-03-03 01:24:33 +03:00

Author

Owner

Copy link

@DavidAnson commented on GitHub (Sep 3, 2019):

Glad this had a happy ending! :)

<!-- gh-comment-id:527569713 --> @DavidAnson commented on GitHub (Sep 3, 2019): Glad this had a happy ending! :)

kerem referenced this issue 2026-03-07 20:03:41 +03:00

[GH-ISSUE #188] MD033 being flagged for elemenents with _ #2013

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

next

linkinator-action@v2.4.1

linkinator-action@v2.4.0

wc13

scenario-chunks

seqseq

v0.40.0

v0.39.0

v0.38.0

v0.37.4

v0.37.3

v0.37.2

v0.37.1

v0.37.0

v0.36.1

v0.36.0

v0.35.0

v0.34.0

v0.33.0

v0.32.1

v0.32.0

v0.31.1

v0.31.0

v0.30.0

v0.29.0

v0.28.2

v0.28.1

v0.28.0

v0.27.0

v0.26.2

v0.26.1

v0.26.0

v0.25.1

v0.25.0

v0.24.0

v0.23.1

v0.23.0

v0.22.0

v0.21.1

v0.21.0

v0.20.4

v0.20.3

v0.20.2

v0.20.1

v0.20.0

v0.19.0

v0.18.0

v0.17.2

v0.17.1

v0.17.0

v0.16.0

v0.15.0

v0.14.2

v0.14.1

v0.14.0

v0.13.0

v0.12.0

v0.11.0

v0.10.0

v0.9.0

v0.8.1

v0.8.0

v0.7.0

v0.6.4

v0.6.3

v0.6.2

v0.6.1

v0.6.0

v0.5.0

v0.4.1

v0.4.0

v0.3.1

v0.3.0

v0.2.0

v0.1.1

v0.1.0

v0.0.8

v0.0.7

v0.0.6

v0.0.5

v0.0.4

v0.0.3

v0.0.2

v0.0.1

Labels

Clear labels   

bug

  

enhancement

  

enhancement

  

enhancement

  

fixed in next

  

fixed in next

  

fixed in next

  

new rule

  

new rule

  

new rule

  

pull-request

Mirrored from GitHub Pull Request

  

question

  

refactoring

  

refactoring

No labels

bug

enhancement

enhancement

enhancement

fixed in next

fixed in next

fixed in next

new rule

new rule

new rule

pull-request

question

refactoring

refactoring

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/markdownlint#188

No description provided.