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

Change theme name in grunt config #39413

Open
wants to merge 1 commit into
base: 2.4-develop
Choose a base branch
from

Conversation

sippsolutions
Copy link
Member

@sippsolutions sippsolutions commented Nov 29, 2024

Description (*)

Change theme name in grunt config as the file itself is named themes.js not local-themes.js.

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Change theme name in grunt config #39428: Change theme name in grunt config

Copy link

m2-assistant bot commented Nov 29, 2024

Hi @sippsolutions. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@m2-github-services m2-github-services added Partner: TechDivision partners-contribution Pull Request is created by Magento Partner labels Nov 29, 2024
@engcom-Hotel engcom-Hotel added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Dec 3, 2024
@engcom-Hotel
Copy link
Contributor

@magento create issue

@engcom-Hotel engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Dec 3, 2024
@torhoehn
Copy link
Contributor

torhoehn commented Dec 4, 2024

@sippsolutions The filename seems to be correct for me, because the documentation says that the content of the file should be copied in a new file named local-themes.js.

Ref: https://developer.adobe.com/commerce/frontend-core/guide/tools/grunt/#configuration-file

@sippsolutions
Copy link
Member Author

@sippsolutions The filename seems to be correct for me, because the documentation says that the content of the file should be copied in a new file named local-themes.js.

Ref: https://developer.adobe.com/commerce/frontend-core/guide/tools/grunt/#configuration-file

That's correct! The documentation should be changed too.

themes.js is not used anywhere else, so to me it makes no sense that themes.js will be present in a fresh installation but local-themes.js is referenced.
Grunt support can be enabled automatically by removing the *.sample suffix but will fail because the wrong file is specified.
The user can edit the themes.js to his needs anytime. Other implementations such as Gulp for Magento2 use the same file, themes.js, not local-themes.js.

If we don't want to change local-themes.js in grunt config, we should then deploy themes.js as local-themes.js.sample instead.

@hostep
Copy link
Contributor

hostep commented Dec 16, 2024

I wouldn't like to see this PR being accepted, this change will break the frontend developer flow on all our projects - and probably the majority of projects from others as well. All our projects use the local-themes.js file since Magento 2.2.0 introduced this feature (if memory serves me right).
No idea why we suddenly want to change this, it has been documented for years that this is the approach we should take.

Another argument against this: themes.js is shipped with Magento core, I consider the majority of files shipped with Magento as files we aren't allowed to change, so copying it to a non-existing file like how it's documented now, makes a lot of sense to me.

In an ideal world, the themes.js file should indeed have been named themes.js.sample like you say Simon, but that's not the case right now, so I would just keep the situation as it is right now to not introduce backwards compatible breaking changes. If Magento 2.5.0 ever happens, maybe we can reconsider this suggestion...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Partner: TechDivision partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: pending review Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Change theme name in grunt config
5 participants