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

[TASK] add mcdev as peer dependency #33

Closed
JoernBerkefeld opened this issue Jun 7, 2023 · 1 comment · Fixed by #72
Closed

[TASK] add mcdev as peer dependency #33

JoernBerkefeld opened this issue Jun 7, 2023 · 1 comment · Fixed by #72
Assignees
Milestone

Comments

@JoernBerkefeld
Copy link
Contributor

JoernBerkefeld commented Jun 7, 2023

similar to what we've done in the copado repo (https://github.com/Accenture/sfmc-devtools-copado/blob/c0eb700def58c010d68787ad150fa3d4494b7305/package.json#LL12C10-L12C15) I would want you to add a definition of which mcdev version your extension requires in the form of a peer dependency in your package.json

 "peerDependencies": {
        "mcdev": ">=5.1.0 < 6"
    },

read up on what nodejs has to say about Peer Dependencies: https://nodejs.org/en/blog/npm/peer-dependencies to understand what version definition could make sense and why this is interesting in the first place.

The best way to determine what your peer dependency requirements should be is to actually follow semver. Assume that only changes in the host package's major version will break your plugin. Thus, if you've worked with every 1.x version of the host package, use "~1.0" or "1.x" to express this. If you depend on features introduced in 1.5.2, use ">= 1.5.2 < 2".

... also, it will show up in the "used by" section afterwards ;-)
image

@JoernBerkefeld JoernBerkefeld added NEW not yet analyzed new issues get this label chore labels Jun 7, 2023
@anasilva105 anasilva105 removed the NEW not yet analyzed new issues get this label label Dec 13, 2023
@anasilva105 anasilva105 added this to the 1.0.0 milestone Dec 13, 2023
@anasilva105
Copy link
Collaborator

Change it to 5.2.0 and above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants