Have ideas to improve npm?Join in the discussion! »

    @forks_master/applause

    1.2.4 • Public • Published

    Applause Build Status NPM Version

    Pattern replacer that helps creating human-friendly replacements.

    Install

    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 use as a command line app:

    npm install @forks_master/applause -g

    From NPM for programmatic use:

    npm install @forks_master/applause

    From Git:

    git clone git://github.com/outaTiME/applause
    cd applause
    npm link .

    API Reference

    Assuming installation via NPM, you can use applause in your application like this:

    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

    Applause Options

    patterns

    Type: Array

    Define patterns that will be used to replace the contents of source files.

    patterns.match

    Type: String|RegExp

    Indicates the matching expression.

    If matching type is String we use a simple variable lookup mechanism @@string (in any other case we use the default regexp replace logic):

    {
      patterns: [
        {
          match: 'foo',
          replacement: 'bar'  // replaces "@@foo" to "bar"
        }
      ]
    }

    patterns.replacement or patterns.replace

    Type: String|Function|Object

    Indicates the replacement for match, for more information about replacement check out the String.replace.

    You can specify a function as replacement. In this case, the function will be invoked after the match has been performed. The function's result (return value) will be used as the replacement string.

    {
      patterns: [
        {
          match: /foo/g,
          replacement: function () {
            return 'bar'; // replaces "foo" to "bar"
          }
        }
      ]
    }

    Also supports object as replacement (we create string representation of object using JSON.stringify):

    {
      patterns: [
        {
          match: /foo/g,
          replacement: [1, 2, 3] // replaces "foo" with string representation of "array" object
        }
      ]
    }

    The replacement only resolve the special replacement patterns when using regexp for matching.

    patterns.json

    Type: Object

    If an attribute json is found in pattern definition we flatten the object using delimiter concatenation and each key–value pair will be used for the replacement (simple variable lookup mechanism and no regexp support).

    {
      patterns: [
        {
          json: {
            "key": "value" // replaces "@@key" to "value"
          }
        }
      ]
    }

    Also supports nested objects:

    {
      patterns: [
        {
          json: {
            "key": "value",   // replaces "@@key" to "value"
            "inner": {        // replaces "@@inner" with string representation of "inner" object
              "key": "value"  // replaces "@@inner.key" to "value"
            }
          }
        }
      ]
    }

    For deferred invocations is possible to define functions:

    {
      patterns: [
        {
          json: function (done) {
            done({
              key: 'value'
            });
          }
        }
      ]
    }

    patterns.yaml

    Type: String

    If an attribute yaml found in pattern definition it will be converted and then processed like json attribute.

    {
      patterns: [
        {
          yaml: 'key: value'  // replaces "@@key" to "value"
        }
      ]
    }

    For deferred invocations is possible to define functions:

    {
      patterns: [
        {
          yaml: function (done) {
            done('key: value');
          }
        }
      ]
    }

    patterns.cson

    Type: String

    If an attribute cson is found in pattern definition it will be converted and then processed like json attribute.

    {
      patterns: [
        {
          cson: 'key: \'value\''
        }
      ]
    }

    For deferred invocations is possible to define functions:

    {
      patterns: [
        {
          cson: function (done) {
            done('key: \'value\'');
          }
        }
      ]
    }

    variables

    Type: Object

    This is the old way to define patterns using plain object (simple variable lookup mechanism and no regexp support). You can still use this but for more control you should use the new patterns way.

    {
      variables: {
        'key': 'value' // replaces "@@key" to "value"
      }
    }

    prefix

    Type: String Default: @@

    The prefix added for matching (prevent bad replacements / easy way).

    This only applies for simple variable lookup mechanism.

    usePrefix

    Type: Boolean Default: true

    If set to false, we match the pattern without prefix concatenation (useful when you want to lookup a simple string).

    This only applies for simple variable lookup mechanism.

    preservePrefix

    Type: Boolean Default: false

    If set to true, we preserve the prefix in target.

    This only applies for simple variable lookup mechanism and when patterns.replacement is a string.

    delimiter

    Type: String Default: .

    The delimiter used to flatten when using object as replacement.

    preserveOrder

    Type: Boolean Default: false

    If set to true, we preserve the patterns definition order, otherwise these will be sorted (in ascending order) to prevent replacement issues like head / header (typo regexps will be resolved at last).

    Usage Examples

    Basic

    File src/manifest.appcache:

    CACHE MANIFEST
    # @@timestamp
    
    CACHE:
    
    favicon.ico
    index.html
    
    NETWORK:
    *
    

    Node:

    var fs = require('fs');
    var Applause = require('applause');
    var options = {
      patterns: [
        {
          match: 'timestamp',
          replacement: new Date().getTime()
        }
      ]
    };
    var applause = Applause.create(options);
    var contents = fs.readFileSync('./src/manifest.appcache', 'utf8');
    var result = applause.replace(contents);
    console.log(result.content); // replaced output

    Multiple matching

    File src/manifest.appcache:

    CACHE MANIFEST
    # @@timestamp
    
    CACHE:
    
    favicon.ico
    index.html
    
    NETWORK:
    *
    

    File src/humans.txt:

                  __     _
       _    _/__  /./|,//_`
      /_//_// /_|///  //_, outaTiME v.@@version
    
    /* TEAM */
      Web Developer / Graphic Designer: Ariel Oscar Falduto
      Site: http://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, Twitter Bootstrap, LESS, Jade, Grunt
      Software: Sublime Text 2, Photoshop, LiveReload
    
    

    Node:

    var fs = require('fs');
    var pkg = require('./package.json');
    var Applause = require('applause');
    var options = {
      patterns: [
        {
          match: 'version',
          replacement: pkg.version
        },
        {
          match: 'timestamp',
          replacement: new Date().getTime()
        }
      ]
    };
    var applause = Applause.create(options);
    var contents = fs.readFileSync('./src/manifest.appcache', 'utf8');
    var result = applause.replace(contents);
    console.log(result.content); // replaced output
    contents = fs.readFileSync('./src/humans.txt', 'utf8');
    result = applause.replace(contents);
    console.log(result.content); // replaced output

    Cache busting

    File src/index.html:

    <head>
      <link rel="stylesheet" href="/css/style.css?rel=@@timestamp">
      <script src="/js/app.js?rel=@@timestamp"></script>
    </head>

    Node:

    var fs = require('fs');
    var Applause = require('applause');
    var options = {
      patterns: [
        {
          match: 'timestamp',
          replacement: new Date().getTime()
        }
      ]
    };
    var applause = Applause.create(options);
    var contents = fs.readFileSync('./src/index.html', 'utf8');
    var result = applause.replace(contents);
    console.log(result.content); // replaced output

    Include file

    File src/index.html:

    <body>
      @@include
    </body>

    Node:

    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); // replaced output

    Regular expression

    File src/username.txt:

    John Smith
    

    Node:

    var fs = require('fs');
    var Applause = require('applause');
    var options = {
      patterns: [
        {
          match: /(\w+)\s(\w+)/,
          replacement: '$2, $1' // replaces "John Smith" to "Smith, John"
        }
      ]
    };
    var applause = Applause.create(options);
    var contents = fs.readFileSync('./username.txt', 'utf8');
    var result = applause.replace(contents);
    console.log(result.content); // replaced output

    Lookup for foo instead of @@foo

    Node:

    var Applause = require('applause');
    
    // option 1 (explicitly using an regexp)
    var applause_op1 = Applause.create({
      patterns: [
        {
          match: /foo/g,
          replacement: 'bar'
        }
      ]
    });
    
    // option 2 (easy way)
    var applause_op2 = Applause.create({
      patterns: [
        {
          match: 'foo',
          replacement: 'bar'
        }
      ],
      usePrefix: false
    });
    
    // option 3 (old way)
    var applause_op3 = Applause.create({
      patterns: [
        {
          match: 'foo',
          replacement: 'bar'
        }
      ],
      prefix: '' // remove prefix
    });

    Release History

    • 2015-09-21   v1.2.2   Update VERSION to lower (version).
    • 2015-09-21   v1.2.1   Better support for browserify.
    • 2015-09-15   v1.2.0   Use detailed response for replaces with content, detail and count.
    • 2015-09-08   v1.1.0   Readme updated. Improvements in handling patterns. Fix plain object representation issue. More test cases.
    • 2015-08-11   v1.0.0   Version stabilization, Meteor integration and package.json update.
    • 2015-08-06   v0.4.3   Fix issue with special characters attributes ($$, $&, $`, $', $n or $nn) on JSON, YAML and CSON.
    • 2015-05-07   v0.4.1   Fix regression issue with empty string in replacement.
    • 2015-05-01   v0.4.0   New test cases, parse CSON using @groupon, replace alias now supported, new detail flag and third party dependencies updated.
    • 2014-10-10   v0.3.4   Escape regexp when matching type is String.
    • 2014-06-10   v0.3.3   Remove node v.8.0 support and third party dependencies updated.
    • 2014-04-18   v0.3.2   JSON / YAML / CSON as function supported. Readme updated (thanks @milanlandaverde).
    • 2014-03-23   v0.3.1   Readme updated.
    • 2014-03-22   v0.3.0   Performance improvements. Expression flag removed. New pattern matching for CSON object. More test cases, readme updated and code cleanup.
    • 2014-03-21   v0.2.0   Project rename from pattern-replace to applause (thanks Lady Gaga). Test cases in Mocha and readme updated.
    • 2014-03-11   v0.1.2   New pattern matching for YAML object. New preserveOrder flag.
    • 2014-02-26   v0.1.1   Remove the force flag (only applies in grunt plugin).
    • 2014-02-25   v0.1.0   Initial version.

    Task submitted by Ariel Falduto

    Install

    npm i @forks_master/applause

    DownloadsWeekly Downloads

    1

    Version

    1.2.4

    License

    MIT

    Unpacked Size

    21.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar