Support reusable paths blocks via yaml anchors (#13)

* Add support for nested arrays of path expressions

* Remove pull_request trigger type options

Default value is fine: opened, synchronize, reopened

* Add CHANGELOG

* Update README

.eslintrc.json

@@ -25,7 +25,7 @@
       "@typescript-eslint/generic-type-naming": ["error", "^[A-Z][A-Za-z]*$"],
       "@typescript-eslint/no-array-constructor": "error",
       "@typescript-eslint/no-empty-interface": "error",
-      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-explicit-any": "off",
       "@typescript-eslint/no-extraneous-class": "error",
       "@typescript-eslint/no-for-in-array": "error",
       "@typescript-eslint/no-inferrable-types": "error",
@@ -42,7 +42,7 @@
       "@typescript-eslint/prefer-includes": "error",
       "@typescript-eslint/prefer-interface": "error",
       "@typescript-eslint/prefer-string-starts-ends-with": "error",
-      "@typescript-eslint/promise-function-async": "error",
+      "@typescript-eslint/promise-function-async": ["error", { "allowAny": true }],
       "@typescript-eslint/require-array-sort-compare": "error",
       "@typescript-eslint/restrict-plus-operands": "error",
       "semi": "off",

.github/workflows/pull-request-verification.yml

@@ -1,9 +1,6 @@
 name: "Pull Request Verification"
 on:
   pull_request:
-    types:
-      - opened
-      - synchronize
     branches:
       - master
 

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## v2.1.0
+- [Support reusable paths blocks with yaml anchors](https://github.com/dorny/paths-filter/pull/13)
+
+## v2.0.0
+- [Added support for workflows triggered by push events](https://github.com/dorny/paths-filter/pull/10)
+- Action and repository renamed to paths-filter - original name doesn't make sense anymore
+
+## v1.1.0
+- [Allows filters to be specified in own .yml file](https://github.com/dorny/paths-filter/pull/8)
+- [Adds alternative change detection using git fetch and git diff-index](https://github.com/dorny/paths-filter/pull/9)
+
+## v1.0.1
+Updated dependencies - fixes github security alert
+
+## v1.0.0
+First official release uploaded to marketplace.

README.md

@@ -33,6 +33,7 @@ Output variables can be later used in the `if` clause to conditionally run speci
 ### Notes
 - minimatch [dot](https://www.npmjs.com/package/minimatch#dot) option is set to true - therefore
   globbing will match also paths where file or folder name starts with a dot.
+- You can use YAML anchors to reuse path expression(s) inside another rule. See example in the tests.
 
 ### Example
 ```yaml
@@ -48,7 +49,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: dorny/paths-filter@v2.0.0
+    - uses: dorny/paths-filter@v2.1.0
       id: filter
       with:
         # inline YAML or path to separate file (e.g.: .github/filters.yaml)

__tests__/main.test.ts

@@ -90,4 +90,18 @@ describe('matching tests', () => {
     const match = filter.match(['.test/.test.js'])
     expect(match.dot).toBeTruthy()
   })
+
+  test('matches path based on rules included using YAML anchor', () => {
+    const yaml = `
+    shared: &shared
+      - common/**/*
+      - config/**/*
+    src:
+      - *shared
+      - src/**/*
+    `
+    let filter = new Filter(yaml)
+    const match = filter.match(['config/settings.yml'])
+    expect(match.src).toBeTruthy()
+  })
 })

dist/index.js

@@ -4654,10 +4654,11 @@ class Filter {
             dot: true
         };
         for (const name of Object.keys(doc)) {
-            const patterns = doc[name];
-            if (!Array.isArray(patterns)) {
+            const patternsNode = doc[name];
+            if (!Array.isArray(patternsNode)) {
                 this.throwInvalidFormatError();
             }
+            const patterns = flat(patternsNode);
             if (!patterns.every(x => typeof x === 'string')) {
                 this.throwInvalidFormatError();
             }
@@ -4678,6 +4679,11 @@ class Filter {
     }
 }
 exports.default = Filter;
+// Creates a new array with all sub-array elements recursively concatenated
+// In future could be replaced by Array.prototype.flat (supported on Node.js 11+)
+function flat(arr) {
+    return arr.reduce((acc, val) => acc.concat(Array.isArray(val) ? flat(val) : val), []);
+}
 
 
 /***/ }),