Skip to content

NEST-596: Exclude third party folders from markdown lint #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Piedone merged 4 commits into from
Jul 26, 2025
Merged

NEST-596: Exclude third party folders from markdown lint #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eea9ae5
Exclude third party folders
wAsnk Jul 17, 2025
51dddae
Codespell ignore
wAsnk Jul 17, 2025
7fb0b26
Merge remote-tracking branch 'origin/dev' into issue/NEST-596
wAsnk Jul 18, 2025
6db5074
Add docs
wAsnk Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Lombiq.NodeJs.Extensions/Docs/Markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ By default, the markdown pipeline is disabled. You need to provide a valid `sour
}
```

> [!NOTE]
> Files in some special folders aren't linted. See the current configuration [here](https://github.com/Lombiq/NodeJs-Extensions/blob/dev/Lombiq.NodeJs.Extensions/scripts/lint-markdown.js#L47).

### Linting the solution directory

You can use the special value `_solution_` as the source to lint every _md_ file in your solution directory. The solution directory is considered to be the first parent directory of your project that contains a _sln_ file.
Expand Down
2 changes: 1 addition & 1 deletion Lombiq.NodeJs.Extensions/scripts/lint-markdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function getMarkdownPaths() {
return findRecursively(
rootDirectory,
[/\.md$/i],
[/^node_modules$/, /^\.git$/, /^\.vs$/, /^\.vscode$/, /^\.idea$/, /^obj$/, /^bin$/, /^wwwroot$/]);
[/^node_modules$/, /^\.git$/, /^\.vs$/, /^\.vscode$/, /^\.idea$/, /^obj$/, /^bin$/, /^wwwroot$/, /^ThirdParty$/]); // codespell:ignore
}

function handleError(error) {
Expand Down
Loading