box/brainy

Brainy - A smart, parallel templating engine based on Smarty

, _(*1)

, _(*2)

Brainy

Brainy is a replacement for the popular Smarty templating language. It is a fork from the Smarty 3 trunk., _(*3)

Brainy is still very new and it's likely that you will encounter some issues. Please report any problems that you encounter., _(*4)

Why Brainy?

• Brainy generates clean and fast code by default.
• Brainy has security defaults that align better with best practices.
• Brainy does not include features that are infrequently used and increase code bloat.

Because Brainy is a fork of Smarty 3, it shares much of the same syntax and features while eliminating dangerous footguns and making it hard to write bad code., _(*5)

Getting Started

Check out the Getting Started page on the wiki., _(*6)

Minimum Requirements

• PHP 7.3+
• mbstring PHP extension

The mbstring extension is required in order to properly support Unicode in templates and user-provided content. Brainy 3 cannot be run in a mode that does not handle Unicode properly., _(*7)

Contributing to Brainy

For information on how to set up a local dev environment and run the tests, see the wiki page on Hacking on Brainy., _(*8)

Where is Brainy headed?

See the project roadmap for information on upcoming releases., _(*9)

Requested Contributions

If you're interested in helping out, pull requests for the following tasks will be warmly welcomed:, _(*10)

• Convert all non-public methods to use camel case.
• Add proper PHPDoc annotations to all functions and methods.
• Refactoring:
  • Eliminate dead code
  • @ error suppression
  • Increase code coverage
  • etc.
• Help identify and resolve potential security issues, or find ways to help developers avoid security issues.
• Performance optimization of generated code

At the time of writing, the project has approximately 68% line coverage., _(*11)

Support

Need to contact us directly? Email oss@box.com and be sure to include the name of this project in the subject., _(*12)

Copyright and License

Copyright 2014-2015 Box, Inc. All rights reserved., _(*13)

Copyright 2002 – 2014 New Digital Group, Inc., _(*14)

This library is licensed under the GNU Lesser Public License. A copy of the license should have been provided., _(*15)