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

Make adr files recognition stricter #108

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

davebaol
Copy link

This fix makes adr list and adr link work properly when there are extraneous files along with adr files.

I just changed

find $adr_dir | grep -E "^$adr_dir/[0-9]+-[^/]*\\.md" | sort

to

find $adr_dir -maxdepth 1 -type f | grep -E "^.{${#adr_dir}}/[0-9]*[1-9][0-9]*-[^/]*\\.md$" | sort

Explanation:

  • -maxdepth 1 exclude subfolders; this is faster if you have subfolders with a lot of files, for instance images linked by your ADRs
  • -type f files only
  • ^.{${#adr_dir}} skip as many chars as adr_dir length. This is more robust than matching the initial path with ^$adr_dir because adr_dir might contain special regex chars that should be escaped at runtime.
  • [0-9]*[1-9][0-9]* any sequence of digits other than all zeros (0 is not a valid adr; for instance adr new starts from 1)
  • \.md$ make sure the extension is exactly .md (for instance .md5 files are excluded)

halostatue pushed a commit to halostatue/adr-tools that referenced this pull request Jul 20, 2024
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.

1 participant