Uniform code style

[johnd0e]

In current code base we can see now a variety of different styles. It would be great to bring everything to some common code style.

So let's discuss here:

1. Elements of iitc-code uniform style

2. Tools to implement style checking, and ways to include them in our CI-chain.

[johnd0e]

So if we prefer to keep existing style's elements then we should use eslint. Otherwise, we could use some 'opinionated' formatter, like prettier or StandardJS.

[modos189]

Project code style is specified in https://github.com/IITC-CE/ingress-intel-total-conversion/blob/master/HACKING.md#code-style

But eslint only reports discrepancy to code style? I think utility itself should format code to our style

[johnd0e]

Project code style is specified in https://github.com/IITC-CE/ingress-intel-total-conversion/blob/master/HACKING.md#code-style

Great. I will make .eslintrc with that rules.

But eslint only reports discrepancy to code style?

There is --fix option. But not all issues could be resolves automatically.

I think utility itself should format code to our style

prettier is even more automatic, but it's rules are predefined, so we can use it only if we agree with the whole style.

P.S. Anyway, we need to merge all old PR's before any global changes.

[johnd0e]

BTW, found inconsistency in the document. Here is a rule:

• there should be a space after if, for, etc. E.g. if (true) { doStuff(); } else { dontDoStuff(); }

But see at example two lines upper:

• opening brace on the same line: if(blub) {

[johnd0e]

And perhaps we need to add some other rules to the list. E.g. https://eslint.org/docs/rules/semi

[johnd0e]

Here is the same specification with eslint rules' references added (.eslintrc will follow). Perhaps we should add some more rules, so consider it's still a draft.

Code Style

Please follow the these guidelines. Some are just preference, others are good practice.

• IITC sources currently meet ES 5.1 standard
• eqeqeq: use identity operators: === and !==. Why do I want this?
• jQuery is your friend
• indent using two spaces
• enforce semicolon
• 'one true brace-style':
  • opening brace on the same line: if (blub) {
  • else clauses: } else if (blub) { or } else {
• keyword-spacing: there should be a space after if, for, etc. E.g. if (true) { doStuff(); } else { dontDoStuff(); }
• spaced-comment: // this is a comment
• quotes: Use single-quotes for JavaScript and double-quotes for HTML content. Example: $('body').append('<div id="soup">Soup!</div>');.
• there is no length limit on lines, but try to keep them short where suitable
• no-trailing-spaces: ensure you remove all trailing whitespace before submitting your patch. If you editor doesn’t detect those for you, try grep -nE "[[:space:]]+$" «filename»