search

sajivkumar / mathjax-angular

Mathjax 3 for angular
10 stars 13 forks source link

update: support for angular 14 and above #29

Closed mratanusarkar closed 7 months ago

mratanusarkar commented 8 months ago

closes #26, fixes #27

This PR addresses the peer dependency limitations of mathjax-angular for Angular versions above 14, as discussed in #27. It expands compatibility to newer Angular versions, ensuring broader usability.

Changes

Updated peerDependencies in package.json to >=14.0.0 for @angular/common and @angular/core. This change allows compatibility with Angular versions 14 and above, including the latest releases.

Since the code and package worked just fine, only installation was an issue for angular versions 15 and above, which was tackled with npm i --force, or npm i --legacy-peer-deps

I could have gone with "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0", but since the library seems to work with all the upcoming versions, >=14.0.0 seemed like the correct option for @angular/common and @angular/core.

Context

The need for this update was highlighted in issue #27 and further reinforced by community feedback, particularly the suggestion from @marcinstl. The update ensures that mathjax-angular remains a viable option for projects using newer versions of Angular.

Testing

Basic functionality tests were conducted across Angular versions:

to confirm the compatibility of the library with various Angular versions. The library performed as expected in all versions without any compatibility issues.

Impact

This enhancement simplifies the integration of mathjax-angular in projects using Angular versions 14 and above, fostering a more inclusive and up-to-date usage scope. It also solves the deployment issues of angular apps that have dependencies with mathjax-angular in Cloud and DevOps pipelines (eg: Oryx in Azure) as discussed in #27

raztirlea commented 7 months ago

Hello, does it require further checks to be done before merging?

sajivkumar commented 7 months ago

consolidated in this via https://update.angular.io/?v=14.0-17.0 https://github.com/sajivkumar/mathjax-angular/pull/30

sajivkumar commented 7 months ago

closing with https://github.com/sajivkumar/mathjax-angular/pull/30