Add usage sample for Yarn to README

[Tomalak]

When using Yarn in PnP mode (the default) as the package manager, trying the documented run command

npx @eslint/config-inspector@latest

fails with an error message along the lines of the following:
(also note that it always says eslint.config.js, even if it's actually e.g. eslint.config.mjs)

Failed to load `eslint.config.js`.
https://eslint.org/docs/latest/use/configure/configuration-files-new
Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'globals' imported from C:\config-inspector-test\eslint.config.bundled_dso4w158dx.mjs  
    at new NodeError (node:internal/errors:406:5)
    at moduleResolve (node:internal/modules/esm/resolve:838:20)
    at defaultResolve (node:internal/modules/esm/resolve:1043:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:383:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:352:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:228:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:85:39)
    at link (node:internal/modules/esm/module_job:84:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}

because npx has no idea how to resolve Yarn packages.

The way to successfully run it with Yarn would be

yarn add -D @eslint/config-inspector

and then

yarn run config-inspector

which would be a helpful addition to the usage section of the README.

[antfu]

Would you like to send a quick PR for that? Thanks

[robmisasi]

I would expect yarn dlx to be usable in place of npx for Yarn Plug 'n Play projects, but after running yarn dlx @eslint/config-inspector a similar module resolution error was produced:

Failed to load `eslint.config.js`.
Note that `@eslint/config-inspector` only works with the flat config format:
https://eslint.org/docs/latest/use/configure/configuration-files-new
Error: @eslint/config-inspector tried to access eslint (a peer dependency) but it isn't provided by your application; this makes the require call ambiguous and unsound.

Required package: eslint (via "eslint\use-at-your-own-risk")
Required by: @eslint/config-inspector@virtual:dc3fc578bfa5e06182a4d2be39ede0bc5b74940b1ffe0d70c26892ab140a4699787750fba175dc306292e80b4aa2c8c5f68c2a821e69b2c37e360c0dff36ff66#npm:1.3.0 (via C:\Users\RMisasi\AppData\Local\Temp\xfs-a7e41939\dlx-7036\.yarn\__virtual__\@eslint-config-inspector-virtual-95e8633c16\4\Yarn\Berry\cache\@eslint-config-inspector-npm-1.3.0-a9b018e279-10c0.zip\node_modules\@eslint\config-inspector\dist\cli.mjs)     
Ancestor breaking the chain: root-workspace-0b6124@workspace:.


    at makeError (C:\Users\RMisasi\AppData\Local\Temp\xfs-a7e41939\dlx-7036\.pnp.cjs:6595:34)
    at resolveToUnqualified (C:\Users\RMisasi\AppData\Local\Temp\xfs-a7e41939\dlx-7036\.pnp.cjs:8175:21)
    at resolveRequest (C:\Users\RMisasi\AppData\Local\Temp\xfs-a7e41939\dlx-7036\.pnp.cjs:8363:31)
    at Object.resolveRequest (C:\Users\RMisasi\AppData\Local\Temp\xfs-a7e41939\dlx-7036\.pnp.cjs:8426:26)
    at resolve$1 (file:///C:/Users/RMisasi/AppData/Local/Temp/xfs-a7e41939/dlx-7036/.pnp.loader.mjs:2043:21)
    at nextResolve (node:internal/modules/esm/hooks:785:28)
    at AsyncLoaderHooksOnLoaderHookWorker.resolve (node:internal/modules/esm/hooks:271:30)
    at MessagePort.handleMessage (node:internal/modules/esm/worker:251:24)
    at [nodejs.internal.kHybridDispatch] (node:internal/event_target:845:20)
    at MessagePort.<anonymous> (node:internal/per_context/messageport:23:28)

This project also has an eslint.config.mjs (despite the same "Failed to load eslint.config.js" message), and eslint is listed in the project's package.json as a dev dependency.

Interestingly, the inspector launches without issue when running yarn dlx eslint --inspect-config.

[github-actions]

Oops! It looks like we lost track of this issue. What do we want to do here? This issue will auto-close in 7 days without an update.