--ignore patterns now include directory names unless --ignore-files-only

[nmpowell]

Closes #7 closes #29 .

Changes the default behaviour of --ignore to also ignore directory names matching the pattern. I thought this would be the default behaviour, and apparently others did as well. You can revert to the original behaviour by adding the --include-directories flag. Thus for:

my_directory/
├── file1.txt
├── file2.txt
├── .hidden_file.txt
├── temp.log
└── subdirectory/
    └── file3.txt

files-to-prompt my_directory --ignore "sub*" will exclude file3.txt, files-to-prompt my_directory --ignore "sub*" --include-directories will not.

[DhruvParikh1]

Thank you for this; it will be especially useful for many projects with a "node_modules" directory (which contains a million subdirectories). I am assuming the command for that would be files-to-prompt . --ignore "node_modules*"?

Good work

[nmpowell]

I am assuming the command for that would be files-to-prompt . --ignore "node_modules*"?

Yes, just tested locally. "node_modules" (full name with or without *), "node*", "*modules", etc. No support afaict for the trailing slash, i.e. --ignore node_modules/ won't work. That's down to / not being output from os.walk.

Edit to add: For that matter, no path patterns with a slash, i.e. --ignore "node_modules/some_subdirectory" will work from this PR, because of how os.walk parses the tree. Only the standalone directory name.

[elasticdotventures]

is this ready for merge?

[thedch]

@simonw Could we merge this sort of functionality? Would be very helpful

[voxmenthe]

I was thinking of adding this functionality myself! Glad to see someone has already done it.

[elasticdotventures]

while I like this utility, i'm concerned about it's authors commitment to maintenance (*@simonw you should appoint some maintainers or archive this 🙏🏻 ).

In the meantime I've migrated my own workflows to the rust cargo based yek

https://github.com/bodo-run/yek/

[simonw]

I'm going to make one change to this. The pairing of --ignore and --include-directories feels non-obvious to me - --include-directories only affects --ignore but the names don't hint at that very well.

I'm going to change the --include-directories option to --ignore-files-only instead (thanks Claude).