Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keep docs up-to-date with changes around plugin-compat #5257

Merged
merged 1 commit into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Some other important notes:

- If the `packageExtensions` entries you have to add are widely relevant, consider opening up a
PR to add them to our builtin extension list!
https://github.com/yarnpkg/berry/blob/master/packages/plugin-compat/sources/extensions.ts#L11
https://github.com/yarnpkg/berry/blob/master/packages/yarnpkg-extensions/sources/index.ts#L11

- The Rulebook is our reference resource, explaining why proper dependency listings are important
not only for Yarn, but for all package managers. We recommend referencing it in your upstream issues.
Expand Down
4 changes: 2 additions & 2 deletions packages/docusaurus/docs/getting-started/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Should you use dependencies or peer dependencies? It depends on the context; as

### Use `yarn dlx` instead of `yarn global`

Managing system-wide packages is outside of the scope of Yarn, so [`yarn global` has been removed](https://github.com/yarnpkg/berry/issues/821). We however still provide `yarn dlx` to run one off scripts.
Managing system-wide packages is outside of the scope of Yarn, so [`yarn global` has been removed](https://github.com/yarnpkg/berry/issues/821). We however still provide `yarn dlx` to run one off scripts.

### Call binaries using `yarn run` rather than `node_modules/.bin`

Expand Down Expand Up @@ -279,4 +279,4 @@ Although rare, some packages don't list all their dependencies. Now that we enfo

The long term fix is to submit a pull request upstream to add the missing dependency to the package listing. Given that it sometimes might take some time before they get merged, we also have a more short-term fix available: create `.yarnrc.yml` in your project, then use the [`packageExtensions` setting](#fix-dependencies-with-packageextensions) to add the missing dependency to the relevant packages. Run `yarn install` to apply your changes, and voilà!

Should you choose to open a PR on the upstream repository, you will also be able to contribute your package extension to our [compat plugin](https://github.com/yarnpkg/berry/blob/master/packages/plugin-compat/sources/extensions.ts), helping the whole ecosystem move forward.
Should you choose to open a PR on the upstream repository, you will also be able to contribute your package extension to our [`plugin-compat` database](https://github.com/yarnpkg/berry/blob/master/packages/plugin-compat/sources/extensions.ts), helping the whole ecosystem move forward.
2 changes: 1 addition & 1 deletion packages/gatsby/content/getting-started/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,4 +331,4 @@ packageExtensions:
optional: true
```

If you also open a PR on the upstream repository you will also be able to contribute your package extension to our [compat plugin](https://github.com/yarnpkg/berry/blob/master/packages/plugin-compat/sources/extensions.ts), helping the whole ecosystem move forward.
If you also open a PR on the upstream repository you will also be able to contribute your package extension to our [`plugin-compat` database](https://github.com/yarnpkg/berry/blob/master/packages/yarnpkg-extensions/sources/index.ts), helping the whole ecosystem move forward.
3 changes: 1 addition & 2 deletions packages/plugin-compat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ This plugin is included by default in Yarn.

## Compatibility Features

- Various [extensions](/configuration/yarnrc#packageExtensions) are enabled by default (full list [here](https://github.com/yarnpkg/berry/blob/master/packages/plugin-compat/sources/extensions.ts))
- Various [extensions](/configuration/yarnrc#packageExtensions) are enabled by default (full list [here](https://github.com/yarnpkg/berry/blob/master/packages/yarnpkg-extensions/sources/index.ts))
- [`fsevents`](/packages/plugin-compat/extra/fsevents): Makes fsevents aware of the virtual filesystem: [#692](https://github.com/yarnpkg/berry/pull/692)
- [`typescript`](/packages/plugin-compat/extra/typescript): Auto-merge of [#35206](https://github.com/microsoft/TypeScript/pull/35206)
- [`resolve`](/packages/plugin-compat/extra/resolve): Implements [`normalize-options.js`](https://github.com/browserify/resolve/pull/174)