Socket
Socket
Sign inDemoInstall

jade-attrs

Package Overview
Dependencies
13
Maintainers
5
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    jade-attrs

Generate code for jade attributes


Version published
Weekly downloads
6
increased by50%
Maintainers
5
Install size
4.21 MB
Created
Weekly downloads
 

Readme

Source

jade-attrs

Generate code for Jade attributes

Build Status Dependency Status NPM version

Installation

npm install jade-attrs

Usage

var compileAttrs = require('jade-attrs');

compileAttrs(attrs, options)

Compile attrs to a JavaScript string that evaluates to the attributes in the desired format.

options MUST include the following properties:

  • terse: whether or not to use HTML5-style terse boolean attributes
  • runtime: callback that takes a runtime function name and returns the source code that will evaluate to that function at runtime
  • format: output format; must be html or object

attrs is an array of attributes, with each attribute having the form of { name, val, mustEscape }. val represents a JavaScript string that evaluates to the value of the attribute, either statically or dynamically.

var compileAttrs = require('jade-attrs');
var jadeRuntime = require('jade-runtime');

function getBaz () { return 'baz<>'; }

var attrs = [
  {name: 'foo',  val: '"bar"',    mustEscape: true },
  {name: 'baz',  val: 'getBaz()', mustEscape: true },
  {name: 'quux', val: true,       mustEscape: false}
];
var result, finalResult;

// HTML MODE
result = compileAttrs(attrs, {
  terse:   true,
  format:  'html',
  runtime: function (name) { return 'jadeRuntime.' + name; }
});
//=> '" foo=\\"bar\\"" + jadeRuntime.attr("baz", getBaz(), true, true) + " quux"'

finalResult = Function('jadeRuntime, getBaz',
  'return (' + result + ');'
);
finalResult(jadeRuntime, getBaz);
// => ' foo="bar" baz="baz&lt;&gt;" quux'

// OBJECT MODE
result = compileAttrs(attrs, {
  terse:   true,
  format:  'object',
  runtime: function (name) { return 'jadeRuntime.' + name; }
});
//=> '{"foo": "bar","baz": jadeRuntime.escape(getBaz()),"quux": true}'

finalResult = Function('jadeRuntime, getBaz',
  'return (' + result + ');'
);
finalResult(jadeRuntime, getBaz);
//=> { foo: 'bar', baz: 'baz&lt;&gt;', quux: true }

License

MIT

Keywords

FAQs

Last updated on 14 Nov 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc