adopted-ember-addons / ember-popper-modifier Goto Github PK

Would be great if the package publishes TypeScript types. In my experience converting the source code and tests to TypeScript is the most maintainable way doing so. Conversion to TypeScript can be done by running ember init --typescript and manually picking the required changes.

As with other addons in adopted-ember-addons, we should use release-it for the release process. See here for details: https://github.com/adopted-ember-addons/program-guidelines#release-process

The existing tool relies on conventional commits. In my experience it is difficult to establish them in a project with many contributors. Release-it is easier in that case as it allows maintainers to adjust the PR titles and labels after merging before releasing as needed. Also the used tool standard-version is deprecated.

Rather than this

{{popper-modifier 'some-name' options=(hash foo='bar')}

The API should thread all arguments (besides the name) directly to the modifier options property

{{popper-modifier 'some-name' foo='bar'}}

ember-modifier 3.2.0 introduced a new modify hook, and added a number of deprecations: https://github.com/ember-modifier/ember-modifier/blob/master/addon/CHANGELOG.md#v320-2022-03-29

These are all triggered by this modifier now.

The project is still using yarn v1. We should migrate to a recent package manager. Not much opinionated if it is NPM, yarn, or PNPM. But it should be a recent version.

There is no recommendation about package manager to be used in adopted-ember-addons program guidelines: https://github.com/adopted-ember-addons/program-guidelines

Rather than needing to set the modifiers named argument to the helper, it would be helpful to be able to pass additional named arguments that are each treated as modifiers.

This is much more verbose

{{popper
  (query-selector "#tether")
  placement="bottom-start"
  modifiers=(popper-modifier "offset" options=(hash offset=(array 0 5)))
}}

Than this

{{popper
  (query-selector "#tether")
  (popper-modifier "offset" options=(hash offset=(array 0 5)))
  placement="bottom-start"
}}

And, with #12, this would be even better

{{popper
  (query-selector "#tether")
  (popper-modifier "offset" offset=(array 0 5))
  placement="bottom-start"
}}

ember-popper-modifier should support ember-modifier@^4 in parallel to version 3 to allow applications (and other addons depending on it) to upgrade to Ember Modifier v4 themselves. This issue lists the remaining tasks to do so.

• Refactor ember-modifier to use modify hook available since ember-modifier@>=3.2.0 (#452 and #508)
• Drop support for node < 14 (#577)
• Drop support for Ember < 3.24 (#578)
• Widen version range for ember-modifier to ^3.2.0 || ^4.0.0

See ember-file-upload as an usage example.