Code Review for Sightly component | Community
Skip to main content
vivs92490136
vivs92490136
Level 2
October 18, 2016

Code Review for Sightly component

  • October 18, 2016
  • 4 replies
  • 2981 views

Is there any code quality check tool available for component development in sightly? Even a checklist or best practice deck would help. What is the best approach for reviewing/checking code quality of a sightly component ?

    This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.

    4 replies

    smacdonald2008
    smacdonald2008
    Level 10
    October 18, 2016

    Check the HTL (not named Sightly anymore) spec:

    https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/master/SPECIFICATION.md

    There isn't a tool that checks code. 

    smacdonald2008
    smacdonald2008
    Level 10
    October 18, 2016

    If you are looking to build a HTL component that uses the WcMUsePojo Java class -- see: 

    http://scottsdigitalcommunity.blogspot.ca/2016/07/creating-aem-html-template-language.html

    There are links here to 6.1, 6.2, and a video. 

    kautuk_sahni
    Community Manager
    kautuk_sahniCommunity Manager
    Community Manager
    October 19, 2016

    I do not think so that there is some tool to validate this.

    But, best practice is to use AEM HTL/Sightly Brackets Extension. You can install this extension on Brackets if you plan to use HTL (Formerly known as Sightly) as the markup. The extension provides you with features such as syntax highlighting and code completion. Brackets extension provides front-end developers an AEM templating tool with which they are familiar. The idea is to bring more front-end developers to AEM template designing.

    Documentation : https://docs.adobe.com/docs/en/dev-tools/aem-brackets.html

    Thanks and Regards

    Kautuk Sahni

    Kautuk Sahni
    smacdonald2008
    smacdonald2008
    Level 10
    October 20, 2016

    To further add to what Kautuk suggested - watch this Ask the AEM Community Experts session:

    https://communities.adobeconnect.com/p72w6ea9pf1/?launcher=false&fcsContent=true&pbMode=normal

    It talks about Brackets/HTL development. 

    Feike_Visser1
    Adobe Employee
    Feike_Visser1Adobe Employee
    Adobe Employee
    October 20, 2016

    Couple of things from my side:

    - try to use the expressions first, rather than writing code

    - some logic can be written in just a couple of lines in JavaScript

    - if you need to write code use SlingModels, WCMUsePojo is harder to reuse/test

    - avoid <sly />, data-sly-unwrap and stick with the HTML output that you want

      K
      Khoa_Dang_Nguye
      October 20, 2016

      Check this HTL (formly Sightly) style guide. It might be helpful for you.

      http://erikgrijzen.com/index.php/2015/08/04/aem-sightly-style-guide/

      Terms & ConditionsAccessibility statement

      Loading footer...