RequireJS - Speaker Deck

Slide 1

Slide 1 text

RequireJS Sebastiano Armeli-Battana @sebarmeli NDC 2013, Oslo (Norway) Thursday, June 13, 13

Slide 2

Slide 2 text

Thursday, June 13, 13

Slide 3

Slide 3 text

Thursday, June 13, 13

Slide 4

Slide 4 text

Thursday, June 13, 13

Slide 5

Slide 5 text

Thursday, June 13, 13

Slide 6

Slide 6 text

1 2 3 4 5 6 Thursday, June 13, 13

Slide 7

Slide 7 text

app.js view.js Thursday, June 13, 13

Slide 8

Slide 8 text

view.js ------------ Thursday, June 13, 13

Slide 9

Slide 9 text

app.js ------------ Thursday, June 13, 13

Slide 10

Slide 10 text

4 6 4 6 Thursday, June 13, 13

Slide 11

Slide 11 text

Thursday, June 13, 13

Slide 12

Slide 12 text

Thursday, June 13, 13

Slide 13

Slide 13 text

app.js view.js helpers.js view2.js helpers2.js model.js Thursday, June 13, 13

Slide 14

Slide 14 text

app.js view.js helpers.js view2.js helpers2.js model.js 1 2 3 5 4 6 Thursday, June 13, 13

Slide 15

Slide 15 text

app.js view.js helpers.js view2.js helpers2.js model.js 1 2 3 5 4 6 4 1 3 2 5 6 Thursday, June 13, 13

Slide 16

Slide 16 text

Thursday, June 13, 13

Slide 17

Slide 17 text

Thursday, June 13, 13

Slide 18

Slide 18 text

Thursday, June 13, 13

Slide 19

Slide 19 text

AMD Thursday, June 13, 13

Slide 20

Slide 20 text

AMD Thursday, June 13, 13

Slide 21

Slide 21 text

Thursday, June 13, 13

Slide 22

Slide 22 text

Slide 23

Slide 23 text

define(function () { var title = “”; function f1() {} return { getTitle: function() { return title; } } }); RJS MODULE PATTERN Thursday, June 13, 13

Slide 24

Slide 24 text

define(id?, dependencies?, factory) Thursday, June 13, 13

Slide 25

Slide 25 text

