jonschlinkert / expand-range Goto Github PK

View Code? Open in Web Editor NEW

25.0 5.0 3.0 60 KB

Faster, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See the benchmarks.

Home Page: https://github.com/jonschlinkert

License: MIT License

JavaScript 100.00%

range letters fill range-expansion array expand numbers node nodejs javascript

expand-range's Introduction

expand-range

Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. Used by micromatch.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save expand-range

Example usage

var expand = require('expand-range');
expand('start..end..step', options);

// examples
console.log(expand('1..3')) //=> ['1', '2', '3']
console.log(expand('1..10..3')) //=> [ '1', '4', '7', '10' ]

Params

start: the number or letter to start with
end: the number or letter to end with
step: (optional) the step/increment to use. works with letters and numbers.
options: Options object to pass to fill-range, or a transform function (see fill-range readme for details and documentation)

This library wraps fill-range to support range expansion using .. separated strings. See fill-range for the full list of options and features.

Examples

expand('a..e')
//=> ['a', 'b', 'c', 'd', 'e']

expand('a..e..2')
//=> ['a', 'c', 'e']

expand('A..E..2')
//=> ['A', 'C', 'E']

expand('1..3')
//=> ['1', '2', '3']

expand('0..-5')
//=> [ '0', '-1', '-2', '-3', '-4', '-5' ]

expand('-9..9..3')
//=> [ '-9', '-6', '-3', '0', '3', '6', '9' ])

expand('-1..-10..-2')
//=> [ '-1', '-3', '-5', '-7', '-9' ]

expand('1..10..2')
//=> [ '1', '3', '5', '7', '9' ]

Custom function

Optionally pass a custom function as the second argument:

expand('a..e', function (val, isNumber, pad, i) {
  if (!isNumber) {
    return String.fromCharCode(val) + i;
  }
  return val;
});
//=> ['a0', 'b1', 'c2', 'd3', 'e4']

Benchmarks

[object Object]

History

v2.0.0

Changes

Special step characters are no longer supported, as the same thing can be accomplished with a custom transform function.
The signature in the transform function has changed. See fill-range for more details.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

braces: Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support… more | homepage
fill-range: Fill in a range of numbers or letters, optionally passing an increment or step to… more | homepage
micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage

Contributors

Commits	Contributor
65	jonschlinkert
1	dcohenb
1	stevelacy

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.8.0, on November 26, 2018.

expand-range's People

Contributors

Stargazers

Watchers

Forkers

isaacs popular-dependencies

expand-range's Issues

Tests fail

The tests on this package are failing for me, with Node version 6.10.2.

$ npm run test

> [email protected] test /home/jsmith/Git/nodejs-expand-range/package
> mocha



  expand range
    ✓ should return the number as an array if no range is specified
    ✓ should throw when the first arg is not a string.
    ✓ should expand numerical ranges
    ✓ should expand negative ranges
    ✓ should expand alphabetical ranges
    ✓ should fill in numerical ranges
    ✓ should fill in numerical ranges when numbers are passed as strings
    ✓ should fill in negative ranges
    ✓ should fill in rangines using the given increment
    ✓ should fill in negative ranges using the given increment
    ✓ should fill in negative ranges using the given increment
    ✓ should fill in alphabetical ranges
    ✓ should use increments with alphabetical ranges

  special characters:
    1) should repeat the first arg `n` times:
    2) should collapse values when `>` is passed:
    3) should randomize using the first two args when `?` is passed:
    4) should join the array using `|` as the separator:

  character classes:
    5) should return a string for a regex range when `true` is passed:
    6) should return a string for a regex when `~` or `|` are passed:
    7) should make a logical or when the range is out-of-order:
    8) should prefix the regex string when a `prefix` is passed on options:
    ✓ should return the string when arguments are invalid:
    9) should return null for invalid patterns:

  when a custom function is used for expansions
    ✓ should expose the current value as the first param.
    ✓ should expose the `isNumber` boolean as the third param.
    ✓ should expose any padding as the third param.
    10) should expose the index as the third param.


  17 passing (28ms)
  10 failing

  1) special characters: should repeat the first arg `n` times::

      AssertionError: [] deepEqual [ 'a', 'a', 'a' ]
      + expected - actual

      +[
      +  "a"
      +  "a"
      +  "a"
      +]
      -[]
      
      at Context.<anonymous> (test.js:108:12)

  2) special characters: should collapse values when `>` is passed::

      AssertionError: [] deepEqual [ 'abcde' ]
      + expected - actual

      +[
      +  "abcde"
      +]
      -[]
      
      at Context.<anonymous> (test.js:114:12)

  3) special characters: should randomize using the first two args when `?` is passed::

      AssertionError: false == true
      + expected - actual

      +true
      -false
      
      at Context.<anonymous> (test.js:126:5)

  4) special characters: should join the array using `|` as the separator::

      AssertionError: [] deepEqual [ '[a-c]' ]
      + expected - actual

      +[
      +  "[a-c]"
      +]
      -[]
      
      at Context.<anonymous> (test.js:132:12)

  5) character classes: should return a string for a regex range when `true` is passed::
     AssertionError: '[a-e]' deepEqual [ '[a-e]' ]
      at Context.<anonymous> (test.js:140:12)

  6) character classes: should return a string for a regex when `~` or `|` are passed::

      AssertionError: [] deepEqual [ '(A|F|K|P)' ]
      + expected - actual

      +[
      +  "(A|F|K|P)"
      +]
      -[]
      
      at Context.<anonymous> (test.js:147:12)

  7) character classes: should make a logical or when the range is out-of-order::

      AssertionError: [] deepEqual [ '(c|b|a)' ]
      + expected - actual

      +[
      +  "(c|b|a)"
      +]
      -[]
      
      at Context.<anonymous> (test.js:151:12)

  8) character classes: should prefix the regex string when a `prefix` is passed on options::

      AssertionError: [] deepEqual [ '(?!c|b|a)' ]
      + expected - actual

      +[
      +  "(?!c|b|a)"
      +]
      -[]
      
      at Context.<anonymous> (test.js:158:12)

  9) character classes: should return null for invalid patterns::
     AssertionError: [] == null
      at Context.<anonymous> (test.js:167:12)

  10) when a custom function is used for expansions should expose the index as the third param.:

      AssertionError: [ 'a', 'b', 'c', 'd', 'e' ] deepEqual [ 'a0', 'b1', 'c2', 'd3', 'e4' ]
      + expected - actual

       [
      +  "a0"
      +  "b1"
      +  "c2"
      +  "d3"
      +  "e4"
      -  "a"
      -  "b"
      -  "c"
      -  "d"
      -  "e"
       ]
      
      at Context.<anonymous> (test.js:216:12)

jonschlinkert / expand-range Goto Github PK

expand-range's Introduction

expand-range

Install

Example usage

Custom function

Benchmarks

History

v2.0.0

About

Related projects

Contributors

Author

License

expand-range's People

Contributors

Stargazers

Watchers

Forkers

expand-range's Issues

Recommend Projects

Recommend Topics

Recommend Org