feat: add ability to use function as config

[SachinShekhar]

This PR adds an ability to use a function as config. This function will get an array of all staged files as parameter which can be used with own globs. Currently, we need to pass such function as value of '*' in config object which doesn't feel good.

This can be further optimized by not using micromatch internally when a function config is detected.

[codecov]

Codecov Report

Merging #913 into master will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #913   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        18    +1     
  Lines          602       608    +6     
  Branches       142       143    +1     
=========================================
+ Hits           602       608    +6     

Impacted Files	Coverage Δ
lib/formatConfig.js	100.00% <100.00%> (ø)
lib/index.js	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 643038d...9a8d245. Read the comment docs.

[iiroj]

Thanks for the PR! I wonder if the formatConfig is needed, could the same thing simply be inside the validateConfig method as a short-circuit?

[SachinShekhar]

Separation of Concerns

validateConfig should focus on only validation, nothing else.
Benefit of separate formatConfig: If you need to accept strings or arrays as config in the future, it'd be easy to implement thanks to formatConfig.

[iiroj]

Good enough for me! Do you think there are some existing examples In the readme that could use this format instead of the start glob?

[SachinShekhar]

There was one example and I have already added the new alternative (but, didn't remove existing one because that remains valid). Do you want me to remove that existing example?

[iiroj]

Let's leave it, since it shows the explicit '*' glob.

[iiroj]

I think the readme could be more clear that you can either export a single function that receives all matched files, or then an object of globs, where each key can be a function (that receives only those matches), string or array of strings.

Otherwise it's good to go IMO!

[SachinShekhar]

Done.

[iiroj]

Thoughts, @okonet?

[okonet]

It's LGTM but please consider documentation comments.

[iiroj]

I wrote some direct suggestions on the README text. What do you think?

[github-actions]

🎉 This PR is included in version 10.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