├── LICENSE ├── README.md ├── bin └── hogan ├── index.js ├── lib └── express.js └── package.json /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | hjs 2 | ===== 3 | [Hogan.js](http://twitter.github.com/hogan.js/) NPM package for [express](http://expressjs.com/) 3.x 4 | 5 | ## Installation 6 | 7 | $ npm install -g express@3.0 hjs 8 | 9 | ## Quick Start 10 | 11 | Install Express : 12 | 13 | $ npm install -g express@3.0 14 | 15 | Create express app : 16 | 17 | $ express -H /tmp/testapp 18 | $ cd /tmp/testapp/ 19 | & npm install 20 | 21 | ## Manual Start 22 | 23 | Install Express : 24 | 25 | $ npm install -g express@3.0 26 | 27 | Create express app : 28 | 29 | $ express /tmp/testapp 30 | $ cd /tmp/testapp/ 31 | 32 | Edit package.json : 33 | 34 | $ vi package.json 35 | 36 | ```json 37 | "dependencies": { 38 | "express": "3.0.0", 39 | "hjs": "*" 40 | } 41 | ``` 42 | 43 | $ npm install 44 | 45 | Edit app.js : 46 | 47 | ```js 48 | app.set('view engine', 'hjs'); 49 | ``` 50 | 51 | Make views/index.hjs : 52 | 53 | ```html 54 | 55 |
56 |{{ title }}
60 | 61 | 62 | ``` 63 | 64 | Start server : 65 | 66 | $ node app 67 | 68 | ## Partials 69 | index.hjs 70 | ```html 71 | 72 | 73 |{{ title }}
77 | {{> footer }} 78 | 79 | 80 | ``` 81 | footer.hjs 82 | ```html 83 |Welcome to <%= title %>
' 111 | , ' ' 112 | , '' 113 | ].join(eol); 114 | 115 | /** 116 | * JSHTML layout template. 117 | */ 118 | 119 | var jshtmlLayout = [ 120 | '' 121 | , '' 122 | , ' ' 123 | , 'Welcome to @write(title)
' 139 | ].join(eol); 140 | 141 | /** 142 | * Hogan.js index template. 143 | */ 144 | var hoganIndex = [ 145 | '' 146 | , '' 147 | , ' ' 148 | , 'Welcome to {{ title }}
' 154 | , ' ' 155 | , '' 156 | ].join(eol); 157 | 158 | /** 159 | * Default css template. 160 | */ 161 | 162 | var css = [ 163 | 'body {' 164 | , ' padding: 50px;' 165 | , ' font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;' 166 | , '}' 167 | , '' 168 | , 'a {' 169 | , ' color: #00B7FF;' 170 | , '}' 171 | ].join(eol); 172 | 173 | /** 174 | * Default less template. 175 | */ 176 | 177 | var less = [ 178 | 'body {' 179 | , ' padding: 50px;' 180 | , ' font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;' 181 | , '}' 182 | , '' 183 | , 'a {' 184 | , ' color: #00B7FF;' 185 | , '}' 186 | ].join(eol); 187 | 188 | /** 189 | * Default stylus template. 190 | */ 191 | 192 | var stylus = [ 193 | 'body' 194 | , ' padding: 50px' 195 | , ' font: 14px "Lucida Grande", Helvetica, Arial, sans-serif' 196 | , 'a' 197 | , ' color: #00B7FF' 198 | ].join(eol); 199 | 200 | /** 201 | * App template. 202 | */ 203 | 204 | var app = [ 205 | '' 206 | , '/**' 207 | , ' * Module dependencies.' 208 | , ' */' 209 | , '' 210 | , 'var express = require(\'express\');' 211 | , 'var routes = require(\'./routes\');' 212 | , 'var user = require(\'./routes/user\');' 213 | , 'var http = require(\'http\');' 214 | , 'var path = require(\'path\');' 215 | , '' 216 | , 'var app = express();' 217 | , '' 218 | , '// all environments' 219 | , 'app.set(\'port\', process.env.PORT || 3000);' 220 | , 'app.set(\'views\', __dirname + \'/views\');' 221 | , 'app.set(\'view engine\', \':TEMPLATE\');' 222 | , 'app.use(express.favicon());' 223 | , 'app.use(express.logger(\'dev\'));' 224 | , 'app.use(express.bodyParser());' 225 | , 'app.use(express.methodOverride());{sess}' 226 | , 'app.use(app.router);{css}' 227 | , 'app.use(express.static(path.join(__dirname, \'public\')));' 228 | , '' 229 | , '// development only' 230 | , 'if (\'development\' == app.get(\'env\')) {' 231 | , ' app.use(express.errorHandler());' 232 | , '}' 233 | , '' 234 | , 'app.get(\'/\', routes.index);' 235 | , 'app.get(\'/users\', user.list);' 236 | , '' 237 | , 'http.createServer(app).listen(app.get(\'port\'), function(){' 238 | , ' console.log(\'Express server listening on port \' + app.get(\'port\'));' 239 | , '});' 240 | , '' 241 | ].join(eol); 242 | 243 | // Generate application 244 | 245 | (function createApplication(path) { 246 | emptyDirectory(path, function(empty){ 247 | if (empty || program.force) { 248 | createApplicationAt(path); 249 | } else { 250 | program.confirm('destination is not empty, continue? ', function(ok){ 251 | if (ok) { 252 | process.stdin.destroy(); 253 | createApplicationAt(path); 254 | } else { 255 | abort('aborting'); 256 | } 257 | }); 258 | } 259 | }); 260 | })(path); 261 | 262 | /** 263 | * Create application at the given directory `path`. 264 | * 265 | * @param {String} path 266 | */ 267 | 268 | function createApplicationAt(path) { 269 | console.log(); 270 | process.on('exit', function(){ 271 | console.log(); 272 | console.log(' install dependencies:'); 273 | console.log(' $ cd %s && npm install', path); 274 | console.log(); 275 | console.log(' run the app:'); 276 | console.log(' $ node app'); 277 | console.log(); 278 | }); 279 | 280 | mkdir(path, function(){ 281 | mkdir(path + '/public'); 282 | mkdir(path + '/public/javascripts'); 283 | mkdir(path + '/public/images'); 284 | mkdir(path + '/public/stylesheets', function(){ 285 | switch (program.css) { 286 | case 'less': 287 | write(path + '/public/stylesheets/style.less', less); 288 | break; 289 | case 'stylus': 290 | write(path + '/public/stylesheets/style.styl', stylus); 291 | break; 292 | default: 293 | write(path + '/public/stylesheets/style.css', css); 294 | } 295 | }); 296 | 297 | mkdir(path + '/routes', function(){ 298 | write(path + '/routes/index.js', index); 299 | write(path + '/routes/user.js', users); 300 | }); 301 | 302 | mkdir(path + '/views', function(){ 303 | switch (program.template) { 304 | case 'ejs': 305 | write(path + '/views/index.ejs', ejsIndex); 306 | break; 307 | case 'jade': 308 | write(path + '/views/layout.jade', jadeLayout); 309 | write(path + '/views/index.jade', jadeIndex); 310 | break; 311 | case 'jshtml': 312 | write(path + '/views/layout.jshtml', jshtmlLayout); 313 | write(path + '/views/index.jshtml', jshtmlIndex); 314 | break; 315 | case 'hjs': 316 | write(path + '/views/index.hjs', hoganIndex); 317 | break; 318 | 319 | } 320 | }); 321 | 322 | // CSS Engine support 323 | switch (program.css) { 324 | case 'less': 325 | app = app.replace('{css}', eol + 'app.use(require(\'less-middleware\')({ src: __dirname + \'/public\' }));'); 326 | break; 327 | case 'stylus': 328 | app = app.replace('{css}', eol + 'app.use(require(\'stylus\').middleware(__dirname + \'/public\'));'); 329 | break; 330 | default: 331 | app = app.replace('{css}', ''); 332 | } 333 | 334 | // Session support 335 | app = app.replace('{sess}', program.sessions 336 | ? eol + 'app.use(express.cookieParser(\'your secret here\'));' + eol + 'app.use(express.session());' 337 | : ''); 338 | 339 | // Template support 340 | app = app.replace(':TEMPLATE', program.template); 341 | 342 | // package.json 343 | var pkg = { 344 | name: 'application-name' 345 | , version: '0.0.1' 346 | , private: true 347 | , scripts: { start: 'node app.js' } 348 | , dependencies: { 349 | express: version 350 | } 351 | } 352 | 353 | if (program.template) pkg.dependencies[program.template] = '*'; 354 | 355 | // CSS Engine support 356 | switch (program.css) { 357 | case 'less': 358 | pkg.dependencies['less-middleware'] = '*'; 359 | break; 360 | default: 361 | if (program.css) { 362 | pkg.dependencies[program.css] = '*'; 363 | } 364 | } 365 | 366 | write(path + '/package.json', JSON.stringify(pkg, null, 2)); 367 | write(path + '/app.js', app); 368 | }); 369 | } 370 | 371 | /** 372 | * Check if the given directory `path` is empty. 373 | * 374 | * @param {String} path 375 | * @param {Function} fn 376 | */ 377 | 378 | function emptyDirectory(path, fn) { 379 | fs.readdir(path, function(err, files){ 380 | if (err && 'ENOENT' != err.code) throw err; 381 | fn(!files || !files.length); 382 | }); 383 | } 384 | 385 | /** 386 | * echo str > path. 387 | * 388 | * @param {String} path 389 | * @param {String} str 390 | */ 391 | 392 | function write(path, str) { 393 | fs.writeFile(path, str); 394 | console.log(' \x1b[36mcreate\x1b[0m : ' + path); 395 | } 396 | 397 | /** 398 | * Mkdir -p. 399 | * 400 | * @param {String} path 401 | * @param {Function} fn 402 | */ 403 | 404 | function mkdir(path, fn) { 405 | mkdirp(path, 0755, function(err){ 406 | if (err) throw err; 407 | console.log(' \033[36mcreate\033[0m : ' + path); 408 | fn && fn(); 409 | }); 410 | } 411 | 412 | /** 413 | * Exit with the given `str`. 414 | * 415 | * @param {String} str 416 | */ 417 | 418 | function abort(str) { 419 | console.error(str); 420 | process.exit(1); 421 | } 422 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed under the Apache License, Version 2.0 (the "License"); 3 | * you may not use this file except in compliance with the License. 4 | * You may obtain a copy of the License at 5 | * 6 | * http://www.apache.org/licenses/LICENSE-2.0 7 | * 8 | * Unless required by applicable law or agreed to in writing, software 9 | * distributed under the License is distributed on an "AS IS" BASIS, 10 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | * See the License for the specific language governing permissions and 12 | * limitations under the License. 13 | */ 14 | 15 | // this file is for use with Express 3.x. 16 | module.exports = require('./lib/express.js')(require('hogan.js')); 17 | -------------------------------------------------------------------------------- /lib/express.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed under the Apache License, Version 2.0 (the "License"); 3 | * you may not use this file except in compliance with the License. 4 | * You may obtain a copy of the License at 5 | * 6 | * http://www.apache.org/licenses/LICENSE-2.0 7 | * 8 | * Unless required by applicable law or agreed to in writing, software 9 | * distributed under the License is distributed on an "AS IS" BASIS, 10 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | * See the License for the specific language governing permissions and 12 | * limitations under the License. 13 | */ 14 | 15 | /** 16 | * Express 3.x support. 17 | */ 18 | var fs = require('fs'); 19 | var _path = require('path'); 20 | var ctx = {}; 21 | 22 | 23 | module.exports = function (Hogan) { 24 | if (typeof Hogan === 'undefined' 25 | || typeof Hogan.scan === 'undefined' 26 | || typeof Hogan.parse === 'undefined' 27 | || typeof Hogan.generate === 'undefined') { 28 | throw new Error('please, require Hogan!'); 29 | } 30 | 31 | Hogan.fcache = {}; 32 | 33 | Hogan.fcompile = function (path, options) { 34 | options = options || {}; 35 | options.filename = path; 36 | 37 | var key = path + ':string'; 38 | 39 | if (options.cache && Hogan.fcache[key]) { 40 | return Hogan.fcache[key]; 41 | } 42 | 43 | var text = fs.readFileSync(path, 'utf8'); 44 | 45 | try { 46 | var rt = Hogan.generate(Hogan.parse(Hogan.scan(text, options.delimiters), text, options), text, options); 47 | } catch (error) { 48 | throw new Error('Error reading template file ' + path + ': ' + error.message); 49 | } 50 | 51 | return options.cache ? Hogan.fcache[key] = rt : rt; 52 | }; 53 | 54 | renderPartials = function(partials, opt) { 55 | var name, path, result; 56 | result = {}; 57 | for (name in partials) { 58 | path = partials[name]; 59 | if (typeof path !== 'string') { 60 | continue; 61 | } 62 | if (!_path.extname(path)) { 63 | path += ctx.ext; 64 | } 65 | path = ctx.lookup(path); 66 | result[name] = Hogan.fcompile(path,opt); 67 | } 68 | return result; 69 | }; 70 | 71 | 72 | Hogan.renderFile = function (path, options, fn) { 73 | ctx = this; 74 | try { 75 | var p = {}; 76 | for (var prop in options.settings.partials) { 77 | p[prop] = options.settings.partials[prop]; 78 | } 79 | for (var prop in options.partials) { 80 | p[prop] = options.partials[prop]; 81 | } 82 | var partials = renderPartials(p,options); 83 | fn(null, Hogan.fcompile(path,options).render(options,partials)); 84 | } catch (error) { 85 | fn(error); 86 | } 87 | }; 88 | 89 | Hogan.__express = Hogan.renderFile; 90 | 91 | return Hogan; 92 | } 93 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "hjs" 3 | , "description": "Hogan.js NPM package for express 3.x" 4 | , "version": "0.0.6" 5 | , "keywords": ["mustache", "template", "hogan.js", "hogan", "hjs", "express", "express-hogan"] 6 | , "main": "index" 7 | , "homepage": "https://github.com/nullfirm/hjs.git" 8 | , "author": "Min-su Ok