jQuery and what-input should be peerDependencies

[ncoden]

Description

I think that all current dependencies should be considered as peerDependencies for the following reasons:

• When using the distribution files foudation.js, we expect the user to import jQuery by themself. To do this, we consider jQuery as an external in our build process and actually reproduce the peerDependency behavior.
• Foundation register itself to jQuery and can be seen as a jQuery plugin.
• Users do not expect jQuery to be specific to Foundation and want it to be imported only once, like most frontend dependencies.

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.

See:

• https://stackoverflow.com/a/22004559/4317384
• https://stackoverflow.com/a/34645112/4317384

Possible Solution

Move jquery and what-input to peerDependencies (but also devDependencies for local developement usages - see yarnpkg/yarn#1503).

Checklist (all required):

• I have read and follow the CONTRIBUTING.md document.
• There are no other issues similar to this one.
• The issue title is descriptive.
• The template is correctly filled.

[ncoden]

Any opinion on this @DanielRuf @brettsmason ?

[DanielRuf]

but also devDependencies for local developement usages - see yarnpkg/yarn#1503

What exactly is meant with this? In many cases the devDependencies are/will not installed.

[ncoden]

@DanielRuf When we are locally building Foundation to run tests or start the documentation (for development purposes), we need peerDependencies to be installed too. Current Yarn (and maybe NPM) versions will not always install them so we need to declare them as both peerDependencies (production) and devDependencies (development).

[DanielRuf]

Shouldn't be devDependencies sufficient in this case?

npm install (in package directory, no arguments):

Install the dependencies in the local node_modules folder.

In global mode (ie, with -g or --global appended to the command), it installs the current package context (ie, the current working directory) as a global package.

By default, npm install will install all modules listed as dependencies in package.json.

With the --production flag (or when the NODE_ENV environment variable is set to production), npm will not install modules listed in devDependencies.

NOTE: The --production flag has no particular meaning when adding a dependency to a project.

[ncoden]

I would be devDependencies if we was only delivering dist files (i.e. foundation.min.js) to copy-paste or import from a CDN. But you can install Foundation from dependencies managers (npm i foundation-sites) and in this case we should have our dependencies checked. With peerDependencies we can expect the user to have jQuery installed and to be warned otherwise or if their jQuery version is not compatible with ours (<2.2.0).

[DanielRuf]

I do not mean jQuery but the dev dependencies.

[ncoden]

I do not mean jQuery but the dev dependencies.

I don't understand

[DanielRuf]

#11290 (comment)

[ncoden]

@DanielRuf

• 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).