Matchstick

A NodeJS module that converts string patterns into regular expressions. It can also tokenize and perform string replacement. It's useful for route handling or simlple template systems.

Installation

$ npm install matchstick

Usage

Require matchstick at the top of your script.

var matchstick = require('matchstick');

Matchstick is a constructor that returns a fresh instance so you don't need the new keyword. It takes three arguments:

• pattern is a string representing a search
• mode is a string that tells matchstick how to interpret the pattern
  • strict: Exact match
  • static: Exact match with optional trailing slash (for URLs)
  • wildcard: Asterisks match any character(s) e.g. /path/*/
  • template: Curly brace tokens match any character(s) e.g. /path/{token}/
  • symbolic: Ruby-style symbols with leading colons match any character(s) e.g. /path/:token/
  • regexp: Convert into a true RegExp Object e.g. ^\/path\/$
• modifiers is a string containing one (or none) of any of the following characters
  • i: Case insensitive
  • g: Global match
  • m: Multiline matching

Example

> matchstick('/project/{projectid}/task/{taskid}', 'template');

Returns:

{
	pattern  : '/project/{projectid}/task/{taskid}',
	mode     : 'template',
	tokens   : [
		'projectid',
		'taskid'
	],
	regexp  : /^\/project\/(.*)\/task\/(.*)$/,
	match   : function() {},
	stick : function() {}
}

Set it to a variable and use the match method to return true or false

var ms = matchstick('/path', 'static');
ms.match('/path/');

Returns: true

...or evaluate it directly.

var path = '/path/';
if( matchstick('/path', 'static', 'i').match(str) ) {
	// Do something
}

Examples

Regexp property

All patterns result in a regexp property which you can access directly.

matchstick('^\/path\/$', 'regexp', 'g').regexp;

Returns: /^/path/$/gi

match() method

Static mode

matchstick('/path/', 'static').match'('/PATH/');

Returns: true

Wildcard mode

matchstick('/path/*/', 'wildcard').match('/path/something/');

Returns: true

Regexp mode

matchstick('^\/path\/$', 'regexp').match('/path/');

Returns: true

stick() method

Template mode

var ms = matchstick('/project/{projectid}/task/{taskid}', 'pattern');
ms.stick({
	projectid : '123', 
	taskid : 'abc'
});

Returns: /project/123/task/abc

Symbolic mode

var ms = matchstick('/project/:pid/task/:tid/action/:aid', 'pattern');
ms.stick({
	projectid : '123', 
	taskid : 'abc'
});

Returns: /project/123/task/abc/action/ (unused tokens are removed)

Tests

Install the global dependancies with sudo permissions.

$ sudo npm install -g mocha
$ sudo npm install -g should

Run mocha directly to see the test results.

$ cd matchstick
$ mocha