Skip to content
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.

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

Add exclude_files.txt feature #29

Merged
merged 5 commits into from
Mar 1, 2024
Merged

Add exclude_files.txt feature #29

merged 5 commits into from
Mar 1, 2024

Conversation

cansavvy
Copy link
Contributor

Summary

Need to add documentation somewhere but the idea here is that someone can add files they'd like to ignore in the "exclude_files.txt" file. Much like the dictionary.txt and "ignore-urls.txt" file.

This should resolve #28

@cansavvy cansavvy changed the title Add exclude_files.txt Add exclude_files.txt feature Feb 29, 2024
Copy link

@KatherineCox KatherineCox left a comment

Choose a reason for hiding this comment

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

One thing I notice is that you're excluding "About.Rmd" in the script, but I'm getting spell-check hits for the "About.md" file that's produced from the Rmd. 2 suggestions:

  1. Now that an "exclude_files.txt" exists, put "About.Rmd" (and "About.md") in it instead of hardcoding its exclusion into the scripts. This gives people more flexibility - they could decide to include it if they want to spell-check their contributors names, or could choose to rename the file (I wanted to do this at one point, but didn't because spell-check errors made it more work than just a file rename).
  2. More generally, any .Rmds that get excluded will also need their corresponding ".mds" excluded. It's not hard to manually list both in exclude_files.txt, but that seems like something that could be handled automatically?

@cansavvy
Copy link
Contributor Author

Ah great point. I will try to make it so files that are excluded are excluded on all their types.

Also totally forgot about excluding About.Rmd. Should probably delete that part and let people exclude it themselves.

Thanks!

@cansavvy cansavvy requested a review from KatherineCox March 1, 2024 13:12
@cansavvy
Copy link
Contributor Author

cansavvy commented Mar 1, 2024

@KatherineCox See how you feel about this set up!

@cansavvy cansavvy requested a review from avahoffman March 1, 2024 13:13
Copy link

@KatherineCox KatherineCox left a comment

Choose a reason for hiding this comment

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

I've not run the code or anything, but from reading it LGTM!
Nice that exclude_files.txt can accept regex.

Thanks!

@cansavvy cansavvy merged commit b7e56c1 into main Mar 1, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

spell-checking all markdown files?
2 participants