facebook / docusaurus

Easy to maintain open source documentation websites.
https://docusaurus.io
MIT License
56.3k stars 8.45k forks source link

[npm2yarn]: `npm init` => `yarn create` #5861

Closed christian-bromann closed 1 year ago

christian-bromann commented 2 years ago

Have you read the Contributing Guidelines on issues?

Prerequisites

Description

See demo here: https://du0ui.sse.codesandbox.io/docs/intro

If you use @docusaurus/remark-plugin-npm2yarn and your code snippet is set like this:

```sh npm2yarn
npm init wdio ./foo
```

I would expect that it would transform the yarn version to yarn create wdio ./foo.

Steps to reproduce

  1. create a standard docusarus page
  2. add @docusaurus/remark-plugin-npm2yarn plugin
  3. add example as mention above

Expected behavior

I would expect that it would transform the yarn version to yarn create wdio ./foo.

Actual behavior

It displays npm init wdio ./foo and yarn init wdio ./foo which results in the attempt of creating a new yarn package rather than running the create-wdio starter package.

Your environment

Reproducible demo

https://codesandbox.io/s/nice-fire-du0ui?file=/docusaurus.config.js

Self-service

Josh-Cena commented 2 years ago

We are aware of this: https://github.com/facebook/docusaurus/pull/5635#issuecomment-937806707

However, we use a 3rd party dep under the hood which is currently unmaintained. I'm discussing with others about what's the best option. I would prefer forking npm2yarn considering it's quite lightweight.

Josh-Cena commented 2 years ago

Just realized this package was developed in the first place to be used by our plugin🤷‍♂️ https://github.com/facebook/docusaurus/pull/2428

In the future we should discourage this and make everything live on our own repo / our org. Saves a lot of trouble of maintenance

slorber commented 2 years ago

agree 👍

mrienstra commented 2 years ago

Re: unmaintained 3rd-party dep (nebrelbug/npm-to-yarn): how can this conversation be moved toward a resolution?

A) Move npm-to-yarn code inside of this repo B) Fork npm-to-yarn and put under https://github.com/facebook organization umbrella C) Fork npm-to-yarn and owned by...? Random or active contributor?

Sounds like maybe (A) and (B) have both already been rejected as solutions? If so, does anyone have strong feelings about exactly how (C) looks?

CC @endiliey @lex111 @yangshun @JoelMarcey @deltice

armano2 commented 2 years ago

for time being i created fork, with all know issues for this library

Josh-Cena commented 2 years ago

A) Move npm-to-yarn code inside of this repo B) Fork npm-to-yarn and put under https://github.com/facebook organization umbrella C) Fork npm-to-yarn and owned by...? Random or active contributor?

We have discussed this ourselves and indeed (A) and (B) are not in the interest of FB (I personally like (A) the most). @slorber said he would do the forking himself, but since @armano2 offered to take this over, I do think we would take that courtesy. I would see if Sebastien is happy with that, but he'll be occupied with #5830 at the moment.

We already have a lot of forked dependencies owned by Sebastien, so there are precedents.

armano2 commented 2 years ago

i don't mind passing ownership, moving it to him... i just care about fixing issues 😸

slorber commented 2 years ago

Thanks 👍

Will maintain the fork under my own name (easier to transfer later to a potential docusaurus-core org that I'm asking for) and publish under @docusaurus org (also a security concern).