Add allow list for file filtering function

[ingeniumed]

This is meant to add the ability to pass an allow list for file filtering. This means that:

allow list -> node_modules

So any file that is NOT in the node_modules folder will be filtered. Only the node_modules files will be allowed.

This introduces a new option that has to be passed in called include_folders. There's no other change outside this function, so it's not exposed within the cli.

TODO:

• Add/update tests -- unit and/or integrated
• Check status of automated tests
• Changelog entry [ Changelog for version 1.2.6 #290 ]

[wpcomvip-vipgoci-bot]

phpcs scanning turned up:

🚫 3 errors

⚠️ 1 warning

---

This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

---

Scan run detail

Software versions vip-go-ci version: 1.2.5 PHP runtime version for vip-go-ci: 8.1.8 PHP runtime for linting: PHP 8.1: 8.1.8 PHP runtime version for PHPCS: 7.4.30 PHPCS version: 3.7.1 PHP runtime version for SVG scanner: 7.4.30 Options file (.vipgoci_options) Options file enabled: true Configurable options: skip-execution skip-draft-prs lint-modified-files-only phpcs phpcs-severity phpcs-sniffs-include phpcs-sniffs-exclude report-no-issues-found review-comments-sort review-comments-include-severity post-generic-pr-support-comments review-comments-sort scan-details-msg-include svg-checks autoapprove autoapprove-php-nonfunctional-changes Options altered: phpcs-severityset to1 phpcs-sniffs-includeset toGeneric.PHP.DisallowShortOpenTag, Squiz.PHP.CommentedOutCode phpcs-sniffs-excludeset toWordPress.Security.EscapeOutput, WordPress.PHP.DevelopmentFunctions, WordPress.WP.AlternativeFunctions, WordPress.PHP.DiscouragedPHPFunctions, WordPress.Files.FileName, Squiz.Commenting.FileComment, Generic.PHP.Syntax skip-draft-prsset to

PHP lint options PHP lint files enabled: true Lint modified files only: true Directories not PHP linted: None SVG configuration SVG scanning enabled: true Auto-approval configuration Auto-approvals enabled: true Non-functional changes auto-approved: true Auto-approved file-types: css csv eot gif gz ico ini jpeg jpg json less map md mdown mo mp4 otf pcss pdf po pot png sass scss styl ttf txt woff woff2 yml

PHPCS configuration PHPCS scanning enabled: true PHPCS severity level: 1 Standard(s) used: PHPCompatibility PHPCompatibilityParagonieRandomCompat PHPCompatibilityParagonieSodiumCompat VariableAnalysis WordPress Runtime set: testVersion 8.1- Custom sniffs included: Generic.PHP.DisallowShortOpenTag Squiz.PHP.CommentedOutCode Custom sniffs excluded: WordPress.Security.EscapeOutput WordPress.PHP.DevelopmentFunctions WordPress.WP.AlternativeFunctions WordPress.PHP.DiscouragedPHPFunctions WordPress.Files.FileName Squiz.Commenting.FileComment Generic.PHP.Syntax Directories not PHPCS scanned: tests/unit

Dismissing review as all inline comments are obsolete by now

[wpcomvip-vipgoci-bot]

No issues were found to report when scanning latest commit (commit-ID: 590a6bf)

---

This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

---

---

Scan run detail

Software versions vip-go-ci version: 1.2.5 PHP runtime version for vip-go-ci: 8.1.8 PHP runtime for linting: PHP 8.1: 8.1.8 PHP runtime version for PHPCS: 7.4.30 PHPCS version: 3.7.1 PHP runtime version for SVG scanner: 7.4.30 Options file (.vipgoci_options) Options file enabled: true Configurable options: skip-execution skip-draft-prs lint-modified-files-only phpcs phpcs-severity phpcs-sniffs-include phpcs-sniffs-exclude report-no-issues-found review-comments-sort review-comments-include-severity post-generic-pr-support-comments review-comments-sort scan-details-msg-include svg-checks autoapprove autoapprove-php-nonfunctional-changes Options altered: phpcs-severityset to1 phpcs-sniffs-includeset toGeneric.PHP.DisallowShortOpenTag, Squiz.PHP.CommentedOutCode phpcs-sniffs-excludeset toWordPress.Security.EscapeOutput, WordPress.PHP.DevelopmentFunctions, WordPress.WP.AlternativeFunctions, WordPress.PHP.DiscouragedPHPFunctions, WordPress.Files.FileName, Squiz.Commenting.FileComment, Generic.PHP.Syntax skip-draft-prsset to

PHP lint options PHP lint files enabled: true Lint modified files only: true Directories not PHP linted: None SVG configuration SVG scanning enabled: true Auto-approval configuration Auto-approvals enabled: true Non-functional changes auto-approved: true Auto-approved file-types: css csv eot gif gz ico ini jpeg jpg json less map md mdown mo mp4 otf pcss pdf po pot png sass scss styl ttf txt woff woff2 yml

PHPCS configuration PHPCS scanning enabled: true PHPCS severity level: 1 Standard(s) used: PHPCompatibility PHPCompatibilityParagonieRandomCompat PHPCompatibilityParagonieSodiumCompat VariableAnalysis WordPress Runtime set: testVersion 8.1- Custom sniffs included: Generic.PHP.DisallowShortOpenTag Squiz.PHP.CommentedOutCode Custom sniffs excluded: WordPress.Security.EscapeOutput WordPress.PHP.DevelopmentFunctions WordPress.WP.AlternativeFunctions WordPress.PHP.DiscouragedPHPFunctions WordPress.Files.FileName Squiz.Commenting.FileComment Generic.PHP.Syntax Directories not PHPCS scanned: tests/unit

[gudmdharalds]

Looks good!

Please add this to the changelog in #286. Actually, I will create a changelog specifically for this so we can deploy this next week.

Update: Changelog created, see #290.