Node API documentation?

[slorber]

Hi,

I tried to look around and wasn't sure to know where the Node API is documented.

Also, if it's not documented, can we expect that you maintain semver retrocompatibility on it?

---

Context

For the Docusaurus framework, I'm working on adding opt-in experimental Rspack support.

It has built-in LightningCSS support with a slightly different API.

• Official JS binding: targets is something like browserslistToTargets(browserslist(queries))
• Build-in: targets is a list of browserslist queries directly (they did that to avoid installing an extra conversion package exposing browserslistToTargets)

It seems I'm able to read the current browserslist queries with the following code:

function getBrowserslistQueries(): string[] {
  const configFile = browserslist.findConfigFile(process.cwd());
  const queries = browserslist.loadConfig({path: configFile}) ?? [...browserslist.defaults];
  return queries;
}

I was wondering if this code is safe for framework usage with unpinned dependency, and if there's not a simpler way to achieve the same?

[ai]

Here is Node.js API docs: https://github.com/browserslist/browserslist?tab=readme-ov-file#js-api

You should use something like:

function getBrowserslistQueries(): string[] {
  return browserslist();
}

Calling findConfigFile and loadConfig is very low-level methods, which you should avoid.

[ai]

Hm, got it.

Yes, we don't have specific API for that case. Maybe we can add it since I think it can be useful for other cases.

[chenjiahan]

I made a minimal package to load browserslist config, it's used by Rsbuild. See: https://github.com/rspack-contrib/browserslist-load-config

[ai]

Nice! I will add method but also add a link to this helper

[slorber]

Thanks

Considering we already have browserslist installed I'd prefer to use the "official" package instead of adding an extra one.

I will add method

So you plan to introduce another method as a public API surface and don't plan to simply document the existing ones?

Looks to me like just exposing loadConfig with {path: process.cwd()} by default could do the job.

[ai]

So you plan to introduce another method as a public API surface and don't plan to simply document the existing ones?

Yes, it will be better to keep algorithm in sync with rest of Browserslist.

Reimplantating it could lead to a different behaviours. But I will add it to docs if course.

[ai]

The simpler way to do it is just to use loadConfig() it could find config automatically:

browserslist.loadConfig({path: process.cwd()}) ?? [...browserslist.defaults]

I improved docs 9320799

[slorber]

Thanks, yes I figured this out yesterday, didn't initially understand what path was

facebook/docusaurus@8093a21

BTW maybe it could use process.cwd() by default if not provided?

browserslist.loadConfig() would be a quite convenient public API.