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

chore: move jQuery & what-input to peerDependencies #11290 #11294

Merged

Conversation

ncoden
Copy link
Contributor

@ncoden ncoden commented May 22, 2018

Description

Move jquery and what-input from dependencies to peerDependencies.

Motivation and Context

peerDependencies is for dependencies that are exposed to (and expected to be used by) the consuming code, as opposed to "private" dependencies that are not exposed, and are only an implementation detail.

  • We need jQuery and motion-ui as peerDependencies instead of dependencies because we actually expect the user to install them. We cannot simply remove them because we still need the package managers to check for versions compatibilities and warn the user if they are missing.
  • We need jQuery and motion-ui as devDependencies too because we use them for tests/build/documentation and peerDependencies are not installed (even in development mode - Add a means to install package peer dependencies for development / testing yarnpkg/yarn#1503).

Closes #11290

Types of changes

  • Documentation
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing
    functionality to change)

Checklist (all required):

  • I have read and follow the CONTRIBUTING document.
  • There are no other pull request similar to this one.
  • The pull request title is descriptive.
  • The template is fully and correctly filled.
  • The pull request targets the right branch (develop or support/*).
  • My commits are correctly titled and contain all relevant information.
  • My code follows the code style of this project.
  • I have updated the documentation accordingly to my changes (if relevant).
  • I have added tests to cover my changes (if relevant).
  • All new and existing tests passed.

peerDependencies is for dependencies that are exposed to (and expected to be used by) the consuming code, as opposed to "private" dependencies that are not exposed, and are only an implementation detail.

* We need `jQuery` and `motion-ui` as peerDependencies instead of dependencies because we actually expect the user to install them. We cannot simply remove them because we still need the package managers to check for versions compatibilities and warn the user if they are missing.
* We need `jQuery` and `motion-ui` as devDependencies too because we use them for tests/build/documentation and peerDependencies are not installed (even in development mode - yarnpkg/yarn#1503).

See foundation#11290
@ncoden ncoden merged commit 3dc2e1c into foundation:develop May 24, 2018
ncoden added a commit to ncoden/foundation-sites that referenced this pull request Jun 16, 2018
…er-dependencies-11290 for v6.5.0

b1b9408 chore: move jQuery & what-input to peerDependencies foundation#11290

Signed-off-by: Nicolas Coden <nicolas@ncoden.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

jQuery and what-input should be peerDependencies
2 participants