(refactor):Improve the support for Image component from next

[JayaKrishnaNamburu]

fixes #686

But, currently the new Image component doesn't work as expected with styled-jsx. Here is the issue https://github.com/vercel/next.js/issues/38822 Let's wait for some info on that

[JayaKrishnaNamburu]

I came back looking at this, @mihaisampaleanu here is where we left the discussion to handle this. Currently next/image don't support className prop and apply them on the image. Instead they ask to adopt css-modules. So, we should decide if we move ahead and make Next - CSS Modules as default for the nextjs projects.

The only down side is, any legacy custom-scripts that are following classnames might break. Since css-modules hash the class-names for deployments. But, at the end this switch will be a huge perf gain. So, should we switch to it and give warning to old scripts users ?

[codecov[bot]]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (53c7b8a) 70.52% compared to head (b9ca4ee) 70.52%.

Additional details and impacted files

@@             Coverage Diff              @@
##           development     #696   +/-   ##
============================================
  Coverage        70.52%   70.52%           
============================================
  Files              170      170           
  Lines             6999     6999           
  Branches          2026     2026           
============================================
  Hits              4936     4936           
  Misses            2060     2060           
  Partials             3        3           

Impacted Files	Coverage Δ
...ort-project-generator-next/src/project-template.ts	100.00% <ø> (ø)
...ckages/teleport-plugin-jsx-next-image/src/index.ts	91.66% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.