ember-learn / ember-cli-addon-docs

Easy, beautiful docs for your OSS Ember addons
https://ember-learn.github.io/ember-cli-addon-docs
MIT License
176 stars 143 forks source link

Fix @ember/string dependency #1582

Closed anehx closed 2 months ago

anehx commented 2 months ago

@ember/string must be a dependency as ember-cli-addon-docs imports it in their codebase. Currently this still works, but with v4 of @ember/string (v2 addon) this will break as it fully relies on ember-auto-import.

RobbieTheWagner commented 2 months ago

@anehx should it be a peerDep?

anehx commented 2 months ago

@RobbieTheWagner I don't think so. This addon is mostly used in other addons which do not include @ember/string in the devDependencies in their blueprint so tthey would have to install the package manually..

RobbieTheWagner commented 2 months ago

I think we should probably make it a peerDep and allow v3 and v4 like this https://github.com/minutebase/ember-can/blob/master/ember-can/package.json#L129

anehx commented 2 months ago

@RobbieTheWagner Fair enough. I changed it in this PR.

RobbieTheWagner commented 2 months ago

CI is failing for other reasons, so I will go ahead and merge this. Thanks for the PR!

ijlee2 commented 3 weeks ago

Hi, @RobbieTheWagner. Could you help release a patch version of ember-cli-addon-docs?

The documentation site for ember-intl needs the fix in this PR to be able to update @ember/string to v4. A new version would also help me remove a custom patch that I had upstreamed in #1556.

RobbieTheWagner commented 3 weeks ago

@ijlee2 I would love to help release a new version, but CI is failing currently. If you have time to diagnose and fix those failures, we could definitely get a new version out.

ijlee2 commented 3 weeks ago

@RobbieTheWagner Ah, I didn't see the CI failing in the main branch.

Since the error message refers to @babel/plugin-transform-class-static-block, I'd try updating Babel-related dependencies to the latest version. This may require additional maintenance work, though. Maybe we can look into it after EmberFest.