feat: add any-file-contents rule

[Brend-Smits]

Motivation

The file-contents rule passes if all the files discovered include the content specified via a regular expression. However, for our use case we need to check whether the content is included in at least one of the discovered files.

Proposed Changes

Add any-file-contents rule, which mimics the functionality of the file-contents rule. However, the any-file-contents rule features a globsAny option, instead of globsAll.

To reduce code duplication, the fileContents method (which implements the logic of the file-contents rule) is extended with an optional boolean parameter (called any). If this parameter has the value true, then the rule passes if and only if there is at least one file with content matching the regex. Otherwise, the rule passes if and only if all files include content matching the regex.

Test Plan

• it returns passes if requested file contents exists in exactly one file
• it returns passes if requested file contents exists in two files
• it returns fails if the requested file contents does not exist in any file
• it returns failure if no file exists with failure flag enabled
• it should handle broken symlinks

Original Pull Request on: philips-forks#18

[zhaoyuheng200]

Let's not change the file-contents function parameter, keep the function always take globsAll and it matches the intention of if all of the files returned by the globs match the supplied string, or if no files are returned..

You can move this part to any-file-contents.js instead.

[zhaoyuheng200]

Quote:

However, for our use case we need to check whether the content is included in at least one of the discovered files.

I think it doesn't make sense for the rule to pass if no files are returned. It would make sense if the rule fails if no files are returned., since we are looking for at least there is one file has this thing there.

That means the fail-on-non-existent would be success-on-non-existent.

[hinricht]

We need a similar but different use case :)
We want to ensure that all files in a glob don't include a certain content.
Right now I didn't find a way to accomplish this.