index.html js / -- main.js -- helpers.js -- app / -- views / -- view1.js -- vendor / -- require.js view1.js ------------ define([‘helpers’], function(helpers){ return { init: function(){} } }); define(function(){ // code here }); helpers.js ------------ Thursday, June 13, 13

Slide 26

Slide 26 text

Slide 27

Slide 27 text

define([‘module1’, module2’], function (dep1, dep2) { // do something } ) Multiple Dependencies Thursday, June 13, 13

Slide 28

Slide 28 text

require(dependencies?, factory) Thursday, June 13, 13

Slide 29

Slide 29 text

index.html ------------

Slide 30

Slide 30 text

Thursday, June 13, 13

Slide 31

Slide 31 text

main.js ------------ require.config({ baseUrl: ‘./js’, paths: { ‘view1’: ‘app/views/view1’ } }); require([‘view1’],function(view1){ view1.init(); }); index.html js / -- main.js -- helpers.js -- app / -- views / -- view1.js -- vendor / -- require.js Thursday, June 13, 13

Slide 32

Slide 32 text

NO blocking! Thursday, June 13, 13

Slide 33

Slide 33 text

Thursday, June 13, 13

Slide 34

Slide 34 text

var node = document.createElement('script'); node.async = true; node.setAttribute('data-requirecontext', context.contextName); node.setAttribute('data-requiremodule', moduleName); node.src = url; var head = document.getElementsByTagName('head')[0]; head.appendChild(node); Script Loader Thursday, June 13, 13

Slide 35

Slide 35 text

require() asynchronous de!ne() - de!ne.amd AMD well suited for browser Thursday, June 13, 13

Slide 36

Slide 36 text

exports.render = function() {}; var module = require(‘view1’); NO de!ne() require() synchronous Server-side approach Thursday, June 13, 13

Slide 37

Slide 37 text

Simpliﬁed CommonJS Wrapper define(function(require, exports, module){ // Module required before the callback runs var helpers = require(‘helpers’); exports.render = function() { helpers.doSomething(); } }); Thursday, June 13, 13

Slide 38

Slide 38 text

define([“dep1”], function(require){ var helpers = require(‘helpers’); //code here }); Thursday, June 13, 13

Slide 39

Slide 39 text

define([“dep1”], function(require){ var helpers = require(‘helpers’); //code here }); Thursday, June 13, 13

Slide 40

Slide 40 text

Thursday, June 13, 13

Slide 41

Slide 41 text

Thursday, June 13, 13

Slide 42

Slide 42 text

if ( typeof define === "function" && define.amd ) { define( "jquery", [], function () { return jQuery; }); } Thursday, June 13, 13

Slide 43

Slide 43 text

Thursday, June 13, 13

Slide 44

Slide 44 text

index.html js / -- main.js -- helpers.js -- app / -- views / -- view1.js -- vendor / -- require.js -- backbone.js -- underscore.js -- jquery.js main.js ------------ require.config({ baseUrl: ‘js/vendor’, shim: { ‘underscore’:{ exports: ‘_’ }, ‘backbone’: { deps: [‘jquery’, ‘underscore’], exports: ‘Backbone’ } } }); require([‘backbone’],function(Backbone){ Backbone.history.start(); }); Thursday, June 13, 13

Slide 45

Slide 45 text

Slide 46

Slide 46 text

LOADER PLUGINS • i18n!, async!, domReady! • text!, css!, json!, cs!, hbs! [plugin Module ID]![resource ID] Thursday, June 13, 13

Slide 47

Slide 47 text

main.js ------------ require.config({ baseUrl: ‘./js’ }); require([‘text!partials/file.txt’], function(txt) { // txt goes here }); index.html js / -- main.js -- vendor / -- require.js -- text.js -- partials / -- !le.txt Thursday, June 13, 13

Slide 48

Slide 48 text

main.js ------------ require.config({ baseUrl: ‘./js’ }); require([‘css!../css/style.css’], function() { // After css is loaded }); index.html js / -- main.js -- vendor / -- require.js -- css.js css / -- style.css Thursday, June 13, 13

Slide 49

Slide 49 text

Thursday, June 13, 13

Slide 50

Slide 50 text

3 requests! Thursday, June 13, 13

Slide 51

Slide 51 text

r.js npm install -g requirejs OPTIMIZER Thursday, June 13, 13

Slide 52

Slide 52 text

r.js -o tools/build.js Thursday, June 13, 13

Slide 53

Slide 53 text

build.js ------------ ({ appDir:'../', mainConfigFile: '../js/main.js', dir: "../build", modules: [ { name: "../main" } ] }) index.html js / -- main.js -- helpers.js -- app / -- views / -- view1.js -- vendor / -- require.js tools / -- build.js Thursday, June 13, 13

Slide 54

Slide 54 text

build/js/main.js ---------------- index.html build / -- index.html -- build.txt -- js / -- main.js -- helpers.js -- app / -- views / -- view1.js -- vendor / -- require.js -- tools / -- build.js js/vendor/../main.js ---------------- js/helpers.js js/vendor/view1.js js/vendor/../main.js build/build.txt ---------------- Thursday, June 13, 13

Slide 55

Slide 55 text

OPTIMIZER 1 request! Thursday, June 13, 13

Slide 56

Slide 56 text

({ appDir:'../', mainConfigFile: '../js/main.js', dir: "../build", preserveLicenseComments: false, removeCombined: true, optimize: "uglify2", modules: [ { name: "../main", excludeShallow: [ "view1" ] } ] }) Thursday, June 13, 13

Slide 57

Slide 57 text

SOURCE MAPS ({ // other options generateSourceMaps: true, optimize: ‘uglify2’ }) Thursday, June 13, 13

Slide 58

Slide 58 text

Testing define([“view1”], function(view1) { describe(“view1”, function(){ it(“should do something”, function(){ // expectations }); }); }); Thursday, June 13, 13

Slide 59

Slide 59 text

runner.html ------------ runner.html spec / -- view1Spec.js -- main.js js / -- vendor / -- require.js

Slide 60

Slide 60 text

runner.html spec / -- view1Spec.js -- main.js js / -- vendor / -- require.js -- domReady.js require.config({ ... }); require( [“domReady!”,“spec/view1Spec”], function(document){ jasmine.getEnv().addReporter( new jasmine.HtmlReporter() ); jasmine.getEnv().execute(); }); main.js ------------ Thursday, June 13, 13

Slide 61

Slide 61 text

GRUNT integration?? npm install -g grunt-cli Grunt!le How to get Grunt? Thursday, June 13, 13

Slide 62

Slide 62 text

GRUNT integration?? grunt-contrib-requirejs npm install -g grunt-cli npm install grunt-contrib-require-js --save-dev Grunt!le How to get Grunt? Thursday, June 13, 13

Slide 63

Slide 63 text

module.exports = function(grunt) { var config = require(“build”); grunt.initConfig({ requirejs: { compile: { options: config } } grunt.loadNpmTasks('grunt-contrib-requirejs'); } Gruntfile.js ------------ Thursday, June 13, 13

Slide 64

Slide 64 text

grunt requirejs Thursday, June 13, 13

Slide 65

Slide 65 text

ES6 - Modules Module de!nition module [module ID] export [variable | function] Module dependency import { [var | fn] } from [module ID] Thursday, June 13, 13

Slide 66

Slide 66 text

ES6 - Modules module “helpers” { } module “view1” { import helpers from “helpers”; exports function init() {...}; } Thursday, June 13, 13

Slide 67

Slide 67 text

Recap Thursday, June 13, 13

Slide 68

Slide 68 text

Recap • Modularity Thursday, June 13, 13

Slide 69

Slide 69 text

Recap • No globals • Modularity Thursday, June 13, 13

Slide 70

Slide 70 text

Recap • Async Script loader • No globals • Modularity Thursday, June 13, 13

Slide 71

Slide 71 text

Recap • Async Script loader • No globals • Optimization • Modularity Thursday, June 13, 13

Slide 72

Slide 72 text

Recap • Async Script loader • Future proof • No globals • Optimization • Modularity Thursday, June 13, 13

Slide 73

Slide 73 text

http://requirejs.com https://github.com/asciidisco/grunt-requirejs @sebarmeli https://github.com/amdjs/amdjs-api/wiki/AMD http://wiki.ecmascript.org/doku.php?id=harmony:modules Thursday, June 13, 13