Skip to content

feat(filetree): Add exclude option to ignore paths in tree output #13

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
ioncakephper merged 1 commit into from
Oct 26, 2025
Merged

feat(filetree): Add exclude option to ignore paths in tree output #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,10 @@ markdown-magic-transform-treefile-extended/
├── eslint.config.mjs (1.1 KB)
├── index.js (8.1 KB)
├── LICENSE (1.1 KB)
├── markdown-magic.config.js (1.8 KB)
├── markdown-magic.config.js (1.9 KB)
├── package-lock.json (339.1 KB)
├── package.json (2.9 KB)
├── README.md (26.1 KB)
├── README.md (26.2 KB)
└── RULES_OF_CONDUCT.md (829 B)
```
<!-- end-doc-gen -->
Expand All @@ -185,6 +185,7 @@ module.exports = {
style: 'for-the-badge',
},
fileTreeExtended: {
exclude: ['node_modules', '.git', '.vscode', '.DS_Store'],
Copy link

@gemini-code-assist gemini-code-assist bot Oct 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This example demonstrates using exclude for paths that are already ignored by default via the ignore option. This is redundant and might be confusing for users trying to understand the difference between exclude and ignore. A better example would showcase excluding files not covered by the default ignores, such as ['package.json', 'package-lock.json'], which is used elsewhere in this README. This would more clearly illustrate the intended use case for the new exclude option.

descriptions: {
'.qodo':
'Qodana is a static analysis tool that can be used to find bugs and improve code quality.',
Expand Down Expand Up @@ -277,10 +278,10 @@ markdown-magic-transform-treefile-extended/
├── eslint.config.mjs (1.1 KB) # This is the configuration file for ESLint, a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
├── index.js (8.1 KB) # This is the main entry point of the `fileTreeExtended` transform.
├── LICENSE (1.1 KB) # This file contains the project's license information.
├── markdown-magic.config.js (1.8 KB) # This is the configuration file for `markdown-magic`.
├── markdown-magic.config.js (1.9 KB) # This is the configuration file for `markdown-magic`.
├── package-lock.json (339.1 KB) # This file is automatically generated for any operations where `npm` modifies either the `node_modules` tree, or `package.json`.
├── package.json (2.9 KB) # This file contains metadata about the project and its dependencies.
├── README.md (26.1 KB) # This file provides a general overview of the project.
├── README.md (26.2 KB) # This file provides a general overview of the project.
└── RULES_OF_CONDUCT.md (829 B) # This file outlines the rules of conduct for the project's community.
```
<!-- end-doc-gen -->
Expand Down
1 change: 1 addition & 0 deletions markdown-magic.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ module.exports = {
style: 'for-the-badge',
},
fileTreeExtended: {
exclude: ['node_modules', '.git', '.vscode', '.DS_Store'],
Copy link

@gemini-code-assist gemini-code-assist bot Oct 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The paths listed in this exclude array (node_modules, .git, .vscode, .DS_Store) are already covered by the default ignore option in the transform. While this is not harmful, it is redundant. The ignore option is also more efficient for large directories as it prevents fast-glob from traversing them in the first place. To avoid this redundancy and potential confusion, consider removing this line and relying on the default ignore behavior.

descriptions: {
'.qodo':
'Qodana is a static analysis tool that can be used to find bugs and improve code quality.',
Expand Down
Loading