Human-friendly replacements.
npm install applause> Pattern replacer that helps to create human-friendly replacements.
Try the [playground], where you can test every single option of applause.
First make sure you have installed the latest version of node.js
(You may need to restart your computer after this step).
From NPM for programmatic use:
``shell`
npm install applause
From Git:
`shell`
git clone git://github.com/outaTiME/applause
cd applause
npm link .
Assuming installation via NPM, you can use applause in your application like this:
`javascript
var fs = require('fs');
var Applause = require('applause');
var options = {
patterns: [
{
match: 'foo',
replacement: 'bar'
}
]
};
var applause = Applause.create(options);
var contents = '@@foo';
var result = applause.replace(contents);
console.log(result.content); // bar
`
Defines the patterns that will be used to replace the content input.
$3
Type: Indicates the matching expression.
If the match type is
, a simple variable search mechanism @@string is used (in any other case the default regexp replacement logic is used):`javascript
{
patterns: [
{
match: 'foo',
replacement: 'bar' // Replaces "@@foo" with "bar"
}
]
}
`$3
Type: Indicates the replacement for match. For more information about replacement, see [String.replace].
You can specify a function as a replacement. In this case, the function will be invoked after the match has been made. The result of the function (return value) will be used as the replacement string.
javascript
{
patterns: [
{
match: /foo/g,
replacement: function () {
return 'bar'; // Replaces "foo" with "bar"
}
}
]
}
`Objects are also supported as replacement (a string representation of the object is created using [JSON.stringify]):
javascript
{
patterns: [
{
match: /foo/g,
replacement: [1, 2, 3] // Replaces "foo" with string representation of the array
}
]
}
`> The replacement only resolves the [special replacement patterns] when using regexp to match.
$3
Type: If a
attribute is found in the pattern definition, the object is flattened using the delimiter concatenation and each key-value pair will be used for replacement (simple variable lookup mechanism and no regexp support).`javascript
{
patterns: [
{
json: {
key: 'value' // Replaces "@@key" with "value"
}
}
]
}
`Nested objects are also supported:
javascript
{
patterns: [
{
json: {
key: 'value', // Replaces "@@key" with "value"
inner: { // Replaces "@@inner" with string representation of the "inner" object
key: 'value' // Replaces "@@inner.key" with "value"
}
}
}
]
}
`You can define functions for deferred invocations:
javascript
{
patterns: [
{
json: function (done) {
done({
key: 'value'
});
}
}
]
}
`$3
Type: If a
attribute is found in the pattern definition, it will be converted and then processed as json attribute.`javascript
{
patterns: [
{
yaml: 'key: "value"' // Replaces "@@key" with "value"
}
]
}
`You can define functions for deferred invocations:
javascript
{
patterns: [
{
yaml: function (done) {
done('key: "value"');
}
}
]
}
`$3
Type: If a
attribute is found in the pattern definition, it will be converted and then processed as json attribute.`javascript
{
patterns: [
{
cson: 'key: "value"'
}
]
}
`You can define functions for deferred invocations:
javascript
{
patterns: [
{
cson: function (done) {
done('key: "value"');
}
}
]
}
`$3
Type: This is the old way of defining patterns using a simple plain object (simple variable lookup mechanism and no regexp support). You can still use this, but for more control you should use the new way of
.`javascript
{
variables: {
'key': 'value' // Replaces "@@key" with "value"
}
}
`$3
Type:
Default: The prefix used for matching (avoid wrong replacements / easy way).
> This only applies for simple variable lookup mechanism.
$3
Type:
Default: If set to "false", the pattern is matched without the "prefix" concatenation (this is useful when you want to lookup a simple string).
> This only applies for simple variable lookup mechanism.
$3
Type:
Default: If set to "true", the "prefix" is preserved in the target.
> This only applies for simple variable lookup mechanism and when
is a string.$3
Type: String
Default: The delimiter used to flatten when using an object as a replacement.
$3
Type:
Default: If set to "true", we preserve the order of definition of the patterns; otherwise the order will be ascending to avoid replacement problems such as "head" / "header" (regexp matches will be resolved at last).
[playground]: http://outatime.github.io/applause.io/
[String.replace]: http://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace
[JSON.stringify]: http://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[special replacement patterns]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_string_as_a_parameter
Examples
$3
File
:`
CACHE MANIFEST
@@timestamp
CACHE:
favicon.ico
index.html
NETWORK:
*
Node:
javascript
var fs = require('fs');
var Applause = require('applause');var options = {
patterns: [
{
match: 'timestamp',
replacement: Date.now()
}
]
};
var applause = Applause.create(options);
var contents = fs.readFileSync('./src/manifest.appcache', 'utf8');
var result = applause.replace(contents);
console.log(result.content); // The replaced output
`$3
File
:`
CACHE MANIFEST
@@timestamp
CACHE:
favicon.ico
index.html
NETWORK:
*
File
:`
__ _
_ _/__ /./|,//_/ TEAM /
Web Developer / Graphic Designer: Ariel Oscar Falduto
Site: https://www.outa.im
Twitter: @outa7iME
Contact: afalduto at gmail dot com
From: Buenos Aires, Argentina
/ SITE /
Last update: @@timestamp
Standards: HTML5, CSS3, robotstxt.org, humanstxt.org
Components: H5BP, Modernizr, jQuery, Bootstrap, LESS, Jade, Grunt
Software: Sublime Text, Photoshop, LiveReload
``
Node:
`javascript
var fs = require('fs');
var pkg = require('./package.json');
var Applause = require('applause');
var options = {
patterns: [
{
match: 'version',
replacement: pkg.version
},
{
match: 'timestamp',
replacement: Date.now()
}
]
};
var applause = Applause.create(options);
var contents = fs.readFileSync('./src/manifest.appcache', 'utf8');
var result = applause.replace(contents);
console.log(result.content); // The replaced output
contents = fs.readFileSync('./src/humans.txt', 'utf8');
result = applause.replace(contents);
console.log(result.content); // The replaced output
`
File src/index.html:
`html`
Node:
`javascript
var fs = require('fs');
var Applause = require('applause');
var options = {
patterns: [
{
match: 'timestamp',
replacement: Date.now()
}
]
};
var applause = Applause.create(options);
var contents = fs.readFileSync('./src/index.html', 'utf8');
var result = applause.replace(contents);
console.log(result.content); // The replaced output
`
File src/index.html:
`html`
@@include
Node:
`javascript
var fs = require('fs');
var Applause = require('applause');
var options = {
patterns: [
{
match: 'include',
replacement: fs.readFileSync('./includes/content.html', 'utf8')
}
]
};
var applause = Applause.create(options);
var contents = fs.readFileSync('./src/index.html', 'utf8');
var result = applause.replace(contents);
console.log(result.content); // The replaced output
`
File src/username.txt:
`
John Smith
Node:
`javascript
var fs = require('fs');
var Applause = require('applause');
var options = {
patterns: [
{
match: /(\w+)\s(\w+)/,
replacement: '$2, $1' // Replaces "John Smith" with "Smith, John"
}
]
};
var applause = Applause.create(options);
var contents = fs.readFileSync('./username.txt', 'utf8');
var result = applause.replace(contents);
console.log(result.content); // The replaced output
`
Node:
`javascript
var Applause = require('applause');
var options = [
{
patterns: [
{
match: /foo/g, // Explicitly using a regexp
replacement: 'bar'
}
]
},
{
patterns: [
{
match: 'foo',
replacement: 'bar'
}
],
prefix: '' // Removing the prefix manually
},
{
patterns: [
{
match: 'foo',
replacement: 'bar'
}
],
usePrefix: false // Using the option provided
}
];
options.forEach(function (option) {
var applause = Applause.create(option);
var contents = 'foo';
var result = applause.replace(contents);
console.log(result.content); // bar
});
``
- js-yaml - YAML 1.2 parser and serialize
- cson-parser - Safe parsing of CSON files
MIT © outaTiME