Thursday, January 2, 2020

Sitecore SXA CLI tips & tricks

I've been working with SXA themes recently and came across this great blog post by Serge van den Oever on creating a custom theme for SXA using SXA CLI and wanted to share a few extra tips on top of it.

NodeJS version
SXA CLI (specifically, Gulp 3.9.1) does not play well with Node version > 11 (the latest is 13) and will fail with "ReferenceError: primordials is not defined" error. One way of fixing it is using Node Version Switcher, but there is also a little trick I found on StackOverflow. You just need to create a npm-shrinkwrap.json file containing this:
{
  "dependencies": {
    "graceful-fs": {
      "version": "4.2.2"
    }
  }
}
before running NPM install.

Initial build & deploy
If you run standard "gulp default" task after the fresh checkout and you've excluded .css files from GIT - the task will silently fail to upload optimized style sheets.But there are few built-in commands that help you fix it - just run "gulp sassComponents" and "gulp sassStyles" before "gulp default" and SXA CLI will pre-generate .css for all .scss components.

Hope this helps you get started with the tool. I will update the post with additional hints, you're welcome to share yours in the comments!

9 comments:

  1. Thanks for your post, it guided me into the right direction! I have put a lot of effort into implementing a good way of working using the Sitecore SXA CLI. I published the results on Github at https://github.com/macaw-interactive/SXACLI-enhancements. Let me know if anything is missing.

    ReplyDelete
  2. Really it is very useful for us..... the information that you have shared is really useful for everyone.Nice article i have ever read information's like this.it's really awesome the way you have delivered your ideas.i hope you will add more content in your blog PHP Training in Chennai | Certification | Online Training Course | Machine Learning Training in Chennai | Certification | Online Training Course | iOT Training in Chennai | Certification | Online Training Course | Blockchain Training in Chennai | Certification | Online Training Course | Open Stack Training in Chennai |
    Certification | Online Training Course

    ReplyDelete
  3. very interesting, good job and thanks for sharing such a good blog. Seo Services Delhi

    ReplyDelete
  4. I read this post your post so nice and very informative post thanks for sharing this post. Youtube Mp3 Converter

    ReplyDelete
  5. Really amazing information, thanks for sharing this valuable information with us. Visit Ogen Infosystem for the best website designing services and PPC Services at an affordable price.
    Web Designing Company

    ReplyDelete