tips.js

var tips = [];

tips.push({
  author: 'bentruyman',
  message: 'Never Using Literals or <em>Lazy</em> Shorthand',
  example: [
    'var integer = new Number(5);',
    'var myString = new String("Hello World");',
    'var foo = new Object();',
    'var arrayOfFoo = new Array(5);',
    'if (status === new Boolean(true)) {',
    ' ...',
    '}'
  ]
});

tips.push({
  author: 'bentruyman',
  message: 'Extremely Descriptive <em>Self-Documenting</em> Variable Names',
  example: [
    'function CatObjectThatInheritsAnimal() {',
    ' this.yellowFurColorString = "yellow";',
    ' this.animalsAgeInYears = 10;',
    '}',
    '',
    'CatObjectThatInheritsAnimal.prototype = new AnimalObjectThatInheritsNothing;'
  ]
});

tips.push({
  author: 'bentruyman',
  message: 'Using Constants to Keep Everything <em>Abstract</em>',
  example: [
    'var FALSE = new Boolean(false);',
    'var TRUE = new Boolean(true);',
    'var ONE = new Number(1);',
    '',
    'function IF_STATEMENT(condition, callback) {',
    ' if (condition == TRUE) {',
    '   callback.call(this);',
    ' }',
    '}'
  ]
});

tips.push({
  author: 'bentruyman',
  message: 'Ensuring Lines Are Terminated With Multiple Semicolons So the JavaSript Parser <em>Really Knows</em> when a Line Is Ending',
  example: [
    'var helloWorld = function (message) {',
    ' if (!message) {',
    '   message = "Hello World";;;;;;',
    ' }',
    '',
    ' alert(message);;;;;;;;;;;;;;;;;;;',
    '',
    '};;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;'
  ]
});

tips.push({
  author: 'bentruyman',
  message: 'Creating <em>Really</em> Random Numbers',
  example: [
    'var reallyRandom = Math.pow(Math.random(), Math.random());'
  ]
});

tips.push({
  author: 'rwaldron',
  message: "Make sure you explicitly declare <em>EVERY VARIABLE</em> on it's own line, that way your team will know they are all variables",
  example: [
    'var li = "<li></li>";',
    'var div = "<div>"+li+"</div>";',
    'var num1 = 4;',
    'var num2 = 5;',
    'var total = num1 + num2;',
    'var rounded = Math.round(total);'
  ]
});

tips.push({
  author: 'paulca',
  message: "Use <em>HTML5</em> to link links to functions that link to links.",
  example: [
    '<a href="Javascript:openLink(\'homepage.aspx\',%20\'1\');">Homepage</a>'
  ]
});

tips.push({
  author: 'karbassi',
  message: "Use <em>tabs and spaces</em> to indent your code.",
  example: [
    'var x =    3;', 
    'var y =    4;', 
    'var z =    0;',
    '   z = x+y;'
  ]
});

tips.push({
  author: 'karbassi',
  message: "Use one space for <em>all</em> your indentation.",
  example: [
     'function(x,y){',
     ' if(x=3)',
     '  if(y!=3)',
     '   if(y+x>3)',
     '    return true;',
     '}'
  ]
});

tips.push({
  author: 'rwaldron',
  message: "Declaring your functions <em>globally</em> ensures they are accessible throughout your entire script. This ensures they always take precedence!",
  example: [
    'function postMessage(message) {', 
    ' $.post("/helloworld.php", "message="+message)', 
    '};'
  ]
});


tips.push({
  author: 'rwaldron',
  message: "Put your commas at the beginning of the line, because thats what they do in someother <em>Enterprise</em> languages",
  example: [
    'var CommaBomb = {', 
    ' defaults: "" ', 
    ' , options: "" ', 
    ' , settings: "" ', 
    ' , methods: { ', 
    '    getOptions: function () { ', 
    '    } ', 
    '    , setOptions: function () { ', 
    '    } ', 
    '    , getSettings: function () { ', 
    '    } ', 
    '    , setSettings: function () { ', 
    '    } ', 
    ' }',
    '};'
  ]
});

tips.push({
  author: 'erichynds',
  message: "For ultimate code reuse, declare a wrapper function for <em>everything</em>",
  example: [
    'function createInformationWindow(message){',
    '   alert(message);',
    '}',
    '',
    'function incrementVariable(variable,byHowMany){',
    '   return variable + byHowMany;',
    '}',
    '',
    'function alertIfOnePlusTwoEqualsThree(){',
    '   if( incrementVariable(1, 2) === 3 ){',
    '      createInformationWindow("LOLWAT?");',
    '   }',
    '}'
  ]
});

tips.push({
  author: 'mrgnrdrck',
  message: "Use bitwise operators for array bounds checks",
  example: [
    'if (index !== +index >>> 0 || index >= elements.length){',
    '   alert("fail!")',
    '}'
  ]
});


tips.push({
  author: 'rwaldron',
  message: "Wrap open source libraries in descriptive <em>'in-house namespaces'</em>.",
  example: [
    'var InitechCoreJQuery = jQuery',
    '',
    'InitechCoreJQuery( function () {', 
    ' InitechCoreJQuery(document).click(function () {', 
    '  //... ',
    ' })', 
    '})'
  ]
});

module.exports = tips;