Coding standards

[bifurcation]

Draft list of standards to enforce:

• Each file must have copyright notice at the top (maybe change from ISRG to CONTRIBUTORS)
• All files must be strict mode ('use strict';)
• Dependencies must be imported as const, e.g., const foo = require('foo');
• Variable declarations must use let (not var)
• Indentation uses two spaces
• es6lint must pass with no errors (warnings allowed by discouraged)
• .then and .catch lines following promises are indented 2 spaces
• Prefer arrow functions to function functions

[hildjj]

• [x] Each file must have copyright notice at the top (maybe change from ISRG to CONTRIBUTORS)
• [x] All files must be strict mode ('use strict';)
• [x] Dependencies must be imported as const, e.g., const foo = require('foo');
• [x] Variable declarations must use let (not var)
• [x] Indentation uses two spaces
• [x] es6lint must pass with no errors (warnings allowed by discouraged)
• [x] .then and .catch lines following promises are indented 2 spaces
• [x] Prefer arrow functions to function functions
• [ ] When acronyms appear in names, they are all-caps. (Yes HTTPChallenge, no HttpChallenge)
• [ ] No parens in around arrow function arguments unless there are multiples. so a => a.foo() or (a,b) => a+b, but not (a) => a.foo()

[hildjj]

OK?

// Copyright (c) 2016 the rocket-skates CONTRIBUTORS.  All rights reserved.
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

[hildjj]

Reference needed for es6lint, apparently. Do you just mean eslint in es6 mode?

[bifurcation]

Yep. Whatever was running with gulp lint.

[bifurcation]

One more:

• When acronyms appear in names, they are all-caps. (Yes HTTPChallenge, no HttpChallenge)

[hildjj]

Do you have a list of acronyms you want to support? It will be possible to add more later.

[bifurcation]

One more:

• No parens in around arrow function arguments unless there are multiples. so a => a.foo() or (a,b) => a+b, but not (a) => a.foo()

As far as acronyms, things that come to mind:

• JWS
• HTTP
• DNS
• TLS

Some of those are going to appear as all-lowercase variable names (e.g., jws for a variable pointing to a signed object), so maybe that one isn't great to enforce.

[hildjj]

What about not needing them uppercase if they're the whole word? http is ok, but HTTPfoo.