{"id":1308,"date":"2015-03-17T07:07:49","date_gmt":"2015-03-17T07:07:49","guid":{"rendered":"http:\/\/www.nikola-breznjak.com\/blog\/?p=1308"},"modified":"2015-08-06T12:25:37","modified_gmt":"2015-08-06T12:25:37","slug":"options-found-in-locals-object-in-ejs","status":"publish","type":"post","link":"https:\/\/nikola-breznjak.com\/blog\/stack-overflow\/options-found-in-locals-object-in-ejs\/","title":{"rendered":"Options found in locals object in ejs"},"content":{"rendered":"

\"profile<\/a>
\nI’m a big fan of Stack Overflow<\/a> and I tend to contribute regularly (am currently in the top 0.X%<\/a>).\u00a0In this category (stackoverflow<\/a>)\u00a0of posts I will will be posting my top rated questions and answers. This, btw, is allowed as explained in the meta thread here<\/a>.<\/p>\n

My question<\/a> was:<\/p>\n

I got the following error when running the project from\u00a0GitHub<\/a>: “options found in locals object. The option(s) is copied to the option object. This behavior is deprecated and will be removed in EJS 3”<\/p>\n

I tried to update the ejs and express modules to the newest versions but the notice persists. I googled, ofc, and the only thread about it is\u00a0this<\/a>, but it doesn’t help.<\/p>\n

Does anyone know more about this?<\/p>\n

For reference, here is the whole important code:<\/p>\n

app\/views\/index.ejs<\/em><\/p>\n

<!DOCTYPE html>\r\n<html>\r\n<head>\r\n    <title><%= title %><\/title>\r\n<\/head>\r\n\r\n<body>\r\n    <h1><%= title %><\/h1>\r\n    <img src=\"img\/logo.jpg\" alt=\"Hack Hands logo\">\r\n<\/body>\r\n<\/html><\/pre>\n
app\/controllers\/index.server.controller.js<\/em><\/p>\n
exports.render = function(req, res) {\r\n    res.render('index', {\r\n        title: 'MEAN MVC'\r\n    });\r\n};<\/pre>\n
app\/routes\/index.server.route.js<\/em><\/p>\n
module.exports = function(app) {\r\n    var index = require('..\/controllers\/index.server.controller');\r\n    app.get('\/', index.render);\r\n};<\/pre>\n
app\/config\/express.js<\/em><\/p>\n
var express = require('express');\r\nmodule.exports = function() {\r\n    var app = express();\r\n\r\n    app.set('views', '.\/app\/views');\r\n    app.set('view engine', 'ejs');\r\n\r\n    require('..\/app\/routes\/index.server.routes.js')(app);\r\n\r\n    app.use(express.static('.\/public'));\r\n\r\n    return app;\r\n};<\/pre>\n
server.js<\/em><\/p>\n
var port = 1337;\r\nvar express = require('.\/config\/express');\r\nvar app = express();\r\napp.listen(port);\r\nmodule.exports = app;\r\nconsole.log('Server running at http:\/\/localhost:' + port);<\/pre>\n
The answer, by Timothy Gu<\/a>, was:<\/p>\n
\n
\n
tl;dr: Upgrade to the latest version of EJS. It removes all warnings about\u00a0options<\/code>\u00a0and\u00a0locals<\/code>.<\/p>\n
whoami<\/code><\/h2>\n
I’m a collaborator (or\u00a0the<\/em>\u00a0collaborator in @micnic’s comment above) in EJS v2. I only started maintaining EJS after version 2.0.3 (or something like that) was released, so I don’t know a lot about how the API changes took place.<\/p>\n
History<\/h2>\n
EJS v2’s\u00a0renderFile<\/code>\u00a0function, used by Express.js, now has the signature<\/p>\n
function(path[, options[, locals]], cb)<\/pre>\n
But for compatibility with and Express.js, which calls all functions as<\/p>\n
function(path, locals, cb)<\/pre>\n
with options mixed into the\u00a0locals<\/code>\u00a0object, EJS automatically picks out the locals with option-y names and treat them as options.<\/p>\n
But because the Express.js signature is also the function signature of EJS v1, we also print a warning if any option in\u00a0locals<\/code>\u00a0is copied to\u00a0options<\/code>, urging developers to use the new signature with\u00a0locals<\/code>\u00a0and\u00a0options<\/code>\u00a0separated (it was actually\u00a0me who added the warning<\/a>).<\/p>\n
However, Express.js users do not have a choice in terms of calling convention, so the warning is always present in Express.js.<\/p>\n
Some users did complain:\u00a0#34<\/a>\u00a0#36<\/a>.<\/p>\n
At first, @mde (who is the main maintainer of EJS) pushed a\u00a0fix<\/a>, which correctly disables warnings on Express.js, and Express.js only.<\/p>\n
But then, the person in #36 still complained, as he was using\u00a0filename<\/code>\u00a0as the name of a local<\/a>, and when the optiony local is copied to\u00a0options<\/code>\u00a0a warning is printed.<\/p>\n
At last, @mde was like “f*** this shit” and\u00a0removed all the deprecation warnings<\/a>, including an uncontroversial and legitimate one, and released version 2.2.4 (the legitimate warning was\u00a0restored by me<\/a>\u00a0after the release).<\/p>\n
Future<\/h2>\n
@dougwilson (an Express.js maintainer) said he was\u00a0interested<\/a>\u00a0in a separation of\u00a0options<\/code>\u00a0and\u00a0locals<\/code>\u00a0in Express.js v5, just like in EJS v2. I did volunteer to make that change, but then I got busy so yeah.<\/p>\n<\/div>\n<\/blockquote>\n","protected":false},"excerpt":{"rendered":"
I’m a big fan of Stack Overflow and I tend to contribute regularly (am currently in the top 0.X%).\u00a0In this category (stackoverflow)\u00a0of posts I will will be posting…<\/p>\n","protected":false},"author":1,"featured_media":609,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[35],"tags":[],"class_list":["post-1308","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-stack-overflow"],"_links":{"self":[{"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/posts\/1308","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/comments?post=1308"}],"version-history":[{"count":2,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/posts\/1308\/revisions"}],"predecessor-version":[{"id":1687,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/posts\/1308\/revisions\/1687"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/media\/609"}],"wp:attachment":[{"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/media?parent=1308"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/categories?post=1308"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/nikola-breznjak.com\/blog\/wp-json\/wp\/v2\/tags?post=1308"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}