Recent changes to Code Style

Code Style modified by Nicolai Josuttis

Nicolai Josuttis — Tue, 15 Sep 2015 16:34:03 -0000

--- v6
+++ v7
@@ -1,4 +1,4 @@
-[<=](Development Environment)  [=>](Todo List)
+[<=](Development Environment)  [=>]([Planning for version 1.9])

 Code Style Used in Enigmail

Code Style modified by Nicolai Josuttis

Nicolai Josuttis — Tue, 15 Sep 2015 16:33:20 -0000

--- v5
+++ v6
@@ -1,4 +1,4 @@
-[<=](Building Enigmail)  [=>](Development Environment)
+[<=](Development Environment)  [=>](Todo List)

 Code Style Used in Enigmail

Code Style modified by Nicolai Josuttis

Nicolai Josuttis — Sun, 13 Sep 2015 09:54:41 -0000

--- v4
+++ v5
@@ -1,4 +1,4 @@
-[<=](https://sourceforge.net/p/enigmail/wiki/Building%20Enigmail/)  [=>](https://sourceforge.net/p/enigmail/wiki/Development%20Environment/)
+[<=](Building Enigmail)  [=>](Development Environment)

 Code Style Used in Enigmail

Code Style modified by Nicolai Josuttis

Nicolai Josuttis — Sun, 13 Sep 2015 09:50:59 -0000

--- v3
+++ v4
@@ -1,3 +1,6 @@
+[<=](https://sourceforge.net/p/enigmail/wiki/Building%20Enigmail/)  [=>](https://sourceforge.net/p/enigmail/wiki/Development%20Environment/)
+
+
 Code Style Used in Enigmail
 ===

Code Style modified by Patrick Brunschwig

Patrick Brunschwig — Sun, 26 Jul 2015 15:45:12 -0000

--- v2
+++ v3
@@ -50,7 +50,8 @@
     let isError = getStatusFunc()
     (isError ? handleError : handleFailure)(a, b c);

-We prefer easier readable code like this, even if it requires more typing:
+
+We prefer code that is readable code, even if it requires more typing. E.g.:

     let isError = getStatusFunc()
     if (isError) {

Code Style modified by Patrick Brunschwig

Patrick Brunschwig — Sun, 26 Jul 2015 15:44:22 -0000

--- v1
+++ v2
@@ -2,6 +2,7 @@
 ===

 The code style used in Enigmail is derived from the standard code style of [js-beautify](https://github.com/beautify-web/js-beautify). We use js-beautify with the following non-default options:
+
 * indent-size: 2
 * end-with-newline: true
 * brace-style: end-expand

Code Style modified by Patrick Brunschwig

Patrick Brunschwig — Sun, 26 Jul 2015 15:44:05 -0000

Code Style Used in Enigmail

The code style used in Enigmail is derived from the standard code style of js-beautify. We use js-beautify with the following non-default options:
indent-size: 2
end-with-newline: true
* brace-style: end-expand

These defaults are committed to the top level source tree and will be automatically used by js-beautify.

Example:

/**
 * This is just a sample script.
 */

function tmp(a, b, c) {

  try {
    if (a === 1 && b.search(/an_example/)) {
      of_beautifer();
    }
    else {
      var a = b ? (c % d) : e[f];
    }

    switch (x) {
      case 1:
        doSomething();
        break;
      default:
        doDefault(x);
    }
  }
  catch (e) {
    // some comment
    handleEx();
  }

}

Writing Code

Please try to avoid statements that are hard to read such as:

let isError = getStatusFunc()
(isError ? handleError : handleFailure)(a, b c);

We prefer easier readable code like this, even if it requires more typing:

let isError = getStatusFunc()
if (isError) {
  handleError(a,b c);
}
else {
  handleFailure(a, b c);
}