commit 362c2e0f2f4ca9d4bff7fe6fdc8dca4a27177bba
parent bcc70d6949d0d0cc5e71c839ebe46ed6bcbdfee3
Author: Florian Dold <florian.dold@gmail.com>
Date: Mon, 4 Jan 2016 14:36:26 +0100
style
Diffstat:
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/style.txt b/style.txt
@@ -1,10 +1,10 @@
-Javascript style
+TypeScript style
================
Basics:
- Indent with 2 spaces.
- Keep a maximum line length of 120 characters.
-- Prefer "double quotes" for strings/
+- Prefer "double quotes" for strings.
- Never omit optional semicolons.
- Do not put opening braces or brackets on a new line.
- Call functions without spaces: foo(bar)
@@ -12,12 +12,21 @@ Basics:
- Declare "use strict;".
- Use rocket (=>) syntax for anonymous functions. If an anonymous function is
too long, make it a named function.
+- Use the strict equality operator (===).
- Document functions with JSDoc comments (http://usejsdoc.org).
+
+JavaScript version:
+Stick with ES6 features. Do not rely on any vendor-specific extensions (such
+as Firefox often offers). ES6 features not yet supported by major browsers are
+okay as long as there is a well-supported and reasonable polyfill (such as
+babel) available.
+
+
Names:
- Use PascalCase for classes/types, camelCase for variables, functions and
properties, UPPER_SNAKE_CASE for constants, kebab-case for event names.
-- Only capitalize the first letter of an acronym in identifiers.
+- Only capitalize the first letter of an acronym in identifiers (e.g. HttpResponseCode).
APIs:
