From 00899fd6038b42f08476dbd97134d0502b09fb5a Mon Sep 17 00:00:00 2001 From: Eyal Weiss Date: Sun, 17 Nov 2013 11:45:27 +0200 Subject: [PATCH 1/5] Update README.md Added my shit (Usage of &&, ||) --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.md b/README.md index 32225f1d18..86130c0525 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ 1. [Naming Conventions](#naming-conventions) 1. [Accessors](#accessors) 1. [Constructors](#constructors) + 1. [Usage of &&, ||](#andorusage) 1. [Events](#events) 1. [Modules](#modules) 1. [jQuery](#jquery) @@ -1239,6 +1240,57 @@ **[[⬆]](#TOC)** + +## Usage of &&, || + + - When are simple enough, using &&, || operators outside of "if" expressions is cool and saves keystrokes. + The classic case is optional callbacks - + + ```js + // bad + if (callback) { + callback(); + } + + ... + + if (typeof callback === 'function') { + callback(); + } + ``` + + prefer: + + ```js + // good + callback && callback(); + + ... + + if (callback) callback(); + ``` + + + - Another example where || can (and should) be used to make things simpler + + ```js + // bad + if (val === undefined) { + return -1; + } + return val; + ``` + + prefer: + + ```js + // good + return val || -1; + ``` + + **[[⬆]](#TOC)** + + ## Events - When attaching data payloads to events (whether DOM events or something more proprietary like Backbone events), pass a hash instead of a raw value. This allows a subsequent contributor to add more data to the event payload without finding and updating every handler for the event. For example, instead of: From 9fcc4172972d80b3f74c306eb4fb50a5a2942b46 Mon Sep 17 00:00:00 2001 From: Eyal Weiss Date: Sun, 17 Nov 2013 12:01:58 +0200 Subject: [PATCH 2/5] Create .jshintrc added jshint config file for Webstorm --- .jshintrc | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 .jshintrc diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000000..73d6178e54 --- /dev/null +++ b/.jshintrc @@ -0,0 +1,120 @@ +{ + // ----------------- + // -------------------------------------------------------------------- + // JSHint Configuration, Strict Edition + // -------------------------------------------------------------------- + // + // This is a options template for [JSHint][1], using [JSHint example][2] + // and [Ory Band's example][3] as basis and setting config values to + // be most strict: + // + // * set all enforcing options to true + // * set all relaxing options to false + // * set all environment options to false, except the browser value + // * set all JSLint legacy options to false + // + // [1]: http://www.jshint.com/ + // [2]: https://github.com/jshint/node-jshint/blob/master/example/config.json + // [3]: https://github.com/oryband/dotfiles/blob/master/jshintrc + // + // @author http://michael.haschke.biz/ + // @license http://unlicense.org/ + + // == Enforcing Options =============================================== + // + // These options tell JSHint to be more strict towards your code. Use + // them if you want to allow only a safe subset of JavaScript, very + // useful when your codebase is shared with a big number of developers + // with different skill levels. + + "bitwise": true, // Prohibit bitwise operators (&, |, ^, etc.). + "curly": true, // Require {} for every new block or scope. + "eqeqeq": true, // Require triple equals i.e. `===`. + "forin": true, // Tolerate `for in` loops without `hasOwnPrototype`. + "immed": true, // Require immediate invocations to be wrapped in parens e.g. `( function(){}() );` + "latedef": true, // Prohibit variable use before definition. + "newcap": true, // Require capitalization of all constructor functions e.g. `new F()`. + "noarg": true, // Prohibit use of `arguments.caller` and `arguments.callee`. + "noempty": true, // Prohibit use of empty blocks. + "nonew": true, // Prohibit use of constructors for side-effects. + "plusplus": true, // Prohibit use of `++` & `--`. + "regexp": true, // Prohibit `.` and `[^...]` in regular expressions. + "undef": true, // Require all non-global variables be declared before they are used. + "strict": true, // Require `use strict` pragma in every file. + "trailing": true, // Prohibit trailing whitespaces. + + // == Relaxing Options ================================================ + // + // These options allow you to suppress certain types of warnings. Use + // them only if you are absolutely positive that you know what you are + // doing. + + "asi": false, // Tolerate Automatic Semicolon Insertion (no semicolons). + "boss": false, // Tolerate assignments inside if, for & while. Usually conditions & loops are for comparison, not assignments. + "debug": false, // Allow debugger statements e.g. browser breakpoints. + "eqnull": false, // Tolerate use of `== null`. + "es5": false, // Allow EcmaScript 5 syntax. + "esnext": false, // Allow ES.next specific features such as `const` and `let`. + "evil": false, // Tolerate use of `eval`. + "expr": false, // Tolerate `ExpressionStatement` as Programs. + "funcscope": false, // Tolerate declarations of variables inside of control structures while accessing them later from the outside. + "globalstrict": true, // Allow global "use strict" (also enables 'strict'). + "iterator": false, // Allow usage of __iterator__ property. + "lastsemic": false, // Tolerat missing semicolons when the it is omitted for the last statement in a one-line block. + "laxbreak": false, // Tolerate unsafe line breaks e.g. `return [\n] x` without semicolons. + "laxcomma": false, // Suppress warnings about comma-first coding style. + "loopfunc": false, // Allow functions to be defined within loops. + "multistr": false, // Tolerate multi-line strings. + "onecase": false, // Tolerate switches with just one case. + "proto": false, // Tolerate __proto__ property. This property is deprecated. + "regexdash": false, // Tolerate unescaped last dash i.e. `[-...]`. + "scripturl": false, // Tolerate script-targeted URLs. + "smarttabs": false, // Tolerate mixed tabs and spaces when the latter are used for alignmnent only. + "shadow": false, // Allows re-define variables later in code e.g. `var x=1; x=2;`. + "sub": false, // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`. + "supernew": false, // Tolerate `new function () { ... };` and `new Object;`. + "validthis": false, // Tolerate strict violations when the code is running in strict mode and you use this in a non-constructor function. + + // == Environments ==================================================== + // + // These options pre-define global variables that are exposed by + // popular JavaScript libraries and runtime environments—such as + // browser or node.js. + + "browser": true, // Standard browser globals e.g. `window`, `document`. + "couch": false, // Enable globals exposed by CouchDB. + "devel": false, // Allow development statements e.g. `console.log();`. + "dojo": false, // Enable globals exposed by Dojo Toolkit. + "jquery": false, // Enable globals exposed by jQuery JavaScript library. + "mootools": false, // Enable globals exposed by MooTools JavaScript framework. + "node": false, // Enable globals available when code is running inside of the NodeJS runtime environment. + "nonstandard": false, // Define non-standard but widely adopted globals such as escape and unescape. + "prototypejs": false, // Enable globals exposed by Prototype JavaScript framework. + "rhino": false, // Enable globals available when your code is running inside of the Rhino runtime environment. + "wsh": false, // Enable globals available when your code is running as a script for the Windows Script Host. + + // == JSLint Legacy =================================================== + // + // These options are legacy from JSLint. Aside from bug fixes they will + // not be improved in any way and might be removed at any point. + + "nomen": false, // Prohibit use of initial or trailing underbars in names. + "onevar": true, // Allow only one `var` statement per function. + "passfail": false, // Stop on first error. + "white": true, // Check against strict whitespace and indentation rules. + + // == Undocumented Options ============================================ + // + // While I've found these options in [example1][2] and [example2][3] + // they are not described in the [JSHint Options documentation][4]. + // + // [4]: http://www.jshint.com/options/ + + "maxerr": 100, // Maximum errors before stopping. + "predef": [ // Extra globals. + "define", + "require", + "console" + ], + "indent": 2 // Specify indentation spacing +} From 0fc884a6742bbf261bfe429edc910f2c5942f0bc Mon Sep 17 00:00:00 2001 From: Eyal Weiss Date: Sun, 17 Nov 2013 12:07:28 +0200 Subject: [PATCH 3/5] moved jshint file --- .jshintrc => linters/Webstorm-jshint/.jshintrc | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .jshintrc => linters/Webstorm-jshint/.jshintrc (100%) diff --git a/.jshintrc b/linters/Webstorm-jshint/.jshintrc similarity index 100% rename from .jshintrc rename to linters/Webstorm-jshint/.jshintrc From d587bc29dc0efd00b0544a8e814778026a58ddfd Mon Sep 17 00:00:00 2001 From: Eyal Weiss Date: Sun, 17 Nov 2013 12:09:51 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86130c0525..e7a8a25a33 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Airbnb JavaScript Style Guide() { - +# JavaScript Style Guide() { *A mostly reasonable approach to JavaScript* +##### Forked from [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) ## Table of Contents From cc5628f41f07955fd65bca15eb54477e95896f0f Mon Sep 17 00:00:00 2001 From: gr82bu Date: Thu, 21 Nov 2013 11:46:58 +0200 Subject: [PATCH 5/5] Added JSHint globals for Underscore.js and Angular.js --- .../SublimeLinter/SublimeLinter.sublime-settings | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/linters/SublimeLinter/SublimeLinter.sublime-settings b/linters/SublimeLinter/SublimeLinter.sublime-settings index 1e12f7c6bb..05dc069501 100644 --- a/linters/SublimeLinter/SublimeLinter.sublime-settings +++ b/linters/SublimeLinter/SublimeLinter.sublime-settings @@ -28,6 +28,19 @@ // Define globals exposed by Node.js. "node": true, + /* + * GLOBALS + * ================= + */ + + "globals": { + // Define globals exposed by Underscore.js. + "_": true, + + // Define globals exposed by Angular.js. + "angular": true + }, + /* * ENFORCING OPTIONS * =================