Yarn: Public JS API

[maseh87]

I read on this Facebook article that Yarn exposes a public javascript API but the api.js file is currently empty. Is this feature in the works or is there documentation on how to get started using the api?

[j]

Yes, I too was about to create an issue regarding being able to programmatically use Yarn as part of my build tools.

[samccone]

https://github.com/yarnpkg/rfcs

Mind opening here?

Thanks 😁

[FLGMwt]

Was the post referring to the --json argument?

> yarn
yarn install v0.15.1
success Already up-to-date.
Done in 0.15s.

> yarn --json
{"type":"success","data":"Already up-to-date."}
{"type":"finished","data":142}

[j]

@FLGMwt no, having the ability to do something like import { install } from 'yarn/lib/api' and use something in the matter of await install(/* options etc */)

[FLGMwt]

Ahhh, gotcha. Thought you meant more structured output for parsing as part of a build script. That makes more sense : )

[j]

Created RFC issue here: https://github.com/yarnpkg/rfcs/issues/6

Go right ahead and give it some love with some 👍 's :)

[southpolesteve]

Anyone know what happened to this RFC? The link to https://github.com/yarnpkg/rfcs/issues/6 404's

[ghost]

@southpolesteve from their GitHub repo page (https://github.com/yarnpkg/rfcs/pulls) you can see that they disabled the issues feature.

Therefore all issues non 404.

[smitt04]

Since the other repo has no issues, i think this should be opened again, unless there is an API.

[Hendrixer]

@samccone can we re open this issue please?

[onbjerg]

Ping pong

[Inventicon]

Is there still no sign of a JS API?

[arcanis]

We recently split the lockfile parser in a new package, but we have not converged on any unified API yet for the rest of the application.

[Inventicon]

Oh, bummer.

I'll need to see if this package is a viable alternative for now.

[davidnagli]

Can someone please re-open this? I also really need a way to access yarn programmatically

[pacop]

Is some news right here?

[Inventicon]

Not unless someone wants to add the feature themselves and submit a PR.

[kiprasmel]

bump

[CanRau]

Yarn 2 core will come as Node API

Edit missed the Link https://github.com/yarnpkg/berry/blob/master/README.md#generic-packages