match-extension

Return true if a file extension matches the given string, array of strings, or RegExp pattern.

Install

Install with npm:

npm i match-extension --save-dev

Usage

var matchExt = require('match-extension');

Examples

RegExp patterns

matchExt(/a/, 'a/b/c.a');
//=> true
matchExt(/\.a/, '.a');
//=> true
 
matchExt(/a/, '.b');
//=> false

String patterns

matchExt('a', 'a/b/c.a');
//=> true
matchExt('.a', 'c.a');
//=> true
 
matchExt('.b', '.bb');
//=> false
matchExt('a', 'a/b.b');
//=> false

Glob patterns

matchExt('*', '.b');
//=> true
matchExt('.*', 'b');
//=> true
matchExt('{a,b}', 'a/b.b');
//=> true
matchExt('*.{a,b}', '.b');
//=> true
 
matchExt('*.b', '.c');
//=> false
matchExt('*.b', 'foo.c');
//=> false
matchExt('*.b', 'a/b.c');
//=> false

Arrays of string patterns

matchExt(['a', 'b'], 'a/b/c.a');
//=> true
matchExt(['b', 'a'], 'a');
//=> true
matchExt(['a', 'b'], '.b');
//=> true
matchExt(['a', 'b'], 'a/b/c.a');
//=> true
matchExt(['b', 'a'], 'a.a');
//=> true
matchExt(['b', 'a'], 'b');
//=> true
 
matchExt(['a', 'b'], 'a/b/c.d');
//=> false

API

match

Return true if ext matches the given pattern.

• pattern {String|Array|RegExp}: Can be a string, RegExp, or array of string patterns. Glob patterns can be passed as a string.
• ext {String}: The extension to match against.
• returns {Boolean} true: if the extension matches.

Example:

matchExt(/\.md/, 'foo.md');
//=> true

.normalizeExt

• ext {String}: The extension to normalize.
• returns {String}: Extension with a leading dot.

Normalize file extension format to always have a leading dot.

.stripDot

• ext {String}: The extension to normalize.
• returns {String}: Extenion without a leading dot.

Strip the leading dot from an extension.

.normalizeString

• pattern {String}: The string pattern to normalize.
• returns {String}: Normalized string.

Normalize string patterns to ensure that they lead with a dot, and if they end with a dot, add a trailing star.

.normalizeArray

• pattern {Array}: Array of patterns to match.
• returns {String}: A string to pass to minimatch.

Convert arrays of strings to minimatch sets.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

---

This file was generated by verb-cli on September 02, 2014.