Add globbing to ES Lint onlyDependOnLibsWithTags

[kschaefe]

Description

Currently, only special-case * globbing exists for onlyDependOnLibsWithTags. Add the ability to use * to pattern match with partial strings.

Note: I filed this as a request instead of a bug because this feature does not exist, but the current Nx implementation feels like a miss. See all of these places that support globbing.

• allow globs, cf. https://nx.dev/recipes/other/tags-allow-list#tags-allow-list.
• sourceTag globs. I did not find that in the docs, but it seems to work, when testing locally.
• onlyDependOnLibsWithTags currently supports * as a special case, cf. https://nx.dev/core-features/enforce-project-boundaries#enforce-project-boundaries
• bannedExternalImports globs, cf. https://nx.dev/recipes/other/ban-external-imports#ban-external-imports

If you decide not to implement this, I'd recommend making the documentation more clear that onlyDependOnLibsWithTags doesn't support any globbing other than the special case. My assumption was that it would because everything else globs and you note * special case in the docs.

Motivation

We have a few tag types. They're perhaps overly picayune, but we're using them to help developers focus in on making more, smaller libraries. As such we're using a two part tag main:specifier, such as util:types for a shared, types-only library or util:data-access. Given our wide usage of this pattern we want to be able to set onlyDependOnLibsWithTags to util:* for things like features or apps. As we add more main:new-specifier libraries, we don't want to have to update the ES Lint tag rules.

Splitting the main and specifier portions into independent tags creates the same problem. As we add new things (new specifiers), we still have to go update our ES Lint rules.

[ericyd]

TIL "picayune" is a word 😄

I'm going to try to implement this, not because I have any attachment to this particular issue, but because Nx is an amazing project and I'd love to help close out a community issue.

I believe the fix should be straight forward, it looks like the relevant code is in the hasTag function which is used to filter if a project has the tag. Adding a manual glob check should work.

In the meantime, @kschaefe , if I'm reading the source code correctly, you might be able to achieve your goal right now by using a string that looks like a regex, e.g.

"onlyDependOnLibsWithTags": ["/main.*/"]

or even just

"onlyDependOnLibsWithTags": ["/main/"]

It seems like this could be better explained in the docs so I'll try to update that while implementing non-regex glob support.

If the Nx team has any opinions on how/where I document this, I'm all ears, otherwise I'll take a stab somewhere that feels reasonable.

[github-actions]

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.