# Coding standard/style for Ignition script

**URL:** <https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461>\
**Category:** General Discussion\
**Created:** [December 13, 2016, 6:38am UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461 "2016-12-13T06:38:59Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![ThomasL](https://avatars.discourse-cdn.com/v4/letter/t/59ef9b/32.png) [@ThomasL](https://forum.inductiveautomation.com/u/ThomasL)\
**Post date:** [December 13, 2016, 6:38am UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/1 "2016-12-13T06:38:59Z")

</div>

Hi,  
Like to know if there is literature for the coding standard/style of the ignition script language.

For JAVA, there is coding style like (for example) [geosoft.no/development/javastyle.html](http://geosoft.no/development/javastyle.html)  
Also there is static tools for JAVA codes like (for example) [en.wikipedia.org/wiki/PMD\_(software](https://en.wikipedia.org/wiki/PMD_(software))

Thank you

---

<div class="post-metadata">

**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\
**Post date:** [December 13, 2016, 1:47pm UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/2 "2016-12-13T13:47:34Z")

</div>

Ignition uses [jython](http://www.jython.org/docs/), which is an implementation of [python](https://docs.python.org/2.7/). Unlike most popular languages, python identifies control structures (if, for, while, …) by indentation. So style is constrained by the rules of the language. This was very much intended by the inventor of the language.  
For all practical purposes there is no style guide, because it’s not needed.

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [December 13, 2016, 3:33pm UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/3 "2016-12-13T15:33:46Z")

</div>

There is a style guide, but by writing code that has valid syntax you’re mostly forced to follow it: [python.org/dev/peps/pep-0008/](https://www.python.org/dev/peps/pep-0008/)

---

<div class="post-metadata">

**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\
**Post date:** [December 13, 2016, 7:13pm UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/4 "2016-12-13T19:13:08Z")

</div>

[quote=“Kevin.Herron”]There is a style guide[/quote]Interesting. I never noticed that PEP, even though I’ve browsed them before. Based on a quick skim, I’m a baaaaad boy.

---

<div class="post-metadata">

**Author:** ![nmudge](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nmudge/32/3394_2.png) [@nmudge](https://forum.inductiveautomation.com/u/nmudge)\
**Post date:** [December 13, 2016, 7:35pm UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/5 "2016-12-13T19:35:24Z")

</div>

Hi Thomas,

I created a programming style guide for Ignition projects. You are free to use it. See it at this link: [perfectabstractions.com/perf … guide.html](http://www.perfectabstractions.com/perfect-abstractions-ignition-project-developer-style-guide.html)

Also, I am happy to receive any comments or suggestions about it.

Best,

---

<div class="post-metadata">

**Author:** ![ThomasL](https://avatars.discourse-cdn.com/v4/letter/t/59ef9b/32.png) [@ThomasL](https://forum.inductiveautomation.com/u/ThomasL)\
**Post date:** [December 15, 2016, 12:25am UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/6 "2016-12-15T00:25:07Z")

</div>

Thank you all for all the valuable feedback and references.

---

<div class="post-metadata">

**Author:** ![tyler.bennett](https://avatars.discourse-cdn.com/v4/letter/t/f04885/32.png) [@tyler.bennett](https://forum.inductiveautomation.com/u/tyler.bennett)\
**Post date:** [September 28, 2023, 2:13am UTC](https://forum.inductiveautomation.com/t/coding-standard-style-for-ignition-script/12461/7 "2023-09-28T02:13:41Z")

</div>

Sorry to bump the old thread but the topic is still relevant and good reference info seems hard to come by. I've been looking for best/common practice info on naming and folder structure for perspective views, among other things, in order to communicate/implement some simple standard practices for our dev team.

Here is another "style guide" I came across while looking for similar data. It is not mine but freely available on GitHub. I'm not clear on how to apply the "Linting" info in an Ignition environment (due to lack of familiarity) but all the other info seems relevant.

@kgamble I believe this is your content.

> **[GitHub - design-group/style-guide: This project defines different style...](https://github.com/design-group/style-guide)**
>
> This project defines different style guides for other projects and is a reference not a set of rules. - GitHub - design-group/style-guide: This project defines different style guides for other proj...
