Enhance config discovery with cosmiconfig

[MericKarabulut]

What?

The modifications made here align with the objectives set out in issue #30842.

Why?

in @wordpress/scripts package lint-js, lint-pkg-json and lint-style scripts try's to locate relevant configs using hasProjectFile repeatedly.

How?

By utilizing cosmiconfig, a tool crafted to establish a standardized approach for identifying configuration files across different tools, we can simplify the logic of configuration file discovery. Moreover, this approach allows us to enhance performance by minimizing the redundant invocation of helper functions.

Testing Instructions

1. install the necessary dependencies.
2. Set up a test configuration file for any of the affected scripts (e.g., lint-js, lint-pkg-json, or lint-style).
3. Run the respective script and verify that the configuration is correctly detected and utilized.
4. Ensure that existing functionality remains unaffected.

Testing Instructions for Keyboard

none

Screenshots or screencast

none

[github-actions]

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @MericKarabulut! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

[MericKarabulut]

Hey there 👋,

I've been working on the code and it seemed to be running smoothly. However, the tests, they unexpectedly failed. I've gone through the code and checked configurations, but I'm hitting a bit of a roadblock in identifying the exact cause. If someone could take a look and provide some insights, that would be fantastic! 🙏

[gziolo]

Thank you so much for starting this PR.

There are some issues reported by Continues Integration:

There might be a subtle issue with how the paths are checked

[gziolo]

I think I know why some checks are red. It turns out that cosmiconf doesn't work with all file extensions by default. They don't plan to support .config.json as explained in cosmiconfig/cosmiconfig#246 (comment). It can be supported with their API:

Please consider using searchPlaces to implement this feature.

However, we can always combine some existing checks with cosmiconf if that is simpler to maintain.

Edit: It doesn't look like .config.json was listed before, so it is probably something else.