escape globs derived from .codeowner files

[schoblaska]

Globs can contain certain regex characters, like "[" and "]". However, when we are generating a glob from a .codeowners file, we need to escape bracket characters and interpret them literally. Otherwise the resulting glob will not actually match the directory containing the .codeowners file.

• Fixes Support for .codeowner files within [bracketed] directories #103

Example

file: "/some/[dir]/.codeowner"
unescaped: "/some/[dir]/**/**"
matches: "/some/d/file"
matches: "/some/i/file"
matches: "/some/r/file"
does not match!: "/some/[dir]/file"

[technicalpickles]

Globs can contain certain regex characters, like "[" and "]". However, when we are generating a glob from a .codeowners file, we need to escape bracket characters and interpret them literally.

This seems like a potentially breaking change, since it would have been valid been valid to have brackets in globs previously, and now they are changing.

from Dir.glob docs:

[set]
Matches any one character in set. Behaves exactly like character sets in Regexp, including set negation ([^a-z]).

If that is the case, I think this probably needs a major version bump.

Separately... I wonder if it works as expected without this change if you escape filenames in the codeowner file 🤔

[schoblaska]

@technicalpickles

This seems like a potentially breaking change, since it would have been valid been valid to have brackets in globs previously, and now they are changing.

Are you referring to globs that are defined in a team's config? Those are parsed in a separate mapper and not changed by this PR. You can still use brackets in those globs to define a range of characters, or escape them if you want to match on the bracket characters themselves.

Separately... I wonder if it works as expected without this change if you escape filenames in the codeowner file

This PR affects the ownership method where a .codeowner file containing just the team name indicates "this team owns all the code in this directory (recursively)." There are no filenames to escape in that file, and we need to escape any brackets in the directory because they're part of the path to that file.

[technicalpickles]

Thanks for clarifying 🙇🏻

[schoblaska]

Github CODEOWNERS files don't appear to support brackets for ranges of characters. We don't have any special handling for that, so I suspect that using brackets in this gem does not work today.

github/docs#1407 (comment)