https://github.com/umakantp/smartylint

SmartyLint helps you to write better code in Smarty template files.
https://github.com/umakantp/smartylint

Last synced: about 2 months ago
JSON representation

SmartyLint helps you to write better code in Smarty template files.

• Host: GitHub
• URL: https://github.com/umakantp/smartylint
• Owner: umakantp
• License: bsd-3-clause
• Created: 2013-09-02T16:54:28.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2025-04-16T19:11:31.000Z (2 months ago)
• Last Synced: 2025-04-17T04:15:57.028Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 87.9 KB
• Stars: 5
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGE_LOG
  • License: LICENSE

Awesome Lists containing this project

README

        
SmartyLint

==========

About

------------

SmartyLint is a PHP program that finds problems in Smarty files. It is tool that can be used for helping yourself for writing clean Smarty template files.

Requirements

------------

SmartyLint requires PHP version 5.2.4 or greater.

How to use?

------------

Download SmartyLint from github and start using.

    git clone git://github.com/umakantp/SmartyLint.git

    cd SmartyLint

    git checkout v0.2.0

    php smartyl -h

See our documentation at https://github.com/umakantp/SmartyLint/wiki for more information.

Smarty conventions

------------------

If you start using SmartyLint, it would force you to follow certain standards. Conventions for Smarty files are:-

* Should have one empty line at the bottom.

* Should not have more than 1 empty line at the bottom

* You should write file doc comment at the top in Java Doc format which contains short file description and all the variables used.

* There should be no TODO's and FixMe's in the code.

* Never use HTML comments. You should use Smarty comments {**} instead.

* No whitespace / empty spaces at the end of each line.

* Can have max only 2 empty lines in the content (i.e. 3 new lines in a row).

More conventions would be added as an when code is added for it.

Contributing and Issues

-----------------------

* If you want to report a bug reports open new issue on github.

* Have improvements? or Fixes? You can send in pull request for additional features or rules.