42 |
43 |
44 |
45 |
46 | __BODY__
47 |
48 |
49 |
50 |
51 |
52 | Hello, World!
'); 12 | ``` 13 | 14 | ## local.Response 15 | 16 | ### .writeHead(status, reason, headers) 17 | 18 | - `status`: required number, the numeric result code (Statuses Reference). 19 | - `reason`: optional string, a phrase explaining the result 20 | - `headers`: optional object, a dictionary of header values 21 | - returns `this` 22 | 23 | Initiates the response transmission. After calling this function, headers can not be altered. 24 | 25 | Header values may be objects if a serialization function is registered with `local.httpHeaders`. 26 | 27 | » httpHeaders 28 | 29 | --- 30 | 31 | ### .setHeader(header, value) 32 | 33 | - `header`: required string, the header key/name 34 | - `value`: required string|object 35 | 36 | --- 37 | 38 | ### .getHeader(header) 39 | 40 | - `header`: required string, the header key/name 41 | - returns string|object 42 | 43 | --- 44 | 45 | ### .removeHeader(header) 46 | 47 | - `header`: required string, the header key/name 48 | 49 | --- 50 | 51 | ### .header(header, value) 52 | 53 | - `header`: required string, the header key/name 54 | - `value`: optional string|object 55 | - returns string|object or undefined 56 | 57 | If `value` is given, will update the value of `header` and returns undefined. Otherwise, returns the current value. 58 | 59 | --- 60 | 61 | ### .write(data) 62 | 63 | - `data`: required string|object 64 | - returns `this` 65 | 66 | Writes data to the response. This will notify the client with the "data" event. 67 | 68 | If an object is given and a serialization function for the response's content-type is registered with `local.contentTypes`, Local.js will attempt to stringify the content before emitting "data". 69 | 70 | --- 71 | 72 | ### .end(data) 73 | 74 | - `data`: optional string|object 75 | - returns `this` 76 | 77 | Closes the response, calling `write()` if `data` is provided, then emitting the "end" event to the client. 78 | 79 | `local.Response` buffers all data written to the stream and save it to the `body` attribute. If a deserialization function for the response's content-type is registered with `local.contentTypes`, Local.js will attempt to parse the data before emitting "end". 80 | 81 | --- 82 | 83 | ### .close() 84 | 85 | - returns `this` 86 | 87 | Closes the stream, emitting the "close" event on the client. 88 | 89 | --- 90 | 91 | ### .status 92 | 93 | The numeric response code 94 | 95 | --- 96 | 97 | ### .reason 98 | 99 | The string response phrase 100 | 101 | --- 102 | 103 | ### .headers 104 | 105 | The headers as set by the server 106 | 107 | --- 108 | 109 | ### .parsedHeaders 110 | 111 | The headers parsed by `local.httpHeaders` 112 | 113 | --- 114 | 115 | ### .body 116 | 117 | The buffered response body 118 | 119 | --- 120 | 121 | ### .body_ 122 | 123 | A promise to the response body 124 | 125 | --- 126 | 127 | ### .isConnOpen 128 | 129 | A boolean 130 | 131 | --- 132 | 133 | ### .latency 134 | 135 | The round-trip time from dispatch to stream close in MS 136 | 137 | ## Events 138 | 139 | ### "headers" 140 | 141 | ``` 142 | function (response) { } 143 | ``` 144 | 145 | --- 146 | 147 | ### "data" 148 | 149 | ``` 150 | function (chunk) { } 151 | ``` 152 | 153 | --- 154 | 155 | ### "end" 156 | 157 | ``` 158 | function () { } 159 | ``` 160 | 161 | --- 162 | 163 | ### "close" 164 | 165 | ``` 166 | function () { } 167 | ``` -------------------------------------------------------------------------------- /docs/en/0.6.2/api/rtcbridgeserver.md: -------------------------------------------------------------------------------- 1 | RTCBridgeServer 2 | ================== 3 | 4 | --- 5 | 6 | Descends from `local.BridgeServer`. Handles the WebRTC peer connection process and establishes an SCTP DataChannel for exchanging requests with the peer. 7 | 8 | Typically created and managed by a `local.Relay` instance. 9 | 10 | ### local.RTCBridgeServer(config) 11 | 12 | - `config.peer`: required string, who we are connecting to (a valid peer domain) 13 | - `config.relay`: required local.Relay 14 | - `config.initiate`: optional bool, if true will initiate the connection processes 15 | - `config.loopback`: optional bool, is this the local host? If true, will connect to self 16 | - `config.retryTimeout`: optional number, time (in ms) before a connection is aborted and retried (defaults to 15000) 17 | - `config.retries`: optional number, number of times to retry before giving up (defaults to 3) 18 | 19 | ## local.RTCBridgeServer 20 | 21 | ### .getPeerInfo() 22 | 23 | - returns `{ domain:, user:, relay:, app:, sid: }` 24 | 25 | ```javascript 26 | peerServer.getPeerInfo(); 27 | /* => { 28 | domain: 'bob@grimwire.net!chat.grimwire.com!123', 29 | user: 'bob', 30 | relay: 'grimwire.net', 31 | app: 'chat.grimwire.com', 32 | sid: '123' 33 | } */ 34 | ``` 35 | 36 | --- 37 | 38 | ### .handleRemoteRequest(request, response) 39 | 40 | - `request`: required local.Request 41 | - `response`: required local.Response 42 | 43 | Handles requests from the peer to the page. If not overridden directly or with a server function provided by `config.relay`, will respond 500. 44 | 45 | --- 46 | 47 | ### .terminate() 48 | 49 | Closes the peer connection. -------------------------------------------------------------------------------- /docs/en/0.6.2/api/server.md: -------------------------------------------------------------------------------- 1 | Server 2 | ====== 3 | 4 | --- 5 | 6 | The base prototype for server objects. 7 | 8 | ```javascript 9 | function MyServer(config) { 10 | local.Server.call(this, config); 11 | } 12 | MyServer.prototype = Object.create(local.Server.prototype); 13 | 14 | MyServer.prototype.handleLocalRequest(req, res) { 15 | res.writeHead(204, 'ok, no content'); 16 | res.end(); 17 | } 18 | ``` 19 | 20 | ## local.Server 21 | 22 | ### .handleLocalRequest( request, response ) => undefined 23 | 24 | Request handler, should be overridden by subtypes. 25 | 26 | --- 27 | 28 | ### .terminate() 29 | 30 | Teardown handler, should be overridden by subtypes. 31 | 32 | --- 33 | 34 | ### .getDomain() 35 | 36 | - returns string, the registered hostname of the server instance 37 | 38 | --- 39 | 40 | ### .getUrl() 41 | 42 | - returns string, the full URL of the server instance 43 | 44 | --- 45 | 46 | ### .config 47 | 48 | An object, contains values in the constructor's config object. 49 | 50 | - `config.domain`: the hostname given to the server by `local.addServer()` -------------------------------------------------------------------------------- /docs/en/0.6.2/api/setdispatchwrapper.md: -------------------------------------------------------------------------------- 1 | setDispatchWrapper() 2 | ==================== 3 | 4 | --- 5 | 6 | An optional middleware that is injected between `dispatch()` and delivery of the request. 7 | 8 | ```javascript 9 | local.setDispatchWrapper(function(request, response, dispatch) { 10 | dispatch(request, response).always(console.log.bind(console, request)); 11 | }); 12 | ``` 13 | 14 | It can be used for setting global policies such as: 15 | 16 | - Logging 17 | - Caching strategies 18 | - Traffic rerouting 19 | - Permissioning 20 | - Header behaviors 21 | - Formatting and sanitizing 22 | 23 | Make sure that all requests eventually receive a response, even if the request is not passed on to the given dispatch function. 24 | 25 | ### local.setDispatchWrapper(wrapperFn) 26 | 27 | - `wrapperFn`: required function(request, response, dispatch) -------------------------------------------------------------------------------- /docs/en/0.6.2/api/subscribe.md: -------------------------------------------------------------------------------- 1 | subscribe() 2 | =========== 3 | 4 | --- 5 | 6 | Opens an event-stream at the target URL and provides an object for listening to specific events. Uses the Server Sent Events protocol. 7 | 8 | ```javascript 9 | var news = local.subscribe('http://myhost.com/news'); 10 | news.on('update', console.log.bind(console)); 11 | // { event: 'update', data: 'something has happened!' } 12 | ``` 13 | 14 | ### local.subscribe(request) 15 | 16 | - `request`: required string|object. If just a URL, will default the method to SUBSCRIBE and the 'accept' header to 'text/event-stream'. 17 | - returns `local.EventStream` 18 | 19 | Dispatches the request, then returns a `local.EventStream` which wraps around the response stream with an event-subscription interface. 20 | 21 | » EventStream 22 | 23 | --- 24 | 25 | ### Hosting Event Streams 26 | 27 | Use `local.EventHost` to track event streams and emit messages to them in bulk. 28 | 29 | ```javascript 30 | var newsEventHost = new local.EventHost(); 31 | function myhost(req, res) { 32 | if (req.path == '/news' && local.preferredType(req, 'text/event-stream')) { 33 | newsEventHost.addStream(res); 34 | res.writeHead(200, 'ok', { 'content-type': 'text/event-stream' }); 35 | // NOTE: do not call end (yet) 36 | } 37 | // ... 38 | newsEventHost.emit('update', 'something has happened!'); 39 | } 40 | ``` 41 | 42 | » EventHost -------------------------------------------------------------------------------- /docs/en/0.6.2/api/uri_helpers.md: -------------------------------------------------------------------------------- 1 | URI Helpers 2 | =========== 3 | 4 | ### local.parseUri(uri) 5 | 6 | - `uri`: required string|local.Request 7 | - returns object 8 | 9 | Written by Stephen Levithan. It breaks the input URL into its component parts: 10 | 11 | ```javascript 12 | local.parseUri('http://usr:pwd@www.test.com:81/dir/dir.2/index.htm?q1=0&&test1&test2=value#top') 13 | { 14 | anchor: "top" 15 | authority: "usr:pwd@www.test.com:81" 16 | directory: "/dir/dir.2/" 17 | file: "index.htm" 18 | host: "www.test.com" 19 | password: "pwd" 20 | path: "/dir/dir.2/index.htm" 21 | port: "81" 22 | protocol: "http" 23 | query: "q1=0&&test1&test2=value" 24 | queryKey: { 25 | q1: "0" 26 | test1: "" 27 | test2: "value" 28 | } 29 | relative: "/dir/dir.2/index.htm?q1=0&&test1&test2=value#top" 30 | source: "http://usr:pwd@www.test.com:81/dir/dir.2/index.htm?q1=0&&test1&test2=value#top" 31 | user: "usr" 32 | userInfo: "usr:pwd" 33 | } 34 | ``` 35 | 36 | Read the full reference at Steven Levithan's site. 37 | 38 | --- 39 | 40 | ### local.parseNavUri(uri) 41 | 42 | - `uri`: required string, a 'nav:' URI 43 | - returns Array(object) 44 | 45 | Converts a 'nav:' URI into an array of http/s/l URIs and link query objects. 46 | 47 | --- 48 | 49 | ### local.parsePeerDomain(domain) 50 | 51 | - `domain`: required string, the peer domain 52 | - returns object 53 | 54 | Breaks a peer domain (assigned by a Grimwire relay) into its constituent parts. Returns null if not a valid peer uri. 55 | 56 | ```javascript 57 | local.parsePeerDomain('bob@grimwire.net!chat.grimwire.com!123') 58 | { 59 | domain: 'bob@grimwire.net!chat.grimwire.com:123', 60 | user: 'bob', 61 | relay: 'grimwire.net', 62 | app: 'chat.grimwire.com', 63 | sid: '123' 64 | } 65 | ``` 66 | 67 | --- 68 | 69 | ### local.makePeerDomain(user, relay, app, sid) 70 | 71 | - `user`: required string 72 | - `relay`: required string 73 | - `app`: required string 74 | - `sid`: required number 75 | - returns string 76 | 77 | Constructs a peer domain from its constituent parts. 78 | 79 | ```javascript 80 | local.makePeerDomain('bob', 'grimwire.net', 'chat.grimwire.com', 123) 81 | // => bob@grimwire.net!chat.grimwire.com!123 82 | ``` 83 | 84 | --- 85 | 86 | ### local.makeProxyUri(uri, templates) 87 | 88 | - `uri`: required string 89 | - `templates`: required [string] 90 | - returns string 91 | 92 | Builds a proxy URI out of an array of templates. 93 | 94 | ```javascript 95 | local.makePemakeProxyUrierDomain('httpl://my_worker.js/', ['httpl://0.page/{uri}', 'httpl://foo/{?uri}']) 96 | // => httpl://0.page/httpl://foo/?uri=httpl://my_worker.js/ 97 | // ^ actual output will be percent-encoded 98 | ``` 99 | 100 | --- 101 | 102 | ### local.joinUri(uris...) 103 | 104 | - `uris`: a list of URI fragments 105 | 106 | Correctly joins together all url segments given in the arguments. 107 | 108 | ```javascript 109 | local.joinUrl('/foo/', '/bar', '/baz/') 110 | // => /foo/bar/baz/ 111 | ``` 112 | 113 | --- 114 | 115 | ### local.isAbsUri(uri) 116 | 117 | - `uri`: required string 118 | - returns bool 119 | 120 | Is the URL is absolute (in the HTTP/S/L schemes)? 121 | 122 | --- 123 | 124 | ### local.isNavSchemeUri(uri) 125 | 126 | - `uri`: required string 127 | - returns bool 128 | 129 | Is the URL is using the nav scheme? 130 | 131 | --- 132 | 133 | ### local.joinRelPath(url, relpath) 134 | 135 | - `url`: required string 136 | - `relpath`: required string 137 | - returns string 138 | 139 | Takes a base (absolute) URL and a relative path and forms a new valid URL. 140 | 141 | ```javascript 142 | local.joinRelPath('http://grimwire.com/foo/bar', '../fuz/bar') 143 | // => http://grimwire.com/foo/fuz/bar 144 | ``` -------------------------------------------------------------------------------- /docs/en/0.6.2/api/worker.md: -------------------------------------------------------------------------------- 1 | local.worker 2 | ============ 3 | 4 | --- 5 | 6 | Worker environments are provided with an extra `local.worker` object for handling Worker-specific tasks. It provides an EventEmitter interface, page management, logging, and configuration. 7 | 8 | ```javascript 9 | local.worker.setServer(function(req, res, page) { 10 | // ... 11 | }); 12 | local.worker.on('connect', function(page) { 13 | console.log('page '+id+' has connected'); 14 | }); 15 | ``` 16 | 17 | If the worker is shared, the originating page is considered the "Host" and given elevated privileges. 18 | 19 | `local.PageServer` instances are automatically created and assigned a URL when a page connects. The URL follows the scheme of `'+res.status+' '+res.reason+'
'; 46 | }); 47 | } 48 | window.onhashchange = getContent; 49 | getContent(); 50 | ``` 51 | 52 | ## assets/mdworker.js 53 | 54 | ```javascript 55 | importScripts('../local.js'); 56 | importScripts('./marked.js'); 57 | marked.setOptions({ gfm: true, tables: true }); 58 | 59 | function main(req, res) { 60 | req.on('end', function() { 61 | res.writeHead(200, 'OK', {'Content-Type': 'text/html'}); 62 | res.end(marked(''+req.body)); 63 | }); 64 | } 65 | ``` -------------------------------------------------------------------------------- /docs/en/0.6.2/hosts.md: -------------------------------------------------------------------------------- 1 | httpl://hosts 2 | ============= 3 | 4 | --- 5 | 6 | Local.js includes a 'hosts' server which responses to HEAD and GET requests with links to the active local hosts. 7 | 8 | ```javascript 9 | local.addServer('foobar', function(req, res) { 10 | res.writeHead(204, 'ok', { 11 | link: [{ href: '/', rel: 'self service', id: 'helloworld' }], 12 | 'content-type': 'text/plain' 13 | }); 14 | res.end('Hello, World!'); 15 | }); 16 | local.agent('httpl://hosts') 17 | .follow({ rel: 'service', id: 'helloworld' }) 18 | .get(); 19 | ``` 20 | 21 | On every request, hosts will dispatch a HEAD to every local server and extract the links with a 'self' reltype. If a server doesn't provide any 'self' link, hosts will add a simple default. -------------------------------------------------------------------------------- /docs/en/0.6.2/httpl.md: -------------------------------------------------------------------------------- 1 | HTTPL: JSON encoded message streams with HTTP semantics 2 | ======================================================= 3 | 4 | --- 5 | 6 | HTTPL is used in Local.js to communicate over Browser messaging channels (postMessage, WebRTC DataChannels). The channels offer guarantees on order and delivery which are similar to that of TCP, while HTTPL provides stream multiplexing. For unordered channels, HTTPL supports head-of-line blocking. 7 | 8 | Unlike HTTP, HTTPL is full-duplex, meaning the request and response can stream simultaneously. 9 | 10 | JSON encoding was chosen over HTTP's format to take advantage of the browser's native JSON library. It's a larger message format (it includes more syntax and labeling) but it parses much faster than a JS routine for HTTP does. 11 | 12 | --- 13 | 14 | ### Message Types 15 | 16 | The format consists of 4 kinds of request messages: the header, the body chunk, the end, and the close. They are: 17 | 18 | ```javascript 19 | // header 20 | { 21 | sid: 1, // stream id 22 | mid: (isReorderingMessages) ? 1 : undefined, // message id 23 | method: 'POST', // request method 24 | path: '/foo?k=v', // target resource 25 | headers: { 26 | accept: 'text/html', 27 | 'content-type': 'application/json', 28 | host: 'myworker.js' 29 | } 30 | } 31 | ``` 32 | 33 | ```javascript 34 | // chunk 35 | { sid: 1, mid: (isReorderingMessages) ? ++midCounter : undefined, body: '{"foo":"bar"}' } 36 | ``` 37 | 38 | ```javascript 39 | // end 40 | { sid: 1, mid: (isReorderingMessages) ? ++midCounter : undefined, end: true } 41 | ``` 42 | 43 | ```javascript 44 | // close 45 | { sid: 1, mid: (isReorderingMessages) ? ++midCounter : undefined, close : true } 46 | ``` 47 | 48 | These messages can be combined together if the client chooses to buffer them, though at the time of this writing local.js hasn't implemented that process yet. 49 | 50 | ```javascript 51 | { 52 | sid: 1, 53 | method: 'POST', 54 | path: '/foo', 55 | headers: { 56 | accept: 'text/html', 57 | 'content-type': 'application/json', 58 | host: 'myworker.js' 59 | } 60 | body: '{"foo":"bar"}', 61 | end: true, 62 | close: true 63 | } 64 | ``` 65 | 66 | The `body` attribute on chunk messages are always strings in the native encoding of the given content-type. Multiple chunk messages can be issued to spread the content across the messages sequentially. 67 | 68 | The difference between end and close messages are subtle, but important. An end message signals the end of the request, but not the transaction. The requester is still listening for response data. The close message then signals that the client has ceased listening to the response. Typically, the server sends the close message, with an exception being server-sent event-streams, which clients often close. 69 | 70 | The response has the same four types of messages, but with slightly different semantics. Here are all four combined: 71 | 72 | ```javascript 73 | { 74 | sid: 1, // stream id 75 | mid: (isReorderingMessages) ? midCounter++ : undefined, // message id 76 | status: 200, // status code 77 | reason: 'Ok', // short explanation of the response 78 | headers: { 'content-type': 'text/html' }, 79 | body: 'success
', 80 | end: true, 81 | close: true 82 | } 83 | ``` -------------------------------------------------------------------------------- /docs/en/0.6.2/linkheader.md: -------------------------------------------------------------------------------- 1 | Hypermedia Indexing Protocol 2 | ============================ 3 | 4 | --- 5 | 6 | Local.js uses the [Web Linking](http://tools.ietf.org/html/rfc5988) standard to export metadata about services in the form of links. 7 | 8 | ```javascript 9 | local.dispatch({ method: 'HEAD', url: 'http://foobar.com' }) 10 | ``` 11 | ```text 12 | > HEAD http://foobar.com HTTP/1.1 13 | < HTTP/1.1 204 no content 14 | < Link:Local Client Test Suite
16 |brought to you by doctest.js
17 | 18 |
19 | anchor tag 1
20 | anchor tag 2
21 | anchor tag 3
22 |
53 |
56 |
57 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/test/doctest/.gitignore:
--------------------------------------------------------------------------------
1 | .resources/_build
2 |
--------------------------------------------------------------------------------
/test/doctest/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule ".resources/esprima"]
2 | path = .resources/esprima
3 | url = https://github.com/ariya/esprima.git
4 |
--------------------------------------------------------------------------------
/test/doctest/.hgignore:
--------------------------------------------------------------------------------
1 | syntax:glob
2 | .svn
3 | .hgsvn
4 |
--------------------------------------------------------------------------------
/test/doctest/.resources/CNAME:
--------------------------------------------------------------------------------
1 | doctestjs.org
2 |
--------------------------------------------------------------------------------
/test/doctest/.resources/boilerplate/css/normalize.min.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v1.0.1 | MIT License | git.io/normalize */
2 | article,aside,details,figcaption,figure,footer,header,hgroup,nav,section,summary{display:block}
3 | audio,canvas,video{display:inline-block;*display:inline;*zoom:1}
4 | audio:not([controls]){display:none;height:0}
5 | [hidden]{display:none}
6 | html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}
7 | html,button,input,select,textarea{font-family:sans-serif}
8 | body{margin:0}
9 | a:focus{outline:thin dotted}
10 | a:active,a:hover{outline:0}
11 | h1{font-size:2em;margin:.67em 0}
12 | h2{font-size:1.5em;margin:.83em 0}
13 | h3{font-size:1.17em;margin:1em 0}
14 | h4{font-size:1em;margin:1.33em 0}
15 | h5{font-size:.83em;margin:1.67em 0}
16 | h6{font-size:.75em;margin:2.33em 0}
17 | abbr[title]{border-bottom:1px dotted}
18 | b,strong{font-weight:bold}
19 | blockquote{margin:1em 40px}
20 | dfn{font-style:italic}
21 | mark{background:#ff0;color:#000}
22 | p,pre{margin:1em 0}
23 | code,kbd,pre,samp{font-family:monospace,serif;_font-family:'courier new',monospace;font-size:1em}
24 | pre{white-space:pre;white-space:pre-wrap;word-wrap:break-word}
25 | q{quotes:none}
26 | q:before,q:after{content:'';content:none}
27 | small{font-size:80%}
28 | sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
29 | sup{top:-0.5em}
30 | sub{bottom:-0.25em}
31 | dl,menu,ol,ul{margin:1em 0}
32 | dd{margin:0 0 0 40px}
33 | menu,ol,ul{padding:0 0 0 40px}
34 | nav ul,nav ol{list-style:none;list-style-image:none}
35 | img{border:0;-ms-interpolation-mode:bicubic}
36 | svg:not(:root){overflow:hidden}
37 | figure{margin:0}
38 | form{margin:0}
39 | fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:.35em .625em .75em}
40 | legend{border:0;padding:0;white-space:normal;*margin-left:-7px}
41 | button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}
42 | button,input{line-height:normal}
43 | button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;*overflow:visible}
44 | button[disabled],input[disabled]{cursor:default}
45 | input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*height:13px;*width:13px}
46 | input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
47 | input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
48 | button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
49 | textarea{overflow:auto;vertical-align:top}
50 | table{border-collapse:collapse;border-spacing:0}
--------------------------------------------------------------------------------
/test/doctest/.resources/boilerplate/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/pfrazee/local/becf1f1eafee6eed0f38034f37cc28b13cfd5724/test/doctest/.resources/boilerplate/favicon.ico
--------------------------------------------------------------------------------
/test/doctest/.resources/boilerplate/js/main.js:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/test/doctest/.resources/build:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | set -ex
4 |
5 | mv .resources/CNAME CNAME
6 | mv .resources resources
7 |
8 | echo "Updating files with template..."
9 |
10 | files="index.html tutorial.html reference.html try.html"
11 |
12 | python resources/retemplate.py $files
13 | for file in $files ; do
14 | sed -i '' 's/\.resources/resources/g' $file
15 | done
16 |
--------------------------------------------------------------------------------
/test/doctest/.resources/doc.css:
--------------------------------------------------------------------------------
1 | i, em {
2 | font-family: serif;
3 | }
4 |
5 | #contents ul {
6 | margin-bottom: 0;
7 | margin-top: 0;
8 | }
9 |
10 | #contents > ul {
11 | padding-left: 0;
12 | }
13 |
14 | #contents li {
15 | list-style: none;
16 | }
17 |
18 | #contents {
19 | border-bottom: 1px solid #999;
20 | padding-left: 1em;
21 | }
22 |
23 | .header-container header {
24 | width: 98%;
25 | }
26 |
27 | code {
28 | color: #288;
29 | }
30 |
31 | aside code {
32 | color: #9ff;
33 | }
34 |
35 | section:target h1, section:target h2, section:target h3, section:target h4,
36 | section:target h5, section:target h6, h3:target, h4:target {
37 | border-bottom: 3px solid #f90;
38 | }
39 |
40 | footer a:link, footer a:visited,
41 | aside a:link, aside a:visited {
42 | text-decoration: none;
43 | color: #fd1;
44 | }
45 |
46 | section header h1, section header h2, section header h3, section header h4,
47 | section header h5, section header h6 {
48 | margin-left: -1em;
49 | margin-top: 1.75em;
50 | border-bottom: 1px solid #000;
51 | }
52 |
53 | pre {
54 | font-size: 90%;
55 | line-height: 1.3;
56 | border: 1px solid #999;
57 | border-radius: 4px;
58 | }
59 |
60 | @media only screen and (min-width: 768px) {
61 |
62 | .main aside {
63 | position: absolute;
64 | right: 1em;
65 | }
66 |
67 | }
68 |
69 | .header-container header {
70 | margin-left: 1em;
71 | }
72 |
73 | h1.title a:link, h1.title a:visited {
74 | text-decoration: none;
75 | color: #fff;
76 | }
77 |
78 | h1.title a:hover {
79 | text-decoration: underline;
80 | }
81 |
--------------------------------------------------------------------------------
/test/doctest/.resources/example.xml:
--------------------------------------------------------------------------------
1 |
2 |
58 |
67 |
68 |
69 | original
59 | original
60 | original
61 | original
62 | original
63 | original
64 | original
65 | original
66 | Download
4 |5 | You can download this project in either 6 | zip or 7 | tar formats. 8 |
9 | 10 |You can also clone the project with Git 11 | by running: 12 |
$ git clone git://github.com/ianb/doctestjs13 | 14 | 15 | 19 | 20 | 21 | 22 | 26 | 31 | -------------------------------------------------------------------------------- /test/doctest/.resources/header.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 |
22 |
23 |
24 |
25 |
38 |
39 |
40 | Doctest.js:
26 | 27 | 36 | 37 |
41 |
53 |
54 |
60 |
61 |
62 |
65 |
66 |
67 |
68 |
81 |
82 |
83 |
84 |
--------------------------------------------------------------------------------
/test/doctest/.resources/include-scripts.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | set -e
4 |
5 | base="$(python -c 'import sys, os; print os.path.dirname(os.path.dirname(os.path.abspath(sys.argv[1])))' "$BASH_SOURCE")"
6 |
7 | if [ ! -f $base/doctest.js ] ; then
8 | echo "Could not find $base/doctest.js"
9 | exit 1
10 | fi
11 |
12 | if [ ! -d $base/.resources/jshint ] ; then
13 | echo "Could not find $base/.resources/jshint"
14 | echo "Try:"
15 | echo " git clone https://github.com/jshint/jshint.git .resources/jshint"
16 | exit 2
17 | fi
18 |
19 | if [ ! -d $base/esprima ] ; then
20 | echo "Could not find $base/.resources/esprima"
21 | echo "Try:"
22 | echo " git clone https://github.com/ariya/esprima.git .resources/esprima"
23 | exit 3
24 | fi
25 |
26 | echo "Substituting $base/doctest.js"
27 |
28 | uglify_options="--no-copyright --max-line-len 200"
29 |
30 | python -c '
31 | import os, sys, re
32 | os.chdir(sys.argv[1])
33 | with open("doctest.js", "rb") as fp:
34 | content = fp.read()
35 | names = {}
36 | for arg in sys.argv[2:]:
37 | name, rest = arg.split("=", 1)
38 | names[name] = rest
39 | regex = re.compile(r"\/\*\s+INSERT\s+(.*?)\s+\*\/\s*\n(.*?)\/*\s+END\s+INSERT\s+\*\/", re.S)
40 | def repl(match):
41 | print "Replacing %s" % match.group(1)
42 | return "/* INSERT %s */\n%s\n/* END INSERT */" % (
43 | match.group(1), names[match.group(1)])
44 | new_content = regex.sub(repl, content)
45 | with open("doctest.js", "wb") as fp:
46 | fp.write(new_content)
47 | print "wrote doctest.js"
48 | ' "$base" esprima.js="$(uglifyjs $uglify_options < esprima/esprima.js)" jshint.js="$(uglifyjs $uglify_options < jshint/jshint.js)"
49 |
--------------------------------------------------------------------------------
/test/doctest/.resources/retemplate.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | import re
3 |
4 | section_re = re.compile(r'''
5 | (?P
21 |
22 |
33 |
34 |
35 | Doctest.js:
23 | 24 | 31 | 32 |
36 |
48 |
49 |
55 |
56 |
57 |
60 |
61 |
62 |
63 |
76 |
77 |
78 |
79 |
--------------------------------------------------------------------------------
/test/doctest/.resources/toc.js:
--------------------------------------------------------------------------------
1 | function contentsOnLoad() {
2 | if (contentsOnLoad.hasRun) {
3 | return;
4 | }
5 | contentsOnLoad.hasRun = true;
6 | var dest = document.getElementById('contents');
7 | var toc = [document.createElement('ul')];
8 | var generatedIds = [];
9 | dest.appendChild(toc[0]);
10 | var els = document.querySelectorAll('h3, h4, h5, h6');
11 | for (var i=0; i
37 |
38 |
39 |
40 |
41 | __BODY__
42 |
43 |
44 |
45 |
46 |
47 |
17 |
18 |
26 |
27 |
56 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/functiontrace.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Regular Expression Collector uncovers all your secrets
28 | 29 |Note: Only regular expression literals and objects created with RegExp are considered.
Type ECMAScript code:
31 | 43 |The above code editor is based on CodeMirror.
44 | 45 |Using Esprima version .
46 | 47 |
48 |
49 |
50 |
53 |
54 |
55 |
23 |
24 |
32 |
33 |
68 |
69 |
76 |
110 |
111 |
112 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/highlight.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Function Trace reveals what is being called
34 | 35 |Type ECMAScript code:
36 | 59 |The above code editor is based on CodeMirror.
60 | 61 |62 | 63 |
64 | 65 |Instrumentation for each function will be added with the Insert tracing button. Pressing the Run button will execute the code (using JavaScript eval) with the instrumentation, and then call counts for each function will be displayed (sorted by the number of calls). Warning: do not run untrusted code!
No result yet.
Using Esprima version .
70 | 73 | 74 | 75 |
31 |
32 |
40 |
41 |
72 |
93 |
94 |
95 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/minify.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Identifier Highlight to spot everything
42 | 43 |Type ECMAScript code and place the cursor in an identifier.
44 | Note: Scope is not handled properly yet, see issue 98.
The above code editor is based on CodeMirror.
61 | 62 | 63 | 64 |Using Esprima version .
65 | 66 | 69 | 70 | 71 |
23 |
24 |
32 |
33 |
71 |
72 |
73 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/parse.css:
--------------------------------------------------------------------------------
1 | .tabs textarea {
2 | padding: 7px 0px 7px 7px;
3 | }
4 |
5 | #url {
6 | font-family: Inconsolata, Monaco, Consolas, "Lucida Console", monospace;
7 | font-size: 13px;
8 | color: #555;
9 | width: 80%;
10 | border-width: 1px;
11 | border-style: solid;
12 | border-color: #aaa;
13 | overflow: auto;
14 | display: block;
15 | }
16 |
17 | .tabs {
18 | position: relative;
19 | display: block;
20 | margin-top: 30px;
21 | height: 1px;
22 | }
23 |
24 | .tabs ul, .tabs li {
25 | list-style-type: none;
26 | margin: 0;
27 | line-height: 0px;
28 | }
29 |
30 | .tabs h3 {
31 | float: left;
32 | position: relative;
33 | margin: 0 6px 0 0;
34 | border: 1px solid #bbb;
35 | background-color: #eee;
36 | border-bottom: none;
37 | cursor: pointer;
38 | z-index: 0;
39 | -moz-border-radius-topleft: 6px;
40 | -webkit-border-top-left-radius: 6px;
41 | -ms-border-top-left-radius: 6px;
42 | -o-border-top-left-radius: 6px;
43 | border-top-left-radius: 6px;
44 | -moz-border-radius-topright: 6px;
45 | -webkit-border-top-right-radius: 6px;
46 | -ms-border-top-right-radius: 6px;
47 | -o-border-top-right-radius: 6px;
48 | border-top-right-radius: 6px
49 | }
50 |
51 | .tabs .active h3 {
52 | background-color: #fff;
53 | border-bottom-color: #fff;
54 | z-index: 2
55 | }
56 |
57 | .tabs h3 a {
58 | padding: 0 10px;
59 | line-height: 29px;
60 | font-size: 13px;
61 | font-weight: normal;
62 | }
63 |
64 | .tabs a {
65 | color: black;
66 | text-decoration: none;
67 | }
68 |
69 | .tabs a:visited {
70 | color: black;
71 | }
72 |
73 | .tabs .tab {
74 | position: absolute;
75 | display: none;
76 | left: 0;
77 | top: 29px;
78 | right: 0;
79 | border-top: 1px solid #bbb;
80 | z-index: 1;
81 | padding: 25px 60px 50px 5px;
82 | }
83 |
84 | .pages div {
85 | display: none;
86 | }
87 |
88 | .pages div.active {
89 | display: block;
90 | }
91 |
92 | .tabs .active .tab {
93 | display: block;
94 | }
95 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/rewrite.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Minify compacts everything
34 | 35 |Type ECMAScript code in the editor. Press Minify button to shorten the code 36 | using Escodegen project.
37 | 38 | 56 | 57 | 58 | 59 |The above code editor is based on CodeMirror.
60 | 61 | 62 | 63 | 64 | 65 | 68 | 69 | 70 |
23 |
24 |
32 |
33 |
91 |
92 |
93 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/validate.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Source Rewrite cleans up and reformats everything
34 | 35 |Type ECMAScript code in the editor. Press Rewrite button to get the code 36 | rewritten using Escodegen project.
37 | 38 | 58 | 59 |Indent with: 60 | 61 | 62 | 63 |
64 |String literal quotes: 65 | 66 | 67 | 68 |
69 | 70 | 71 | 72 | 73 |The above code editor is based on CodeMirror.
74 | 75 | 76 | 77 |Notes:
78 |-
79 |
- Only valid syntax is accepted. 80 |
- Comments are not yet preserved (see issue #197). 81 |
30 |
31 |
39 |
40 |
65 |
66 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
--------------------------------------------------------------------------------
/test/doctest/esprima/demo/validate.js:
--------------------------------------------------------------------------------
1 | /*jslint sloppy:true browser:true */
2 | /*global esprima:true, CodeMirror:true */
3 | var validateId;
4 |
5 | function validate(delay) {
6 | if (validateId) {
7 | window.clearTimeout(validateId);
8 | }
9 |
10 | validateId = window.setTimeout(function () {
11 | var code, result, i, str;
12 |
13 | if (typeof window.editor === 'undefined') {
14 | code = document.getElementById('code').value;
15 | } else {
16 | code = window.editor.getValue();
17 | }
18 |
19 | try {
20 | result = esprima.parse(code, { tolerant: true, loc: true }).errors;
21 | if (result.length > 0) {
22 | str = 'Syntax Validator checks for mistakes and errors
41 | 42 |Esprima version .
43 | 44 |Type ECMAScript code:
45 | 62 |The above code editor is based on CodeMirror.
63 | 64 |No result yet.
Found ' + result.length + ':
'; 23 | for (i = 0; i < result.length; i += 1) { 24 | str += '' + result[i].message + '
'; 25 | } 26 | } else { 27 | str = 'No syntax error.
'; 28 | } 29 | } catch (e) { 30 | str = e.name + ': ' + e.message; 31 | } 32 | document.getElementById('result').innerHTML = str; 33 | 34 | validateId = undefined; 35 | }, delay || 811); 36 | } 37 | 38 | window.onload = function () { 39 | var id, el; 40 | 41 | id = function (i) { 42 | return document.getElementById(i); 43 | }; 44 | 45 | el = id('version'); 46 | if (typeof el.innerText === 'string') { 47 | el.innerText = esprima.version; 48 | } else { 49 | el.textContent = esprima.version; 50 | } 51 | try { 52 | validate(1); 53 | } catch (e) { } 54 | }; 55 | 56 | try { 57 | window.checkEnv(); 58 | 59 | // This is just testing, to detect whether CodeMirror would fail or not 60 | window.editor = CodeMirror.fromTextArea(document.getElementById("test")); 61 | 62 | window.editor = CodeMirror.fromTextArea(document.getElementById("code"), { 63 | lineNumbers: true, 64 | matchBrackets: true, 65 | onChange: validate 66 | }); 67 | } catch (e) { 68 | // CodeMirror failed to initialize, possible in e.g. old IE. 69 | document.getElementById('codemirror').innerHTML = ''; 70 | document.getElementById('code').onchange = validate; 71 | document.getElementById('code').onkeydown = validate; 72 | } finally { 73 | document.getElementById('testbox').parentNode.removeChild(document.getElementById('testbox')); 74 | } 75 | -------------------------------------------------------------------------------- /test/doctest/esprima/examples/detectnestedternary.js: -------------------------------------------------------------------------------- 1 | // Usage: node detectnestedternary.js /path/to/some/directory 2 | // For more details, please read http://esprima.org/doc/#nestedternary 3 | 4 | /*jslint node:true sloppy:true plusplus:true */ 5 | 6 | var fs = require('fs'), 7 | esprima = require('../esprima'), 8 | dirname = process.argv[2]; 9 | 10 | 11 | // Executes visitor on the object and its children (recursively). 12 | function traverse(object, visitor) { 13 | var key, child; 14 | 15 | visitor.call(null, object); 16 | for (key in object) { 17 | if (object.hasOwnProperty(key)) { 18 | child = object[key]; 19 | if (typeof child === 'object' && child !== null) { 20 | traverse(child, visitor); 21 | } 22 | } 23 | } 24 | } 25 | 26 | // http://stackoverflow.com/q/5827612/ 27 | function walk(dir, done) { 28 | var results = []; 29 | fs.readdir(dir, function (err, list) { 30 | if (err) { 31 | return done(err); 32 | } 33 | var i = 0; 34 | (function next() { 35 | var file = list[i++]; 36 | if (!file) { 37 | return done(null, results); 38 | } 39 | file = dir + '/' + file; 40 | fs.stat(file, function (err, stat) { 41 | if (stat && stat.isDirectory()) { 42 | walk(file, function (err, res) { 43 | results = results.concat(res); 44 | next(); 45 | }); 46 | } else { 47 | results.push(file); 48 | next(); 49 | } 50 | }); 51 | }()); 52 | }); 53 | } 54 | 55 | walk(dirname, function (err, results) { 56 | if (err) { 57 | console.log('Error', err); 58 | return; 59 | } 60 | 61 | results.forEach(function (filename) { 62 | var shortname, first, content, syntax; 63 | 64 | shortname = filename; 65 | first = true; 66 | 67 | if (shortname.substr(0, dirname.length) === dirname) { 68 | shortname = shortname.substr(dirname.length + 1, shortname.length); 69 | } 70 | 71 | function report(node, problem) { 72 | if (first === true) { 73 | console.log(shortname + ': '); 74 | first = false; 75 | } 76 | console.log(' Line', node.loc.start.line, ':', problem); 77 | } 78 | 79 | function checkConditional(node) { 80 | var condition; 81 | 82 | if (node.consequent.type === 'ConditionalExpression' || 83 | node.alternate.type === 'ConditionalExpression') { 84 | 85 | condition = content.substring(node.test.range[0], node.test.range[1]); 86 | if (condition.length > 20) { 87 | condition = condition.substring(0, 20) + '...'; 88 | } 89 | condition = '"' + condition + '"'; 90 | report(node, 'Nested ternary for ' + condition); 91 | } 92 | } 93 | 94 | try { 95 | content = fs.readFileSync(filename, 'utf-8'); 96 | syntax = esprima.parse(content, { tolerant: true, loc: true, range: true }); 97 | traverse(syntax, function (node) { 98 | if (node.type === 'ConditionalExpression') { 99 | checkConditional(node); 100 | } 101 | }); 102 | } catch (e) { 103 | } 104 | 105 | }); 106 | }); 107 | -------------------------------------------------------------------------------- /test/doctest/esprima/examples/tokendist.js: -------------------------------------------------------------------------------- 1 | /*jslint node:true */ 2 | var fs = require('fs'), 3 | esprima = require('../esprima'), 4 | files = process.argv.splice(2), 5 | histogram, 6 | type; 7 | 8 | histogram = { 9 | Boolean: 0, 10 | Identifier: 0, 11 | Keyword: 0, 12 | Null: 0, 13 | Numeric: 0, 14 | Punctuator: 0, 15 | RegularExpression: 0, 16 | String: 0 17 | }; 18 | 19 | files.forEach(function (filename) { 20 | 'use strict'; 21 | var content = fs.readFileSync(filename, 'utf-8'), 22 | tokens = esprima.parse(content, { tokens: true }).tokens; 23 | 24 | tokens.forEach(function (token) { 25 | histogram[token.type] += 1; 26 | }); 27 | }); 28 | 29 | for (type in histogram) { 30 | if (histogram.hasOwnProperty(type)) { 31 | console.log(type, histogram[type]); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /test/doctest/esprima/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "esprima", 3 | "description": "ECMAScript parsing infrastructure for multipurpose analysis", 4 | "homepage": "http://esprima.org", 5 | "main": "esprima.js", 6 | "bin": { 7 | "esparse": "./bin/esparse.js" 8 | }, 9 | "version": "1.1.0-dev", 10 | "engines": { 11 | "node": ">=0.4.0" 12 | }, 13 | "maintainers": [{ 14 | "name": "Ariya Hidayat", 15 | "email": "ariya.hidayat@gmail.com", 16 | "web": "http://ariya.ofilabs.com" 17 | }], 18 | "repository": { 19 | "type": "git", 20 | "url": "http://github.com/ariya/esprima.git" 21 | }, 22 | "licenses": [{ 23 | "type": "BSD", 24 | "url": "http://github.com/ariya/esprima/raw/master/LICENSE.BSD" 25 | }], 26 | "scripts": { 27 | "test": "node test/run.js", 28 | "benchmark": "node test/benchmarks.js", 29 | "benchmark-quick": "node test/benchmarks.js quick" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /test/doctest/esprima/test/benchmarks.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
23 |
24 |
32 |
33 |
56 |
57 |
58 |
59 |
--------------------------------------------------------------------------------
/test/doctest/esprima/test/compare.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Benchmarks show the speed
34 | 35 |Time measurement is carried out using Benchmark.js.
36 | 37 |Esprima version .
38 | 39 |Please wait...
40 | 41 |42 | 43 | 44 |
45 | 46 | 47 | 48 |Note: On a modern machine and up-to-date web browsers,
49 | running full benchmarks suite takes around 1 minute.
50 | For the quick benchmarks, the running time is only about 15 seconds.
23 |
24 |
32 |
33 |
57 |
58 |
59 |
60 |
61 |
65 |
66 |
67 |
68 |
69 |
70 |
--------------------------------------------------------------------------------
/test/doctest/esprima/test/compat.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Compare with other parsers
34 | 35 |Time measurement is carried out using Benchmark.js.
36 | 37 |Esprima version .
38 | 39 |Please wait... 40 |
41 | 42 | 43 | 44 | 45 |Warning: Since each parser may have a different format for the syntax tree, the speed is not fully comparable (the cost of constructing different result is not taken into account). These tests exist only to ensure that Esprima parser is not ridiculously slow compare to other parsers.
46 | 47 |parse-js is the parser used in UglifyJS v1. It's a JavaScript port of the Common LISP version. This test uses parse-js from UglifyJS version 1.3.2 (June 26 2012).
Acorn is a compact stand-alone JavaScript parser. This test uses Acorn revision 0590d122 (dated Oct 3 2012).
50 | 51 |More comparison variants will be added in the near future.
52 | 53 | 56 |
14 |
15 |
23 |
24 |
35 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/test/doctest/esprima/test/coverage.footer.html:
--------------------------------------------------------------------------------
1 |
2 | Compatibility keeps everyone happy
25 |Esprima version .
26 |The following tests are to ensure that the syntax tree is compatible to 27 | that produced by Mozilla SpiderMonkey 28 | Parser reflection.
29 |Please wait...
30 | 31 | 34 |