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

Update peerDependencies #150

Merged
merged 1 commit into from
Jun 2, 2021
Merged

Update peerDependencies #150

merged 1 commit into from
Jun 2, 2021

Conversation

dcyriller
Copy link
Member

@dcyriller dcyriller commented Jun 2, 2021

Fix the peerDependencies to indicate that this plugin is supposed to work with ember-template-lint starting from v2.10.0 and prettier starting v1.18.1.

If ember-template-lint would release a new major that breaks the compatibility with this plugin, this event would be treated as a bug in this plugin.

eslint-plugin-ember and eslint-plugin-prettier have the same policy.

@dcyriller dcyriller merged commit 356f3c5 into master Jun 2, 2021
@dcyriller dcyriller deleted the update-peerdeps branch June 2, 2021 13:40
@dcyriller dcyriller added the bug Something isn't working label Jun 2, 2021
@@ -28,8 +28,8 @@
"license": "Apache-2.0",
"private": false,
"peerDependencies": {
"ember-template-lint": "^2.10.0",
"prettier": "^1.18.2"
"ember-template-lint": ">=2.10.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was it intentional that this will also target e.g. ember-template-lint v42.3.1?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The peerDependency indicates that this plugin is supposed to work with ember-template-lint starting from v2.10.0. But ember-template-lint could release a new major that breaks the compatibility with this plugin. This event would be treated as a bug in this plugin.

eslint-plugin-ember and eslint-plugin-prettier made that choice:
https://github.com/ember-cli/eslint-plugin-ember/blob/79d2a949537f568474124a53158d559a00e8161c/package.json#L94
https://github.com/prettier/eslint-plugin-prettier/blob/76bd45ece6d56eb52f75db6b4a1efdd2efb56392/package.json#L34-L35

In term of maintenance, I think I'd rather fix the bug when a major change in ember-template-lint breaks the compatibilty with this addon than increase the compatibilty range every time ember-template-lint publises a new major.

wdyt?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, sounds reasonable. just wasn't sure if it was intentional since the PR description was empty 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants