marmelab / react-admin

A frontend Framework for single-page applications on top of REST/GraphQL APIs, using TypeScript, React and Material Design
http://marmelab.com/react-admin
MIT License
24.87k stars 5.23k forks source link

Documentation issues with yarn link #9331

Closed smeng9 closed 1 year ago

smeng9 commented 1 year ago

Hi @djhi, I am still trying to troubleshoot the vitest issue in https://github.com/marmelab/react-admin/pull/9309 by changing exports field in package.json

However I found part of the tutorial in https://github.com/marmelab/react-admin#testing-your-changes-in-your-app is outdated since this commit. https://github.com/marmelab/react-admin/commit/8fe89469d1ad44056215e66ff2cd84aa72b2c595

What you were expecting:

Yarn link should not produce any problem regardless of yarn version

What happened instead:

Unable to link to a local copy with error: Unknown Syntax Error: Not enough positional arguments.

Steps to reproduce:

Follow the steps in Testing Your Changes in Your App

Other information:

We should split this part of tutorial. If client app is using yarn classic, they should follow https://classic.yarnpkg.com/lang/en/docs/cli/link/ to use

$ YARN_IGNORE_PATH=1 yarn link

If client app is using yarn berry, they only need to link to the workspace

yarn link /code/path/to/react-admin/packages

Environment

djhi commented 1 year ago

Good catch! Do you mind opening a PR?

djhi commented 1 year ago

Fixed by #9341