Skip to content

fix: add @gitlab/svgs to peerDependencies

Joe Wollard requested to merge joe.wollard/gitlab-ui:add-@gitlab/svgs-to-peer-dependencies into master

When attempting to use (not develop) @gitlab/ui without having @gitlab/svgs will produce the following error:

ERROR  Failed to compile with 2 errors                                                                                                                                                                                 11:55:11 AM

These dependencies were not found:

* @gitlab/svgs/dist/icons.json in ./node_modules/@gitlab/ui/dist/index.js
* @gitlab/svgs/dist/icons.svg in ./node_modules/@gitlab/ui/dist/index.js

To install them, you can run: npm install --save @gitlab/svgs/dist/icons.json @gitlab/svgs/dist/icons.svg

This implies @gitlab/svgs are at the very least a peerDependency, but it's also possible that the dependencies array would be a better home for it. In either case, having it solely in devDependencies seems to misrepresent what the library actually needs.

Merge request reports